CalibCombineByFilterTask¶
- class lsst.cp.pipe.CalibCombineByFilterTask(**kwargs)¶
Bases:
CalibCombineTask
Task to combine calib exposures.
Attributes Summary
Methods Summary
applyScale
(exposure[, bbox, scale])Apply scale to input exposure.
calibStats
(exp, calibrationType)Measure bulk statistics for the calibration.
combine
(target, expHandleList, expScaleList, ...)Combine multiple images.
combineHeaders
(expHandleList, calib[, ...])Combine input headers to determine the set of common headers, supplemented by calibration inputs.
Empty (clear) the metadata for this Task and all sub-Tasks.
getDimensions
(expHandleList)Get dimensions of the inputs.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
getSize
(dimList)Determine a consistent size, given a list of image sizes.
Get a dictionary of all tasks as a shallow copy.
interpolateNans
(exp)Interpolate over NANs in the combined image.
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
(inputExpHandles[, inputScales, inputDims])Combine calib exposures for a single detector.
runQuantum
(butlerQC, inputRefs, outputRefs)Do butler IO and transform to provide in memory objects for tasks
run
method.setFilter
(exp, filterLabel)Dummy function that will not assign a filter.
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
Methods Documentation
- applyScale(exposure, bbox=None, scale=None)¶
Apply scale to input exposure.
This implementation applies a flux scaling: the input exposure is divided by the provided scale.
- Parameters:
- exposure
lsst.afw.image.Exposure
Exposure to scale.
- bbox
lsst.geom.Box2I
BBox matching the segment of the exposure passed in.
- scale
float
orlist
[float
], optional Constant scale to divide the exposure by.
- exposure
- calibStats(exp, calibrationType)¶
Measure bulk statistics for the calibration.
- Parameters:
- exp
lsst.afw.image.Exposure
Exposure to calculate statistics for.
- calibrationType
str
Type of calibration to record in header.
- exp
- combine(target, expHandleList, expScaleList, stats)¶
Combine multiple images.
- Parameters:
- target
lsst.afw.image.Exposure
Output exposure to construct.
- expHandleList
list
[lsst.daf.butler.DeferredDatasetHandle
] Input exposure handles to combine.
- expScaleList
list
[float
] List of scales to apply to each input image.
- stats
lsst.afw.math.StatisticsControl
Control explaining how to combine the input images.
- target
- combineHeaders(expHandleList, calib, calibType='CALIB', scales=None)¶
Combine input headers to determine the set of common headers, supplemented by calibration inputs. The calibration header is set in-place.
- Parameters:
- expHandleList
list
[lsst.daf.butler.DeferredDatasetHandle
] Input list of exposure handles to combine.
- calib
lsst.afw.image.Exposure
Output calibration to construct headers for.
- calibType
str
, optional OBSTYPE the output should claim.
- scales
list
[float
], optional Scale values applied to each input to record.
- expHandleList
- Returns:
- header
lsst.daf.base.PropertyList
Constructed header.
- header
- getDimensions(expHandleList)¶
Get dimensions of the inputs.
- Parameters:
- expHandleList
list
[lsst.daf.butler.DeferredDatasetHandle
] Exposure handles to check the sizes of.
- expHandleList
- Returns:
- width, height
int
Unique set of input dimensions.
- width, height
- 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.
- getSize(dimList)¶
Determine a consistent size, given a list of image sizes.
- 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
- interpolateNans(exp)¶
Interpolate over NANs in the combined image.
NANs can result from masked areas on the CCD. We don’t want them getting into our science images, so we replace them with the median of the image.
- Parameters:
- exp
lsst.afw.image.Exposure
Exp to check for NaNs.
- exp
- 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(inputExpHandles, inputScales=None, inputDims=None)¶
Combine calib exposures for a single detector.
- Parameters:
- inputExpHandles
list
[lsst.daf.butler.DeferredDatasetHandle
] Input list of exposure handles to combine.
- inputScales
dict
[dict
[dict
[float
]]], optional Dictionary of scales, indexed by detector (
int
), amplifier (int
), and exposure (int
). Used for ‘inputExps’ scaling.- inputDims
list
[dict
] List of dictionaries of input data dimensions/values. Each list entry should contain:
- inputExpHandles
- Returns:
- results
lsst.pipe.base.Struct
The results struct containing:
outputData
Final combined exposure generated from the inputs (
lsst.afw.image.Exposure
).
- results
- Raises:
- RuntimeError
Raised if no input data is found. Also raised if config.exposureScaling == InputList, and a necessary scale was not found.
- runQuantum(butlerQC, inputRefs, outputRefs)¶
Do butler IO and transform to provide in memory objects for tasks
run
method.- Parameters:
- butlerQC
QuantumContext
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 thelsst.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 thelsst.daf.butler.DatasetRef
objects associated with the defined output connections.
- butlerQC
- static setFilter(exp, filterLabel)¶
Dummy function that will not assign a filter.
- Parameters:
- exp
lsst.afw.image.Exposure
Exposure to assign filter to.
- filterLabel
lsst.afw.image.FilterLabel
Filter to assign.
- exp