ApdbMetricTask¶
ApdbMetricTask is a base class for generating Measurements from an Alert Production Database.
The class handles loading an appropriately configured database, while subclasses are responsible for creating the Measurement using the database API.
Processing summary¶
ApdbMetricTask runs this sequence of operations:
- Load the dataset indicated by
dbInfo(default: one or moreapdb_markerdatasets). - Generate an
Apdbobject by calling thedbLoadersubtask (default:DirectApdbLoader). - Process the database by passing it to the customizable
makeMeasurementmethod, and return theMeasurement.
Python API summary¶
from lsst.verify.tasks.apdbMetricTask import ApdbMetricTask
-
class
ApdbMetricTask A base class for tasks that compute metrics from an alert production database
...
-
attribute
config Access configuration fields and retargetable subtasks.
See also
See the ApdbMetricTask 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
dbLoadersubtask (default:apdb_marker). If the input is a task config, its name must be explicitly configured when runningApdbMetricTaskor aMetricsControllerTaskthat contains it.
Output datasets¶
measurement- The value of the metric.
The dataset type should not be configured directly, but should be set
changing the
packageandmetrictemplate variables to the metric’s namespace (package, by convention) and in-package name, respectively. Subclasses that only support one metric should set these variables automatically.
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.