MultiVisitCoveragePlot¶

class lsst.analysis.tools.actions.plot.MultiVisitCoveragePlot(*args, **kw)¶

Bases: PlotAction

Plot the coverage for a set of visits.

Attributes Summary

`applyContext`	Apply a `Context` to an `AnalysisAction` recursively.
`bandLabelColorDict`	A dict mapping which color to use for the labels of a given band.
`cmapName`	Name of the color map to be used if not using the default color-blind friendly orange/blue default (used if this is set to `None`).
`doScatterInRaDec`	Whether to scatter the points in RA/Dec before plotting.
`history`
`identity`	If a configurable action is assigned to a `ConfigurableActionField`, or a `ConfigurableActionStructField` the name of the field will be bound to this variable when it is retrieved.
`nBins`	Number of bins to use within the effective plot ranges along the spatial directions.
`nPointBinThresh`	Threshold number of data points above which binning of the data will be performed in the RA/Dec projection.
`parametersToPlotList`	List of paramters to plot.
`plotAllTractOutlines`	Whether to plot tract outlines for all tracts within the plot limits (regardless if they have any data in them).
`plotDetectorOutline`	Whether to plot a shaded outline of the detector size in the RA/Dec projectionfor reference.
`plotName`	The name for the plot.
`projection`	Projection to plot.
`raDecLimitsDict`	A dict mapping the RA/Dec limits to apply to the plot.
`showExtremeOutliers`	Use overlaid scatter points to show the x-y positions of the 15% most extreme values? (`bool`, default `True`)
`sortedFullBandList`	List of all bands that could, in principle, but do not have to, exist in data table.
`tractsToPlotList`	List of tracts within which to limit the RA and Dec limits of the plot.
`trimToTract`	Whether to trim the plot limits to the tract limit(s).
`unitsDict`	A dict mapping a parameter to its appropriate units (for label plotting).
`vectorsToLoadList`	List of columns to load from input table.

Methods Summary

`__call__`(data, **kwargs)	Call self as a function.
`addInputSchema`(inputSchema)	Add the supplied inputSchema argument to the class such that it will be returned along side any other arguments in a call to `getInputSchema`.
`compare`(other[, shortcut, rtol, atol, output])	Compare this configuration to another `Config` for equality.
`formatHistory`(name, **kwargs)	Format a configuration field's history to a human-readable format.
`freeze`()	Make this config, and all subconfigs, read-only.
`getFormattedInputSchema`(**kwargs)	Return input schema, with keys formatted with any arguments supplied by kwargs passed to this method.
`getInputSchema`()	Return the schema an `AnalysisAction` expects to be present in the arguments supplied to the __call__ method.
`getOutputNames`([config])	Returns a list of names that will be used as keys if this action's call method returns a mapping.
`getOutputSchema`()	Return the schema an `AnalysisAction` will produce, if the `__call__` method returns `KeyedData`, otherwise this may return None.
`getPlotType`()
`items`()	Get configurations as `(field name, field value)` pairs.
`keys`()	Get field names.
`load`(filename[, root])	Modify this config in place by executing the Python code in a configuration file.
`loadFromStream`(stream[, root, filename, ...])	Modify this Config in place by executing the Python code in the provided stream.
`loadFromString`(code[, root, filename, ...])	Modify this Config in place by executing the Python code in the provided string.
`makePlot`(data[, plotInfo, camera, skymap, ...])	Make an Nband x Nparameter panel multi-visit coverage plot.
`names`()	Get all the field names in the config, recursively.
`save`(filename[, root])	Save a Python script to the named file, which, when loaded, reproduces this config.
`saveToStream`(outfile[, root, skipImports])	Save a configuration file to a stream, which, when loaded, reproduces this config.
`saveToString`([skipImports])	Return the Python script form of this configuration as an executable string.
`setDefaults`()	Subclass hook for computing defaults.
`toDict`()	Make a dictionary of field names and their values.
`update`(**kw)	Update values of fields specified by the keyword arguments.
`validate`()	Validate the Config, raising an exception if invalid.
`values`()	Get field values.

