FractionUpdatedDiaObjectsMetricTask¶

FractionUpdatedDiaObjectsMetricTask computes the fraction of DIAObjects that were updated when processing data through source association (as the ap_association.fracUpdatedDiaObjects metric). It requires task metadata as input. While the task can operate at image-level or coarser granularity, the current algorithm may double-count objects and should not be run on multiple visits.

Processing summary¶

FractionUpdatedDiaObjectsMetricTask reads AssociationTask statistics from task metadata associated with one or more processed images. It uses these statistics to compute the fraction of potentially updatable DIAObjects that were updated with new sources when processing those images.

Python API summary¶

from lsst.ap.association.metrics import FractionUpdatedDiaObjectsMetricTask

classFractionUpdatedDiaObjectsMetricTask(**kwargs): Task that computes the fraction of previously created DIAObjects that have a new association in this 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 FractionUpdatedDiaObjectsMetricTask 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