ApdbMetricTask¶
ApdbMetricTask
is a base class for generating Measurement
s 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.
ApdbMetricTask
is currently a subclass of lsst.verify.tasks.MetricTask
.
It is expected that ApdbMetricTask
can be migrated to the Gen 3 framework without affecting its subclasses.
Processing summary¶
ApdbMetricTask
runs this sequence of operations:
- Load the dataset indicated by
dbInfo
(default: one or moreapdb_marker
datasets). - Generate an
Apdb
object by calling thedbLoader
subtask (default:DirectApdbLoader
). - Process the database by passing it to the customizable
makeMeasurement
method, and return theMeasurement
.
Python API summary¶
from lsst.verify.tasks.apdbMetricTask import ApdbMetricTask
-
class
(**kwargs)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
dbLoader
subtask (default:apdb_marker
). If the input is a task config, its name must be explicitly configured when runningApdbMetricTask
or aMetricsControllerTask
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