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

See also

See the FractionUpdatedDiaObjectsMetricTask API reference for complete details.

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

connections

Data type
lsst.pipe.base.config.Connections
Field type
ConfigField
Configurations describing the connections of the PipelineTask to datatypes

metadataDimensions

Default
{'detector', 'visit', 'instrument'}
Field type
str ListField
Override for the dimensions of the ‘metadata’ input, when instrumenting Tasks that don’t produce one metadata object per visit.

saveMetadata

Default
True
Field type
bool Field
Flag to enable/disable metadata saving for a task, enabled by default.