CutOutDonutsScienceSensorTask¶

class lsst.ts.wep.task.CutOutDonutsScienceSensorTask(**kwargs)¶

Bases: CutOutDonutsBaseTask

Run Zernike Estimation in full-array mode (FAM)

Attributes Summary

canMultiprocess

Methods Summary

`assignExtraIntraIdx`(focusZVal0, focusZVal1, ...)	Identify which exposure in the list is the extra-focal and which is the intra-focal based upon `FOCUSZ` parameter in header.
`calculateFinalCentroid`(exposure, template, ...)	Recentroid donut from catalog values by convolving with template.
`cutOutStamps`(exposure, donutCatalog, ...)	Cut out postage stamps for sources in catalog.
`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`(exposures, donutCatalog, camera)	Run task algorithm on in-memory data.
`runQuantum`(butlerQC, inputRefs, outputRefs)	We need to be able to take pairs of detectors from the full set of detector exposures and run the task.
`shiftCenter`(center, boundary, distance)	Shift the center if its distance to boundary is less than required.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess: ClassVar[bool] = True¶

Methods Documentation

assignExtraIntraIdx(focusZVal0, focusZVal1, cameraName)¶

Identify which exposure in the list is the extra-focal and which is the intra-focal based upon FOCUSZ parameter in header.

Parameters:

focusZVal0float: The FOCUSZ parameter from the first exposure.
focusZVal1float: The FOCUSZ parameter from the second exposure.
cameraNamestr: Name of camera for the exposure. Can accept “LSSTCam”, “LSSTComCam”, “LSSTComCamSim”, “LATISS”.

Returns:

int: Index in list which is extra-focal image.
int: Index in list which is intra-focal image.

Raises:

ValueError: Exposures must be a pair with one intra-focal and one extra-focal image.
ValueError: Invalid cameraName variable.

calculateFinalCentroid(exposure, template, xCent, yCent)¶

Recentroid donut from catalog values by convolving with template. Also return the appropriate corner values for the final donutStamp taking into account donut possibly being near the edges of the exposure and compensating appropriately.

Parameters:

exposurelsst.afw.image.Exposure: Exposure with the donut image.
templatenumpy.ndarray: Donut template for the exposure.
xCentint: X pixel donut center from donutCatalog.
yCentint: Y pixel donut center from donutCatalog.

Returns:

int: Final donut x centroid pixel position on exposure.
int: Final donut y centroid pixel position on exposure.
int: Final x corner position on exposure for donutStamp BBox.
int: Final y corner position on exposure for donutStamp BBox.

cutOutStamps(exposure, donutCatalog, defocalType, cameraName)¶

Cut out postage stamps for sources in catalog.

Parameters:

exposurelsst.afw.image.Exposure: Post-ISR image with defocal donuts sources.
donutCatalogpandas.DataFrame: Source catalog for the pointing.
defocalTypeenum ‘DefocalType’: Defocal type of the donut image.
cameraNamestr: Name of camera for the exposure. Can accept “LSSTCam”, “LSSTComCam”, “LATISS”.

Returns:

DonutStamps: Collection of postage stamps as lsst.afw.image.MaskedImage with additional metadata.

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(exposures: List[Exposure], donutCatalog: List[DataFrame], camera: Camera) → Struct¶

Run task algorithm on in-memory data.

This method should be implemented in a subclass. This method will receive keyword arguments whose names will be the same as names of connection fields describing input dataset types. Argument values will be data objects retrieved from data butler. If a dataset type is configured with multiple field set to True then the argument value will be a list of objects, otherwise it will be a single object.

If the task needs to know its input or output DataIds then it has to override runQuantum method instead.

This method should return a Struct whose attributes share the same name as the connection fields describing output dataset types.

Parameters:

**kwargsAny: Arbitrary parameters accepted by subclasses.

Returns:

structStruct: Struct with attribute names corresponding to output connection fields.

Examples

Typical implementation of this method may look like:

def run(self, input, calib):
    # "input", "calib", and "output" are the names of the config
    # fields

    # Assuming that input/calib datasets are `scalar` they are
    # simple objects, do something with inputs and calibs, produce
    # output image.
    image = self.makeImage(input, calib)

    # If output dataset is `scalar` then return object, not list
    return Struct(output=image)

runQuantum(butlerQC: QuantumContext, inputRefs: InputQuantizedConnection, outputRefs: OutputQuantizedConnection)¶

We need to be able to take pairs of detectors from the full set of detector exposures and run the task. Then we need to put the outputs back into the butler repository with the appropriate butler dataIds.

For the outputZernikesRaw and outputZernikesAvg we only have one set of values per pair of wavefront detectors so we put this in the dataId associated with the extra-focal detector.

shiftCenter(center, boundary, distance)¶

Shift the center if its distance to boundary is less than required.

Parameters:

centerfloat: Center point.
boundaryfloat: Boundary point.
distancefloat: Required distance.

Returns:

float: Shifted center.

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

CutOutDonutsScienceSensorTask¶