PhotodiodeCorrectionTask¶

class lsst.cp.pipe.PhotodiodeCorrectionTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: Dict[str, Any] | None = None, **kwargs: Any)¶

Bases: PipelineTask

Calculate the photodiode corrections.

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.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`run`(inputPtc, inputLinearizer, camera, inputDims)	Calculate the systematic photodiode correction.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Ensure that the input and output dimensions are passed along.
`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

getTaskDict() → Dict[str, ReferenceType[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(inputPtc, inputLinearizer, camera, inputDims)¶

Calculate the systematic photodiode correction.

Parameters:

inputPtclsst.ip.isr.PtcDataset: Pre-measured PTC dataset.
inputLinearizerlsst.ip.isr.Linearizer: Previously measured linearizer.
cameralsst.afw.cameraGeom.Camera: Camera geometry.
inputDimslsst.daf.butler.DataCoordinate or dict: DataIds to use to populate the output calibration.

Returns:

resultslsst.pipe.base.Struct

The results struct containing:

outputCorrection: Final correction calibration (lsst.ip.isr.PhotodiodeCorrection).
outputProvenance: Provenance data for the new calibration (lsst.ip.isr.IsrProvenance).

Notes

Basic correction algorithm (due to Aaron Roodman) is as follows: (1) Run the spline fit to the flux vs monitor diode. (2) For each amp and each exposure, calculate the correction needed to the monitor diode reading to bring it to the spline. We call this the abscissaCorrection. (3) For each exposure, take the median correction across the focal plane. Random variations will cancel out, but systematic variations will not. (4) Subtract this correction from each monitor diode reading. (5) Re-run the spline fit using the corrected monitor diode readings.

runQuantum(butlerQC, inputRefs, outputRefs)¶

Ensure that the input and output dimensions are passed along.

Parameters:

butlerQClsst.daf.butler.butlerQuantumContext.ButlerQuantumContext: Butler to operate on.
inputRefslsst.pipe.base.connections.InputQuantizedConnection: Input data refs to load.
outputRefslsst.pipe.base.connections.OutputQuantizedConnection: Output data refs to persist.

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.
logLevel: A logging level constant.

Navigation

PhotodiodeCorrectionTask¶