TotalUnassociatedDiaObjectsMetricTask¶

class lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask(**kwargs)¶

Bases: ApdbMetricTask

Task that computes the number of DIAObjects with only one associated DIASource.

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.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makeMeasurement`(dbHandle, outputDataId)	Compute the number of unassociated DIAObjects.
`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

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.

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")

makeMeasurement(dbHandle, outputDataId)¶

Compute the number of unassociated DIAObjects.

Parameters:

dbHandlelsst.dax.apdb.Apdb: A database instance.
outputDataIdany data ID type: The subset of the database to which this measurement applies. Must be empty, as the number of unassociated sources is ill-defined for subsets of the dataset.

Returns:

measurementlsst.verify.Measurement: The total number of unassociated objects.

Raises:

MetricComputationError: Raised on any failure to query the database.
ValueError: Raised if outputDataId is not empty

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(dbInfo, outputDataId={})¶

Compute a measurement from a database.

Parameters:

dbInfolist: 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.

Returns:

resultlsst.pipe.base.Struct

Result struct with component:

measurement: the value of the metric (lsst.verify.Measurement or None)

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 of outputDataId to makeMeasurement. The result of makeMeasurement 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.

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.

Navigation

TotalUnassociatedDiaObjectsMetricTask¶