EstimateZernikesTieTask

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

Bases: EstimateZernikesBaseTask

Estimate Zernike coefficients using the TIE algorithm.

Attributes Summary

wfAlgoConfig	Return the configuration for the WfAlgorithm.
wfAlgoName	Return the WfAlgorithmName enum.

Methods Summary

emptyMetadata()	Empty (clear) the metadata for this Task and all sub-Tasks.
estimateFromIndivStamps(donutStampsExtra, ...)	Estimate Zernike coefficients from individual donut stamps.
estimateFromPairs(donutStampsExtra, ...[, ...])	Estimate Zernike coefficients from pairs of donut stamps.
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(donutStampsExtra, donutStampsIntra[, ...])	Estimate Zernike coefficients (in microns) from the donut stamps.
timer(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

wfAlgoConfig

Return the configuration for the WfAlgorithm.

wfAlgoName

Return the WfAlgorithmName enum.

Methods Documentation

emptyMetadata() → None

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

estimateFromIndivStamps(donutStampsExtra: DonutStamps, donutStampsIntra: DonutStamps, wfEstimator: WfEstimator, numCores: int = 1) → Tuple[array, dict]

Estimate Zernike coefficients from individual donut stamps.

Parameters

donutStampsExtraDonutStamps

Extra-focal donut postage stamps.

donutStampsIntraDonutStamps

Intra-focal donut postage stamps.

wfEstimatorWfEstimator

The wavefront estimator object.

numCoresint

Number of cores to parallelize over.

Returns

np.ndarray

Numpy array of estimated Zernike coefficients. The first axis indexes donut stamps, starting with extrafocal stamps, followed by intrafocal stamps. The second axis indexes the Noll coefficients.

dict

Metadata containing extra output from Zernike estimation. Each key is a type of output from the Zernike estimation method selected and contains a list of values, one for each donut.

estimateFromPairs(donutStampsExtra: DonutStamps, donutStampsIntra: DonutStamps, wfEstimator: WfEstimator, numCores: int = 1) → Tuple[array, dict]

Estimate Zernike coefficients from pairs of donut stamps.

Parameters

donutStampsExtraDonutStamps

Extra-focal donut postage stamps.

donutStampsIntraDonutStamps

Intra-focal donut postage stamps.

wfEstimatorWfEstimator

The wavefront estimator object.

numCoresint

Number of cores to parallelize over.

Returns

np.ndarray

Numpy array of estimated Zernike coefficients. The first axis indexes donut pairs while the second axis indexes the Noll coefficients.

dict

Metadata containing extra output from Zernike estimation. Each key is a type of output from the Zernike estimation method selected and contains a list of values, one for each pair of donuts.

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(donutStampsExtra: DonutStamps, donutStampsIntra: DonutStamps, numCores: int = 1) → Struct

Estimate Zernike coefficients (in microns) from the donut stamps.

Parameters

donutStampsExtraDonutStamps

Extra-focal donut postage stamps.

donutStampsIntraDonutStamps

Intra-focal donut postage stamps.

numCoresint

Number of cores to parallelize over.

Returns

lsst.pipe.base.Struct

A struct containing “zernikes”, which is a 2D numpy array, where the first axis indexes the pair of DonutStamps and the second axis indexes the Zernikes coefficients. The units are microns. Also contains “wfEstInfo”, which is a dictionary containing metadata with extra output from the wavefront estimation algorithm.

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.