ApdbMetricTask¶
- class lsst.verify.tasks.ApdbMetricTask(**kwargs)¶
Bases:
MetricTask
A base class for tasks that compute metrics from an alert production database.
- Parameters:
- **kwargs
Constructor parameters are the same as for
lsst.pipe.base.PipelineTask
.
Notes
This class should be customized by overriding
makeMeasurement
. You should not need to overriderun
.Attributes Summary
Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get a dictionary of all tasks as a shallow copy.
makeField
(doc)Make a
lsst.pex.config.ConfigurableField
for this task.makeMeasurement
(dbHandle, outputDataId)Compute the metric from database data.
makeSubtask
(name, **keyArgs)Create a subtask as a new instance as the
name
attribute of this task.run
(dbInfo[, outputDataId])Compute a measurement from a database.
runQuantum
(butlerQC, inputRefs, outputRefs)Do Butler I/O to provide in-memory objects for run.
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
Methods Documentation
- getFullMetadata() TaskMetadata ¶
Get metadata for all tasks.
- Returns:
- metadata
TaskMetadata
The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.
- metadata
Notes
The returned metadata includes timing information (if
@timer.timeMethod
is used) and any metadata set by the task. The name of each item consists of the full task name with.
replaced by:
, followed by.
and the name of the item, e.g.:topLevelTaskName:subtaskName:subsubtaskName.itemName
using
:
in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.
- getFullName() str ¶
Get the task name as a hierarchical name including parent task names.
- Returns:
- fullName
str
The full name consists of the name of the parent task and each subtask separated by periods. For example:
The full name of top-level task “top” is simply “top”.
The full name of subtask “sub” of top-level task “top” is “top.sub”.
The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
See also
getFullName
Get the full name of the task.
- getTaskDict() dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]] ¶
Get a dictionary of all tasks as a shallow copy.
- Returns:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
Examples
Provides a convenient way to specify this task is a subtask of another task.
Here is an example of use:
class OtherTaskConfig(lsst.pex.config.Config): aSubtask = ATaskClass.makeField("brief description of task")
- abstract makeMeasurement(dbHandle, outputDataId)¶
Compute the metric from database data.
- Parameters:
- dbHandle
lsst.dax.apdb.Apdb
A database instance.
- outputDataIdany data ID type
The subset of the database to which this measurement applies. May be empty to represent the entire dataset.
- dbHandle
- Returns:
- measurement
lsst.verify.Measurement
orNone
The measurement corresponding to the input data.
- measurement
- Raises:
- lsst.verify.tasks.MetricComputationError
Raised if an algorithmic or system error prevents calculation of the metric. See
run
for expected behavior.- lsst.pipe.base.NoWorkFound
Raised if the metric is ill-defined or otherwise inapplicable to the database state. Typically this means that the pipeline step or option being measured was not run.
- makeSubtask(name: str, **keyArgs: Any) None ¶
Create a subtask as a new instance as the
name
attribute of this task.- Parameters:
- name
str
Brief name of the subtask.
- **keyArgs
Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:
config
.parentTask
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- run(dbInfo, outputDataId={})¶
Compute a measurement from a database.
- Parameters:
- dbInfo
list
The datasets (of the type indicated by the config) from which to load the database. If more than one dataset is provided (as may be the case if DB writes are fine-grained), all are assumed identical.
- outputDataId: any data ID type, optional
The output data ID for the metric value. Defaults to the empty ID, representing a value that covers the entire dataset.
- dbInfo
- Returns:
- result
lsst.pipe.base.Struct
Result struct with component:
measurement
the value of the metric (
lsst.verify.Measurement
orNone
)
- result
- Raises:
- lsst.verify.tasks.MetricComputationError
Raised if an algorithmic or system error prevents calculation of the metric.
- lsst.pipe.base.NoWorkFound
Raised if the metric is ill-defined or otherwise inapplicable to the database state. Typically this means that the pipeline step or option being measured was not run.
Notes
This implementation calls
dbLoader
to acquire a database handle, then passes it and the value ofoutputDataId
tomakeMeasurement
. The result ofmakeMeasurement
is returned to the caller.
- runQuantum(butlerQC, inputRefs, outputRefs)¶
Do Butler I/O to provide in-memory objects for run.
This specialization of runQuantum passes the output data ID to
run
.