MetadataMetricTask¶
MetadataMetricTask is a base class for generating Measurements from task metadata of the same granularity.
The class handles loading metadata and extracting the keys of interest, while subclasses are responsible for creating the Measurement from the extracted values.
MetadataMetricTask is currently a subclass of lsst.verify.tasks.MetricTask.
It is expected that MetadataMetricTask can be migrated to the Gen 3 framework without affecting its subclasses.
Processing summary¶
MetadataMetricTask runs this sequence of operations:
- Find the metadata key(s) needed to compute the metric by calling the customizable
getInputMetadataKeysmethod. - Search the metadata object passed to
runfor the keys, and extract the corresponding values. - Process the values by calling the customizable
makeMeasurementmethod, and return theMeasurement.
Python API summary¶
from lsst.verify.tasks.metadataMetricTask import MetadataMetricTask
-
class
MetadataMetricTask A base class for tasks that compute metrics from single metadata objects
...
-
attribute
config Access configuration fields and retargetable subtasks.
See also
See the MetadataMetricTask API reference for complete details.
Butler datasets¶
Input datasets¶
metadata`- The metadata of the top-level command-line task (e.g.,
ProcessCcdTask,ApPipeTask) being instrumented. Because the metadata produced by each top-level task is a different Butler dataset type, this dataset must be explicitly configured when runningMetadataMetricTaskor 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¶
No subtasks.