Attributes Documentation

applyContext¶

Apply a Context to an AnalysisAction recursively.

Generally this method is called from within an AnalysisTool to configure all AnalysisActions at one time to make sure that they all are consistently configured. However, it is permitted to call this method if you are aware of the effects, or from within a specific execution environment like a python shell or notebook.

Parameters:

contextContext: The specific execution context, this may be a single context or a joint context, see Context for more info.

bandLabelColorDict¶: A dict mapping which color to use for the labels of a given band. (Dict, default {'u': 'tab:purple', 'g': 'tab:blue', 'r': 'tab:green', 'i': 'gold', 'z': 'tab:orange', 'y': 'tab:red', 'N921': 'tab:pink'})

cmapName¶: Name of the color map to be used if not using the default color-blind friendly orange/blue default (used if this is set to None). Any name available via matplotlib.cm may be used. (str, default None)

doScatterInRaDec¶: Whether to scatter the points in RA/Dec before plotting. This may be useful for visualization for surveys with tight dithering patterns. (bool, default False)

history¶: Read-only history.

identity: str | None = None¶: If a configurable action is assigned to a ConfigurableActionField, or a ConfigurableActionStructField the name of the field will be bound to this variable when it is retrieved.

nBins¶: Number of bins to use within the effective plot ranges along the spatial directions. Only used in the “raDec” projection (for the “focalPlane” projection, the binning is effectively one per detector). (int, default 25)

nPointBinThresh¶: Threshold number of data points above which binning of the data will be performed in the RA/Dec projection. If projection is “focalPlane”, the per-detector nPoint threshold is nPointMinThresh/number of science detectors in the given camera. (int, default 400)

parametersToPlotList¶: List of paramters to plot. They are plotted along rows and the columns plot these parameters for each band. (List, default ['psfSigma', 'astromOffsetMean', 'medianE', 'psfStarScaledDeltaSizeScatter', 'skyBg', 'zeroPoint'])

plotAllTractOutlines¶: Whether to plot tract outlines for all tracts within the plot limits (regardless if they have any data in them). (bool, default False)

plotDetectorOutline¶: Whether to plot a shaded outline of the detector size in the RA/Dec projectionfor reference. Ignored if projection is not raDec or no camera is provided in the inputs. (bool, default False)

plotName¶: The name for the plot. (str)

projection¶: Projection to plot. Currently only “raDec” and “focalPlane” are permitted. In either case, one point is plotted per visit/detector combination. (str, default 'raDec')

raDecLimitsDict¶: A dict mapping the RA/Dec limits to apply to the plot. Set to None to use base limits on the default or the other config options. The dict must contain the keys raMin, ramax, decMin, decMax, e.g. raDecLimitsDict = {“raMin”: 0, “raMax”: 360, “decMin”: -90, “decMax”: 90}. Not compatible with trimToTract or tractsToPlotList (i.e. the latter two will be ignored if the dict is not None). (Dict, default None)

showExtremeOutliers¶: Use overlaid scatter points to show the x-y positions of the 15% most extreme values? (bool, default True)

sortedFullBandList¶: List of all bands that could, in principle, but do not have to, exist in data table. The sorting of the plot panels will follow this list (typically by wavelength). (List, default ['u', 'g', 'r', 'i', 'z', 'y', 'N921'])

tractsToPlotList¶: List of tracts within which to limit the RA and Dec limits of the plot. (List, default None)

trimToTract¶: Whether to trim the plot limits to the tract limit(s). Otherwise, plot will be trimmed to data limits (both will be expanded in the smaller range direction for an equal aspect square plot). (bool, default False)

