CombineZernikesBaseTask

class lsst.ts.wep.task.CombineZernikesBaseTask(**kwargs)

Bases: Task

Base class for algorithms that combine Zernikes from the individual pairs of donuts on a detector into a single array of Zernike values for that detector.

Methods Summary

combineZernikes(zernikeArray)	Class specific algorithm to combine the Zernike coefficients from each individual donut pair into a single set of coefficients for the detector.
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.
makeSubtask(name, **keyArgs)	Create a subtask as a new instance as the name attribute of this task.
run(zernikeArray)	Combine the zernikes from the input array of Zernike coefficients from each individual donut pair.
timer(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

abstract combineZernikes(zernikeArray)

Class specific algorithm to combine the Zernike coefficients from each individual donut pair into a single set of coefficients for the detector.

Parameters

zernikeArraynumpy.ndarray

The full set of zernike coefficients for each pair of donuts on the CCD. Each row of the array should be the set of Zernike coefficients for a single donut pair.

Returns

numpy.ndarray

The final combined Zernike coefficients from the CCD.

numpy.ndarray

A binary array where a value of 0 in any index indicates that the row in the zernikeArray was used in the final combination and a value of 1 indicates it was not included in the final combination.

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

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(zernikeArray)

Combine the zernikes from the input array of Zernike coefficients from each individual donut pair.

Parameters

zernikeArraynumpy.ndarray

The full set of zernike coefficients for each pair of donuts on the CCD. Each row of the array should be the set of Zernike coefficients for a single donut pair.

Returns

structlsst.pipe.base.Struct

The struct contains the following data:

• combinedZernikesnumpy.ndarray

  The final combined Zernike coefficients from the CCD.

• combineFlagsnumpy.ndarray

  Flag indicating a particular set of Zernike coefficients was not used in the final estimate. If the values in a row in the zernikeArray were used then its index is 0. A value of 1 means the coefficients from that row in the input zernikeArray were not used.

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.

Examples

Creating a timer context:

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

See Also

lsst.utils.timer.logInfo : Implementation function.