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 command-line task (e.g., ProcessCcdTask, ApPipeTask) being instrumented. Because the metadata produced by each top-level task is a different Butler dataset type, this dataset must be explicitly configured when running NumberNewDiaObjectsMetricTask or a MetricsControllerTask that contains it.

Retargetable subtasks¶

No subtasks.

Configuration fields¶

metadata¶

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

The target top-level task’s metadata. The name must be set to the metadata’s butler type, such as ‘processCcd_metadata’.

Navigation