NumberNewDiaObjectsMetricTask¶

NumberNewDiaObjectsMetricTask computes the number of DIAObjects created when processing data through source association (as the ap_association.numNewDiaObjects metric). It requires task metadata as input, and can operate at image-level or coarser granularity.

Processing summary¶

NumberNewDiaObjectsMetricTask reads AssociationTask statistics from task metadata associated with one or more processed images. It uses these statistics to count the number of new DIAObjects added when processing those images.

Python API summary¶

from lsst.ap.association.metrics import NumberNewDiaObjectsMetricTask

classNumberNewDiaObjectsMetricTask(**kwargs): Task that computes the number of DIASources that create new DIAObjects in an image, visit, etc...

attributeconfig: Access configuration fields and retargetable subtasks.

methodrun(metadata): Compute a measurement from science task metadata...

Butler datasets¶

Input datasets¶

metadata: The metadata of the top-level pipeline task (e.g., CharacterizeImageTask, DiaPipeTask) being instrumented.

Retargetable subtasks¶

No subtasks.

Configuration fields¶

connections¶

Data type: lsst.pipe.base.config.Connections
Field type: ConfigField

Configurations describing the connections of the PipelineTask to datatypes

metadataDimensions¶

Default: ['detector', 'instrument', 'visit']
Field type: str ListField

Override for the dimensions of the ‘metadata’ input, when instrumenting Tasks that don’t produce one metadata object per visit.

saveLogOutput¶

Default: True
Field type: bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata¶

Default: True
Field type: bool Field

Flag to enable/disable metadata saving for a task, enabled by default.

Navigation