CombineZernikesMeanTask¶
- class lsst.ts.wep.task.CombineZernikesMeanTask(**kwargs)¶
Bases:
CombineZernikesBaseTask
Combine the raw Zernike measurements into an average measurement with an unweighted mean.
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.
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.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
- 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.
- 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")
- 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(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:
- struct
lsst.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 inputzernikeArray
were not used.
- struct