unitsDict¶: A dict mapping a parameter to its appropriate units (for label plotting). (Dict, default {'astromOffsetMean': 'arcsec', 'astromOffsetStd': 'arcsec', 'psfSigma': 'pixels', 'skyBg': 'counts', 'skyNoise': 'counts', 'visit': 'number', 'detector': 'number', 'zenithDistance': 'deg', 'zeroPoint': 'mag', 'ra': 'deg', 'decl': 'deg', 'xFp': 'mm', 'yFp': 'mm', 'medianE': '', 'psfStarScaledDeltaSizeScatter': '', 'psfTraceRadiusDelta': 'pixel'})

vectorsToLoadList¶: List of columns to load from input table. (List, default ['visitId', 'detector', 'band', 'ra', 'decl', 'zeroPoint', 'psfSigma', 'skyBg', 'astromOffsetMean', 'psfStarDeltaE1Median', 'psfStarDeltaE2Median', 'psfStarScaledDeltaSizeScatter', 'psfTraceRadiusDelta', 'llcra', 'lrcra', 'ulcra', 'urcra', 'llcdec', 'lrcdec', 'ulcdec', 'urcdec', 'xSize', 'ySize'])

Methods Documentation

__call__(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap | Tensor], **kwargs) → Mapping[str, Figure] | Figure¶: Call self as a function.

addInputSchema(inputSchema: Tensor]]]) → None¶

Add the supplied inputSchema argument to the class such that it will be returned along side any other arguments in a call to getInputSchema.

Parameters:

inputSchemaKeyedDataSchema: A schema that is to be merged in with any existing schema when a call to getInputSchema is made.

compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)¶

Compare this configuration to another Config for equality.

Parameters:

otherlsst.pex.config.Config: Other Config object to compare against this config.
shortcutbool, optional: If True, return as soon as an inequality is found. Default is True.
rtolfloat, optional: Relative tolerance for floating point comparisons.
atolfloat, optional: Absolute tolerance for floating point comparisons.
outputcallable, optional: A callable that takes a string, used (possibly repeatedly) to report inequalities.

Returns:

isEqualbool: True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

See also

lsst.pex.config.compareConfigs

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField fields are not considered by this method.

Floating point comparisons are performed by numpy.allclose.

formatHistory(name, **kwargs)¶

Format a configuration field’s history to a human-readable format.

Parameters:

namestr: Name of a Field in this config.
**kwargs: Keyword arguments passed to lsst.pex.config.history.format.

Returns:

historystr: A string containing the formatted history.

See also

lsst.pex.config.history.format

freeze()¶: Make this config, and all subconfigs, read-only.

getFormattedInputSchema(**kwargs) → Tensor]]]¶

Return input schema, with keys formatted with any arguments supplied by kwargs passed to this method.

Returns:

resultKeyedDataSchema: The schema this action requires to be present when calling this action, formatted with any input arguments (e.g. band=’i’)

getInputSchema() → Tensor]]]¶

Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

Returns:

resultKeyedDataSchema: The schema this action requires to be present when calling this action, keys are unformatted.

getOutputNames(config: Config | None = None) → Iterable[str]¶

Returns a list of names that will be used as keys if this action’s call method returns a mapping. Otherwise return an empty Iterable.

Parameters:

configlsst.pex.config.Config, optional: Configuration of the task. This is only used if the output naming needs to be config-aware.

Returns:

resultIterable of str: If a PlotAction produces more than one plot, this should be the keys the action will use in the returned Mapping.

getOutputSchema() → Tensor]]] | None¶

Return the schema an AnalysisAction will produce, if the __call__ method returns KeyedData, otherwise this may return None.

Returns:

resultKeyedDataSchema or None: The schema this action will produce when returning from call. This will be unformatted if any templates are present. Should return None if action does not return KeyedData.

getPlotType() → str¶

items()¶

Get configurations as (field name, field value) pairs.

Returns:

itemsItemsView

Iterator of tuples for each configuration. Tuple items are:

Field name.
Field value.

keys()¶

Get field names.

Returns:

namesKeysView: List of lsst.pex.config.Field names.

load(filename, root='config')¶

Modify this config in place by executing the Python code in a configuration file.

Parameters:

