CalibCombineByFilterTask¶
CalibCombineByFilterTask
is identical to lsst.cp.pipe.CalibCombineTask
, with the addition of a filter dimension to ensure filter-dependent calibrations are constructed with the correct dataset dimensions.
Python API summary¶
from lsst.cp.pipe.cpCombine import CalibCombineByFilterTask
-
class
CalibCombineByFilterTask
(**kwargs) Task to combine calib exposures
...
- attributeconfig
Access configuration fields and retargetable subtasks.
-
method
run
(inputExpHandles, inputScales=None, inputDims=None) Combine calib exposures for a single detector
...
See also
See the CalibCombineByFilterTask
API reference for complete details.
Retargetable subtasks¶
stats¶
- Default
lsst.cp.pipe.cpCombine.CalibStatsTask
- Field type
Background statistics configuration
Configuration fields¶
calibrationType¶
Name of calibration to be generated.
clip¶
Clipping threshold for combination
combine¶
Statistic name to use for combination (from Property
)
connections¶
- Data type
lsst.pipe.base.config.CalibCombineByFilterConfigConnections
- Field type
Configurations describing the connections of the PipelineTask to datatypes
doVignette¶
Copy vignette polygon to output and censor vignetted pixels?
exposureScaling¶
- Default
'Unity'
- Field type
str
ChoiceField
(optional)- Choices
'Unity'
Do not scale inputs. Scale factor is 1.0.
'ExposureTime'
Scale inputs by their exposure time.
'DarkTime'
Scale inputs by their dark time.
'MeanStats'
Scale inputs based on their mean values.
'InputList'
Scale inputs based on a list of values.
None
Field is optional
Scaling to be applied to each input exposure.
mask¶
Mask planes to respect
maxVisitsToCalcErrorFromInputVariance¶
Maximum number of visits to estimate variance from input variance, not per-pixel spread
nIter¶
Clipping iterations for combination
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
saveMetadata¶
Flag to enable/disable metadata saving for a task, enabled by default. Deprecated: This field is deprecated and will be removed after v26.
scalingLevel¶
- Default
'DETECTOR'
- Field type
str
ChoiceField
(optional)- Choices
'DETECTOR'
Scale by detector.
'AMP'
Scale by amplifier.
None
Field is optional
Region to scale.
subregionSize¶
Width, height of subregion size.