MakeMetricTableTask

class lsst.analysis.tools.tasks.MakeMetricTableTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: dict[str, Any] | None = None, **kwargs: Any)

Bases: PipelineTask

Turn metric bundles and combine them into a metric table.

Attributes Summary

canMultiprocess

Methods Summary

emptyMetadata()

Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata()

Get metadata for all tasks.

getFullName()

Get the task name as a hierarchical name including parent task names.

getName()

Get the name of the task.

getTaskDict()

Get a dictionary of all tasks as a shallow copy.

getTractCorners(skymap, tract)

Calculate the corners of a tract, given skymap.

makeField(doc)

Make a lsst.pex.config.ConfigurableField for this task.

makeSubtask(name, **keyArgs)

Create a subtask as a new instance as the name attribute of this task.

run(dataIdInfo, metricBundles, skymap)

Take the metric bundles and expand them out, then make a table of the information.

runQuantum(butlerQC, inputRefs, outputRefs)

Take a set of metric bundles, seperate each into its different metrics, then put the values into a table with the metric names as column headers.

timer(name[, logLevel])

Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess: ClassVar[bool] = True

Methods Documentation

emptyMetadata() → None

Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → TaskMetadata

Get metadata for all tasks.

Returns:
metadataTaskMetadata

The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

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:
fullNamestr

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”.

getName() → str

Get the name of the task.

Returns:
taskNamestr

Name of the task.

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:
taskDictdict

Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

getTractCorners(skymap, tract)

Calculate the corners of a tract, given skymap.

Parameters:
skymaplsst.skymap
tractint
Returns:
cornerslist of tuples of float

Notes

Corners are returned in degrees and wrapped in ra.

classmethod makeField(doc: str) → ConfigurableField

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:
docstr

Help text for the field.

Returns:
configurableFieldlsst.pex.config.ConfigurableField

A ConfigurableField for this task.

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")
makeSubtask(name: str, **keyArgs: Any) → None

Create a subtask as a new instance as the name attribute of this task.

Parameters:
namestr

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.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

run(dataIdInfo, metricBundles, skymap)

Take the metric bundles and expand them out, then make a table of the information. Add tract corner information if the bundles are tract-level.

Parameters:
dataIdInfolist

A list of dicts that hold information extracted from the metric bundle dataIds.

metricBundleslist of

lsst.analysis.tools.interfaces._metricMeasurementBundle.MetricMeasurementBundle

skymaplsst.skymap
Returns:
metricTableStructpipe.base.Struct containing astropy.table.Table
runQuantum(butlerQC, inputRefs, outputRefs)

Take a set of metric bundles, seperate each into its different metrics, then put the values into a table with the metric names as column headers.

Parameters:
butlerQClsst.pipe.base.QuantumContext
inputRefslsst.pipe.base.InputQuantizedConnection
outputRefslsst.pipe.base.OutputQuantizedConnection
timer(name: str, logLevel: int = 10) → Iterator[None]

Context manager to log performance data for an arbitrary block of code.

Parameters:
namestr

Name of code being timed; data will be logged using item name: Start and End.

logLevelint

A logging level constant.

See also

lsst.utils.timer.logInfo

Implementation function.

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time