filenamestr

Name of the configuration file. A configuration file is Python module.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

See also

lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString

loadFromStream(stream, root='config', filename=None, extraLocals=None)¶

Modify this Config in place by executing the Python code in the provided stream.

Parameters:

streamfile-like object, str, bytes, or CodeType

Stream containing configuration override code. If this is a code object, it should be compiled with mode="exec".

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

extraLocalsdict of str to object, optional

Any extra variables to include in local scope when loading.

See also

lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromString
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString

Notes

For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use loadFromString instead for most of these types.

loadFromString(code, root='config', filename=None, extraLocals=None)¶

Modify this Config in place by executing the Python code in the provided string.

Parameters:

codestr, bytes, or CodeType

Stream containing configuration override code.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

extraLocalsdict of str to object, optional

Any extra variables to include in local scope when loading.

Raises:

ValueError: Raised if a key in extraLocals is the same value as the value of the root argument.

See also

lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString

Make an Nband x Nparameter panel multi-visit coverage plot.

The panels rows are for different bands,sorted according to the order in config sortedFullBandList. The columns are per-parameter, plotted in the order given by the config parametersToPlotList. Red “over” colors indicate thresholds in play in the data processing (e.g. used to select against data of sufficient quality).

Parameters:

datalsst.analysis.tools.interfaces.KeyedData

The key-based catalog of data to plot.

plotInfodict [str], optional

A dictionary of information about the data being plotted with (at least) keys:

"run": Output run for the plots (str).
"tableName": Name of the table from which results are taken (str).

cameralsst.afw.cameraGeom.Camera, optional

The camera object associated with the data. This is to enable the conversion of to focal plane coordinates (if needed, i.e. for the focal plane projection version of this plot) and to obtain the projected (in RA/Dec) size of a typical detector (for reference in the raDec projection plots when requested, i.e. if the config plotDetectorOutline is True).

skymaplsst.skymap.BaseSkyMap, optional

The sky map used for this dataset. If a specific tract[List] is provided, this is used to determine the appropriate RA & Dec limits to downselect the data to within those limits for plotting.

calibrateConfiglsst.pex.config.Config, optional

The persisted config used in the calibration task for the given collection. Used to introspect threshold values used in the run.

makeWarpConfiglsst.pex.config.Config, optional

The persisted config used in the makeWarp task for the given collection. Used to introspect threshold values used in the run.

Returns:

figmatplotlib.figure.Figure: The resulting figure.

names()¶

Get all the field names in the config, recursively.

Returns:

nameslist of str: Field names.

save(filename, root='config')¶

Save a Python script to the named file, which, when loaded, reproduces this config.

Parameters:

filenamestr: Desination filename of this configuration.
rootstr, optional: Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

See also

lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString

saveToStream(outfile, root='config', skipImports=False)¶

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters:

outfilefile-like object: Destination file object write the config into. Accepts strings not bytes.
rootstr, optional: Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).
skipImportsbool, optional: If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

See also

lsst.pex.config.Config.save
lsst.pex.config.Config.saveToString
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString

saveToString(skipImports=False)¶

Return the Python script form of this configuration as an executable string.

Parameters:

skipImportsbool, optional: If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

Returns:

codestr: A code string readable by loadFromString.

See also

lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString

setDefaults()¶

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

toDict()¶

Make a dictionary of field names and their values.

Returns:

dict_dict: Dictionary with keys that are Field names. Values are Field values.

See also

lsst.pex.config.Field.toDict

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict method for this method to work.

update(**kw)¶

Update values of fields specified by the keyword arguments.

Parameters:

**kw: Keywords are configuration field names. Values are configuration field values.

Notes

The __at and __label keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert a Config instance’s history.

Examples

This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update fieldA and fieldC:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'

validate()¶

Validate the Config, raising an exception if invalid.

Raises:

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.

values()¶

Get field values.

Returns:

valuesValuesView: Iterator of field values.

Navigation

MultiVisitCoveragePlot¶