TotalUnassociatedDiaObjectsMetricTask

TotalUnassociatedDiaObjectsMetricTask computes the number of DIAObjects that have only a single source (as the ap_association.totalUnassociatedDiaObjects metric). It requires an alert production database as input, and is meaningful only at dataset-level granularity.

Processing summary

TotalUnassociatedDiaObjectsMetricTask queries the database (through Apdb) for the number of DIAObjects with exactly one source.

Python API summary

from lsst.ap.association.metrics import TotalUnassociatedDiaObjectsMetricTask

classTotalUnassociatedDiaObjectsMetricTask(**kwargs)

Task that computes the number of DIAObjects with only one associated DIASource...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(dbInfo, outputDataId={})

Compute a measurement from a database...

See also

See the TotalUnassociatedDiaObjectsMetricTask API reference for complete details.

Butler datasets

Input datasets

dbInfo

The Butler dataset from which the database connection can be initialized. The type must match the input required by the dbLoader subtask (default: the top-level science task’s config). If the input is a config, its name must be explicitly configured when running TotalUnassociatedDiaObjectsMetricTask or a MetricsControllerTask that contains it.

Retargetable subtasks

dbLoader

Default

lsst.verify.tasks.apdbMetricTask.DirectApdbLoader

Field type

ConfigurableField

Task for loading a database from dbInfo. Its run method must take one object of the dataset type indicated by dbInfo and return a Struct with an ‘apdb’ member.

Configuration fields

connections

Data type

lsst.pipe.base.config.Connections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

saveMetadata

Default

True

Field type

bool Field

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