PpdbMetricTask

PpdbMetricTask is a base class for generating Measurements from a prompt products database. The class handles loading an appropriately configured database, while subclasses are responsible for creating the Measurement using the database API.

PpdbMetricTask is currently a subclass of lsst.verify.gen2tasks.MetricTask. It is expected that PpdbMetricTask can be migrated to the Gen 3 framework without affecting its subclasses.

Processing summary

PpdbMetricTask runs this sequence of operations:

  1. Load the dataset indicated by dbInfo (default: the top-level science task’s config).
  2. Generate a Ppdb object by calling the dbLoader subtask (default: ConfigPpdbLoader).
  3. Process the database by passing it to the customizable makeMeasurement method, and return the Measurement.

Python API summary

from lsst.verify.tasks.ppdbMetricTask import PpdbMetricTask
classPpdbMetricTask(**kwargs)

A base class for tasks that compute metrics from a prompt products database...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(dbInfo)

Compute a measurement from a database...

See also

See the PpdbMetricTask 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 PpdbMetricTask or a MetricsControllerTask that contains it.

Retargetable subtasks

dbLoader

Default
lsst.verify.tasks.ppdbMetricTask.ConfigPpdbLoader
Field type
ConfigurableField
Task for loading a database from dbInfo. Its run method must take the dataset provided by dbInfo and return a Struct with a ‘ppdb’ member.

Configuration fields

dbInfo

Data type
lsst.pipe.base.config.InputDatasetConfig
Field type
ConfigField
The dataset from which a PPDB instance can be constructed by dbLoader. By default this is assumed to be a top-level config, such as ‘processCcd_config’.