SkyCorrectionTask¶

class lsst.pipe.tasks.skyCorrection.SkyCorrectionTask(*args, **kwargs)¶

Bases: lsst.pipe.base.PipelineTask

Correct sky over entire focal plane

Attributes Summary

canMultiprocess

Methods Summary

`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`focalPlaneBackgroundRun`(camera, …)	Perform full focal-plane background subtraction
`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.
`getResourceConfig`()	Return resource configuration for this task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`loadImageRun`(calExp, calExpBkg)	Serial implementation of self.loadImage() for Gen3.
`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`(calExpArray, calBkgArray, skyCalibs, camera)	Performa sky correction on an exposure.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Method to do butler IO and or transforms to provide in memory objects for tasks run method
`subtractModelRun`(exposure, bgModel)	Serial implementation of self.subtractModel() for Gen3.
`timer`(name, logLevel)	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess = True¶

Methods Documentation

emptyMetadata() → None¶: Empty (clear) the metadata for this Task and all sub-Tasks.

focalPlaneBackgroundRun(camera, cacheExposures, idList, config)¶

Perform full focal-plane background subtraction

This method runs on the master node.

Parameters:	camera : `lsst.afw.cameraGeom.Camera` Camera description. cacheExposures : `list` of `lsst.afw.image.Exposures` List of loaded and processed input calExp. idList : `list` of `int` List of detector ids to iterate over. config : `lsst.pipe.drivers.background.FocalPlaneBackgroundConfig` Configuration to use for background subtraction.
Returns:	exposures : `list` of `lsst.afw.image.Image` List of binned images, for creating focal plane image. newCacheBgList : `list` of `lsst.afwMath.backgroundList` Background lists generated. cacheBgModel : `FocalPlaneBackground` Full focal plane background model.

getFullMetadata() → lsst.pipe.base._task_metadata.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.

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”.

getName() → str¶

Get the name of the task.

Returns:	taskName : `str` Name of the task.

See also

getFullName

getResourceConfig() → Optional[ResourceConfig]¶

Return resource configuration for this task.

Returns:	Object of type `ResourceConfig` or `None` if resource configuration is not defined for this 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.

loadImageRun(calExp, calExpBkg)¶

Serial implementation of self.loadImage() for Gen3.

Load and restore background to calExp and calExpBkg.

Parameters:	calExp : `lsst.afw.image.Exposure` Detector level calExp image to process. calExpBkg : `lsst.afw.math.BackgroundList` Detector level background list associated with the calExp.
Returns:	calExp : `lsst.afw.image.Exposure` Background restored calExp. bgList : `lsst.afw.math.BackgroundList` New background list containing the restoration background.

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField¶

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:	doc : `str` Help text for the field.
Returns:	configurableField : `lsst.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) → 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”.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

run(calExpArray, calBkgArray, skyCalibs, camera)¶

Performa sky correction on an exposure.

Parameters:

calExpArray : list of lsst.afw.image.Exposure: Array of detector input calExp images for the exposure to process.
calBkgArray : list of lsst.afw.math.BackgroundList: Array of detector input background lists matching the calExps to process.
skyCalibs : list of lsst.afw.image.Exposure: Array of SKY calibrations for the input detectors to be processed.
camera : lsst.afw.cameraGeom.Camera: Camera matching the input data to process.

Returns:

results : pipeBase.Struct containing

calExpCamera : lsst.afw.image.Exposure: Full camera image of the sky-corrected data.
skyCorr : list of lsst.afw.math.BackgroundList: Detector-level sky-corrected background lists.

runQuantum(butlerQC, inputRefs, outputRefs)¶

Method to do butler IO and or transforms to provide in memory objects for tasks run method

Parameters:

butlerQC : ButlerQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefs : InputQuantizedConnection: 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.
outputRefs : OutputQuantizedConnection: 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.

subtractModelRun(exposure, bgModel)¶

Serial implementation of self.subtractModel() for Gen3.

Load and restore background to calExp and calExpBkg.

Parameters:	exposure : `lsst.afw.image.Exposure` Exposure to subtract the background model from. bgModel : `lsst.pipe.drivers.background.FocalPlaneBackground` Full camera level background model.
Returns:	exposure : `lsst.afw.image.Exposure` Background subtracted input exposure. bgModelCcd : `lsst.afw.math.BackgroundList` Detector level realization of the full background model. bgModelMaskedImage : `lsst.afw.image.MaskedImage` Background model from the bgModelCcd realization.

timer(name: str, logLevel: int = 10) → Iterator[None]¶

Context manager to log performance data for an arbitrary block of code.

Parameters:	name : `str` Name of code being timed; data will be logged using item name: `Start` and `End`. logLevel A `logging` level constant.

Navigation

SkyCorrectionTask¶