CrosstalkExtractTask¶

class lsst.cp.pipe.CrosstalkExtractTask(**kwargs)¶

Bases: PipelineTask

Task to measure pixel ratios to find crosstalk.

Attributes Summary

canMultiprocess

Methods Summary

`debugPixels`(stepname, pixelsIn, pixelsOut, ...)	Utility function to examine the CT ratio pixel values.
`debugView`(stepname, exposure)	Utility function to examine the image being processed.
`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`(inputExp[, sourceExps])	Measure pixel ratios between amplifiers in inputExp.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Do butler IO and transform to provide in memory objects for tasks `run` method.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess: ClassVar[bool] = True¶

Methods Documentation

debugPixels(stepname, pixelsIn, pixelsOut, sourceName, targetName)¶

Utility function to examine the CT ratio pixel values.

Parameters:

stepnamestr: State of processing to view.
pixelsInnp.ndarray, (N,): Pixel values from the potential crosstalk source.
pixelsOutnp.ndarray, (N,): Pixel values from the potential crosstalk target.
sourceNamestr: Source amplifier name
targetNamestr: Target amplifier name

debugView(stepname, exposure)¶

Utility function to examine the image being processed.

Parameters:

stepnamestr: State of processing to view.
exposurelsst.afw.image.Exposure: Exposure to view.

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, 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(inputExp, sourceExps=[])¶

Measure pixel ratios between amplifiers in inputExp.

Extract crosstalk ratios between different amplifiers.

For pixels above config.threshold, we calculate the ratio between each background-subtracted target amp and the source amp. We return a list of ratios for each pixel for each target/source combination, as nested dictionary containing the ratio.

Parameters:

inputExplsst.afw.image.Exposure: Input exposure to measure pixel ratios on.
sourceExplist [lsst.afw.image.Exposure], optional: List of chips to use as sources to measure inter-chip crosstalk.

Returns:

resultslsst.pipe.base.Struct

The results struct containing:

outputRatios: A catalog of ratio lists. The dictionaries are indexed such that: outputRatios[targetChip][sourceChip][targetAmp][sourceAmp] contains the ratio list for that combination (dict [dict [dict [dict [list]]]]).
outputFluxes: A catalog of flux lists. The dictionaries are indexed such that: outputFluxes[sourceChip][sourceAmp] contains the flux list used in the outputRatios (dict [dict [list]]).

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

Do butler IO and transform to provide in memory objects for tasks run method.

Parameters:

butlerQCQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefsInputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.
outputRefsOutputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

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

CrosstalkExtractTask¶