lsst.skymap ga8c6da7877+a9c198e9fb
Loading...
Searching...
No Matches
Functions | Variables
showVisitSkyMap Namespace Reference

Functions

 bboxToRaDec (bbox, wcs)
 
 getValueAtPercentile (values, percentile=0.5)
 
 get_cmap (n, name="hsv")
 
 main (repo, collections, skymapName=None, tracts=None, visits=None, physicalFilters=None, bands=None, ccds=None, ccdKey="detector", showPatch=False, saveFile=None, showCcds=False, visitVetoFile=None, minOverlapFraction=None, trimToTracts=False)
 
 makeWhereInStr (parameterName, parameterList, parameterType)
 
 getTractLimitsDict (skymap, tractList)
 
 derivePlotLimits (limitsDict, raToDecLimitRatio=1.0, buffFrac=0.0)
 
 setLimitsToEqualRatio (xMin, xMax, yMin, yMax)
 
 getDetRaDecCorners (ccdKey, ccdId, visit, visitSummary=None, butler=None, doLogWarn=True)
 
 getBand (visitSummary=None, butler=None, visit=None)
 

Variables

 logger = lsstLog.Log.getLogger("showVisitSkyMap.py")
 
 parser = argparse.ArgumentParser()
 
 type
 
 help
 
 str
 
 nargs
 
 metavar
 
 required
 
 default
 
 None
 
 int
 
 action
 
 float
 
 args = parser.parse_args()
 
 collections
 
 skymapName
 
 tracts
 
 visits
 
 physicalFilters
 
 bands
 
 ccds
 
 ccdKey
 
 showPatch
 
 saveFile
 
 showCcds
 
 visitVetoFile
 
 minOverlapFraction
 
 trimToTracts
 

Function Documentation

◆ bboxToRaDec()

showVisitSkyMap.bboxToRaDec ( bbox,
wcs )
Get the corners of a BBox and convert them to lists of RA and Dec.

Definition at line 42 of file showVisitSkyMap.py.

◆ derivePlotLimits()

showVisitSkyMap.derivePlotLimits ( limitsDict,
raToDecLimitRatio = 1.0,
buffFrac = 0.0 )
Derive the axis limits to encompass all points in limitsDict.

Parameters
----------
limitsDict : `dict` [`dict`]
    A dictionary keyed on any id. Each entry includes a `dict`
    keyed on "ras" and "decs" including (at least the minimum
    and maximum) RA and Dec values in units of degrees.
raToDecLimitRatio : `float`, optional
    The aspect ratio between RA and Dec to set the plot limits to.  This
    is to namely to set this ratio to that of the focal plane (i.e. such
    that a square detector appears as a square), but any aspect ratio can,
    in principle, be requested.

Returns
-------
xlim, ylim : `tuple` [`float`]
    Two tuples containing the derived min and max values for the x and
    y-axis limits (in degrees), respectively.

Definition at line 521 of file showVisitSkyMap.py.

◆ get_cmap()

showVisitSkyMap.get_cmap ( n,
name = "hsv" )
Returns a function that maps each index in 0, 1, ..., n-1 to a distinct
RGB color; the keyword argument name must be a standard mpl colormap name.

Definition at line 72 of file showVisitSkyMap.py.

◆ getBand()

showVisitSkyMap.getBand ( visitSummary = None,
butler = None,
visit = None )
Determine band and physical filter for given visit.

Parameters
----------
visitSummary : `lsst.afw.table.ExposureCatalog` or `None`, optional
    The visitSummary table for the visit for which to determine the band.
butler : `lsst.daf.butler.Butler` or `None`, optional
    The butler from which to look up the Dimension Records. Only needed
    if ``visitSummary`` is `None`.
