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

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

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. Ignored if doReadMarker is unset. Deprecated: This field has been replaced by apdb_config_url; set doReadMarker=False to use it. Will be removed after v28.

Configuration fields¶

apdb_config_url¶

Default: None
Field type: str Field

A config file specifying the APDB and its connection parameters, typically written by the apdb-cli command-line utility.

connections¶

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

Configurations describing the connections of the PipelineTask to datatypes

doReadMarker¶

Default: True
Field type: bool Field

Use the dbInfo input to set up the APDB, instead of the new config (apdb_config_url). This field is provided for backward-compatibility ONLY and will be removed without notice after v28.

saveLogOutput¶

Default: True
Field type: bool Field

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

Navigation