ApdbMetricConnections

class lsst.verify.tasks.ApdbMetricConnections(*, config: PipelineTaskConfig = None)

Bases: lsst.verify.tasks.MetricConnections

An abstract connections class defining a database input.

Notes

ApdbMetricConnections 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.

Attributes Summary

allConnections
dbInfo
defaultTemplates
dimensions
initInputs
initOutputs
inputs
measurement
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 = {'dbInfo': Input(name='apdb_marker', storageClass='Config', doc='The dataset from which an APDB instance can be constructed by `dbLoader`. By default this is assumed to be a marker produced by AP processing.', multiple=True, dimensions={'instrument', 'visit', 'detector'}, deferLoad=False), 'measurement': Output(name='metricvalue_{package}_{metric}', storageClass='MetricValue', doc='The metric value computed by this task.', multiple=False, dimensions={'instrument'})}

dbInfo

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

dimensions = {'instrument'}

initInputs = frozenset()

initOutputs = frozenset()

inputs = frozenset({'dbInfo'})

measurement

outputs = frozenset({'measurement'})

prerequisiteInputs = frozenset()

Methods Documentation

adjustQuantum(datasetRefMap: lsst.pipe.base.connections.InputQuantizedConnection)

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:

datasetRefMap : dict

Mapping from dataset type name to list of lsst.daf.butler.DatasetRef objects

Returns:

datasetRefMap : dict

Modified mapping of input with possible 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.core.quantum.Quantum) → Tuple[lsst.pipe.base.connections.InputQuantizedConnection, lsst.pipe.base.connections.OutputQuantizedConnection]

Builds QuantizedConnections corresponding to input Quantum

Parameters:

quantum : lsst.daf.butler.Quantum

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

Returns:

retVal : tuple of (InputQuantizedConnection,

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