visit : `int` or `None, optional
    The visit number for which to determine the band. Only needed
    if ``visitSummary`` is `None`.

Returns
-------
band, physicalFilter : `str`
    The band and physical filter for the given visit.

Definition at line 645 of file showVisitSkyMap.py.

◆ getDetRaDecCorners()

showVisitSkyMap.getDetRaDecCorners ( ccdKey,
ccdId,
visit,
visitSummary = None,
butler = None,
doLogWarn = True )
Compute the RA/Dec corners lists for a given detector in a visit.

Definition at line 620 of file showVisitSkyMap.py.

◆ getTractLimitsDict()

showVisitSkyMap.getTractLimitsDict ( skymap,
tractList )
Return a dict containing tract limits needed for outline plotting.

Parameters
----------
skymap : `lsst.skymap.BaseSkyMap`
    The sky map used for this dataset. Used to obtain tract
    parameters.
tractList : `list` [`int`]
    The list of tract ids (as integers) for which to determine the
    limits.

Returns
-------
tractLimitsDict : `dict` [`dict`]
    A dictionary keyed on tract id. Each entry includes a `dict`
    including the tract RA corners, Dec corners, and the tract center,
    all in units of degrees. These are used for plotting the tract
    outlines.

Definition at line 483 of file showVisitSkyMap.py.

◆ getValueAtPercentile()

showVisitSkyMap.getValueAtPercentile ( values,
percentile = 0.5 )
Return a value a fraction of the way between the min and max values in a
list.

Parameters
----------
values : `list` [`float`]
    The list of values under consideration.
percentile : `float`, optional
    The percentile (expressed as a number between 0.0 and 1.0) at which
    to determine the value in `values`.

Returns
-------
result : `float`
    The value at the given percentile of ``values``.

Definition at line 50 of file showVisitSkyMap.py.

◆ main()

showVisitSkyMap.main ( repo,
collections,
skymapName = None,
tracts = None,
visits = None,
physicalFilters = None,
bands = None,
ccds = None,
ccdKey = "detector",
showPatch = False,
saveFile = None,
showCcds = False,
visitVetoFile = None,
minOverlapFraction = None,
trimToTracts = False )

Definition at line 79 of file showVisitSkyMap.py.

◆ makeWhereInStr()

showVisitSkyMap.makeWhereInStr ( parameterName,
parameterList,
parameterType )
Create the string to be used in the where clause for registry lookup.

Definition at line 470 of file showVisitSkyMap.py.

◆ setLimitsToEqualRatio()

showVisitSkyMap.setLimitsToEqualRatio ( xMin,
xMax,
yMin,
yMax )
For a given set of x/y min/max, redefine to have equal aspect ratio.

The limits are extended on both ends such that the central value is
preserved.

Parameters
----------
xMin, xMax, yMin, yMax : `float`
    The min/max values of the x/y ranges for which to match in dynamic
    range while perserving the central values.

Returns
-------
xMin, xMax, yMin, yMax : `float`
    The adjusted min/max values of the x/y ranges with equal aspect ratios.

Definition at line 591 of file showVisitSkyMap.py.

Variable Documentation

◆ action

showVisitSkyMap.action

Definition at line 697 of file showVisitSkyMap.py.

◆ args

showVisitSkyMap.args = parser.parse_args()

Definition at line 710 of file showVisitSkyMap.py.

◆ bands

showVisitSkyMap.bands

Definition at line 712 of file showVisitSkyMap.py.

◆ ccdKey

showVisitSkyMap.ccdKey

Definition at line 712 of file showVisitSkyMap.py.

◆ ccds

showVisitSkyMap.ccds

Definition at line 712 of file showVisitSkyMap.py.

◆ collections

showVisitSkyMap.collections

Definition at line 711 of file showVisitSkyMap.py.

◆ default

showVisitSkyMap.default

Definition at line 682 of file showVisitSkyMap.py.

◆ float

showVisitSkyMap.float

Definition at line 706 of file showVisitSkyMap.py.

◆ help

showVisitSkyMap.help

Definition at line 678 of file showVisitSkyMap.py.

◆ int

showVisitSkyMap.int

Definition at line 683 of file showVisitSkyMap.py.

◆ logger

showVisitSkyMap.logger = lsstLog.Log.getLogger("showVisitSkyMap.py")

Definition at line 39 of file showVisitSkyMap.py.

◆ metavar

showVisitSkyMap.metavar

Definition at line 681 of file showVisitSkyMap.py.

◆ minOverlapFraction

showVisitSkyMap.minOverlapFraction

Definition at line 714 of file showVisitSkyMap.py.

◆ nargs

showVisitSkyMap.nargs

Definition at line 679 of file showVisitSkyMap.py.

◆ None

showVisitSkyMap.None

Definition at line 682 of file showVisitSkyMap.py.

◆ parser

showVisitSkyMap.parser = argparse.ArgumentParser()

Definition at line 676 of file showVisitSkyMap.py.

◆ physicalFilters

showVisitSkyMap.physicalFilters

Definition at line 712 of file showVisitSkyMap.py.

◆ required

showVisitSkyMap.required

Definition at line 681 of file showVisitSkyMap.py.

◆ saveFile

showVisitSkyMap.saveFile

Definition at line 713 of file showVisitSkyMap.py.

◆ showCcds

showVisitSkyMap.showCcds

Definition at line 713 of file showVisitSkyMap.py.

◆ showPatch

showVisitSkyMap.showPatch

Definition at line 713 of file showVisitSkyMap.py.

◆ skymapName

showVisitSkyMap.skymapName

Definition at line 711 of file showVisitSkyMap.py.

◆ str

showVisitSkyMap.str

Definition at line 679 of file showVisitSkyMap.py.

◆ tracts

showVisitSkyMap.tracts

Definition at line 711 of file showVisitSkyMap.py.

◆ trimToTracts

showVisitSkyMap.trimToTracts

Definition at line 715 of file showVisitSkyMap.py.

◆ type

showVisitSkyMap.type

Definition at line 677 of file showVisitSkyMap.py.

◆ visits

showVisitSkyMap.visits

Definition at line 711 of file showVisitSkyMap.py.

◆ visitVetoFile

showVisitSkyMap.visitVetoFile

Definition at line 714 of file showVisitSkyMap.py.