SingleMetadataMetricConnections

class lsst.verify.tasks.SingleMetadataMetricConnections(*, config=None)

Bases: lsst.verify.tasks.MetricConnections

An abstract connections class defining a metadata input.

Notes

SingleMetadataMetricConnections defines the following dataset templates:

package

Name of the metric’s namespace. By verify_metrics convention, this is the name of the package the metric is most closely associated with.

metric

Name of the metric, excluding any namespace.

labelName

Pipeline label of the PipelineTask or name of the CmdLineTask whose metadata are being read.

Attributes Summary

allConnections
defaultTemplates
dimensions
initInputs
initOutputs
inputs
measurement
metadata
outputs
prerequisiteInputs

Methods Summary

adjustQuantum(datasetRefMap)	Override to make adjustments to lsst.daf.butler.DatasetRef objects in the lsst.daf.butler.core.Quantum during the graph generation stage of the activator.
buildDatasetRefs(quantum)	Builds QuantizedConnections corresponding to input Quantum

Attributes Documentation

allConnections = {'measurement': Output(name='metricvalue_{package}_{metric}', storageClass='MetricValue', doc='The metric value computed by this task.', multiple=False, dimensions={'visit', 'detector', 'instrument'}, isCalibration=False), 'metadata': Input(name='{labelName}_metadata', storageClass='PropertySet', doc="The target top-level task's metadata. The name must be set to the metadata's butler type, such as 'processCcd_metadata'.", multiple=False, dimensions={'visit', 'detector', 'instrument'}, isCalibration=False, deferLoad=False)}

defaultTemplates = {'labelName': '', 'metric': None, 'package': None}

dimensions = {'detector', 'instrument', 'visit'}

initInputs = frozenset({})

initOutputs = frozenset({})

inputs = frozenset({'metadata'})

measurement

metadata

outputs = frozenset({'measurement'})

prerequisiteInputs = frozenset({})

Methods Documentation

adjustQuantum(datasetRefMap: lsst.daf.butler.NamedKeyDict[lsst.daf.butler.DatasetType, Set[lsst.daf.butler.DatasetRef]]) → lsst.daf.butler.NamedKeyDict[lsst.daf.butler.DatasetType, Set[lsst.daf.butler.DatasetRef]]

Override to make adjustments to lsst.daf.butler.DatasetRef objects in the lsst.daf.butler.core.Quantum during the graph generation stage of the activator.

The base class implementation simply checks that input connections with multiple set to False have no more than one dataset.

Parameters

datasetRefMapNamedKeyDict

Mapping from dataset type to a set of lsst.daf.butler.DatasetRef objects

Returns

datasetRefMapNamedKeyDict

Modified mapping of input with possibly adjusted lsst.daf.butler.DatasetRef objects.

Raises

ScalarError

Raised if any Input or PrerequisiteInput connection has multiple set to False, but multiple datasets.

Exception

Overrides of this function have the option of raising an Exception if a field in the input does not satisfy a need for a corresponding pipelineTask, i.e. no reference catalogs are found.

buildDatasetRefs(quantum: lsst.daf.butler.Quantum) → Tuple[lsst.pipe.base.InputQuantizedConnection, lsst.pipe.base.OutputQuantizedConnection]

Builds QuantizedConnections corresponding to input Quantum

Parameters

quantumlsst.daf.butler.Quantum

Quantum object which defines the inputs and outputs for a given unit of processing

Returns

retValtuple of (InputQuantizedConnection,

OutputQuantizedConnection) Namespaces mapping attribute names (identifiers of connections) to butler references defined in the input lsst.daf.butler.Quantum