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

classCalibCombineByFilterTask(**kwargs)

Task to combine calib exposures...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(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

ConfigurableField

Background statistics configuration

Configuration fields

calibrationType

Default

'calibration'

Field type

str Field

Name of calibration to be generated.

clip

Default

3.0

Field type

float Field

Clipping threshold for combination

combine

Default

'MEANCLIP'

Field type

str Field

Statistic name to use for combination (from Property)

connections

Data type

lsst.pipe.base.config.CalibCombineByFilterConfigConnections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

doVignette

Default

False

Field type

bool Field

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

Default

['SAT', 'DETECTED', 'INTRP']

Field type

str ListField

Mask planes to respect

maxVisitsToCalcErrorFromInputVariance

Default

5

Field type

int Field

Maximum number of visits to estimate variance from input variance, not per-pixel spread

nIter

Default

3

Field type

int Field

Clipping iterations for combination

saveLogOutput

Default

True

Field type

bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata

Default

True

Field type

bool Field

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

Default

(10000, 200)

Field type

int ListField

Required length

2

Width, height of subregion size.