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

vignette

Default

lsst.ip.isr.vignette.VignetteTask

Field type

ConfigurableField

Vignetting task.

Configuration fields

calibrationType

Default

'calibration'

Field type

str Field

Name of calibration to be generated.

censorMaskPlanes

Default

True

Field type

bool Field

Unset mask planes other than NO_DATA in output calibration?

checkNoData

Default

True

Field type

bool Field

Check that the calibration does not have NO_DATA set?

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

distributionPercentiles

Default

[0, 5, 16, 50, 84, 95, 100]

Field type

float ListField

Percentile levels to measure on the final combined calibration.

doVignette

Default

False

Field type

bool Field

Copy vignette polygon to output and censor vignetted pixels? (Used for non-LSST flats).

doVignetteMask

Default

False

Field type

bool Field

Compute and attach a validPolygon and mask excluding the totally vignetted regions? (Used for LSST flats).

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.

flatSource

Default

'DOME'

Field type

str ChoiceField (optional)

Choices

'DOME'

Flat constructed from the dome screen with ‘white’ light.

'TWILIGHT'

Flat constructed from twilight images.

'PSEUDO'

Flat constructed from the instrument model.

'SKY'

Flat constructed from night-sky images.

None

Field is optional

Type of flat constructed. This config is only used if calibrationType==``flat``.

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

noGoodPixelsMask

Default

'BAD'

Field type

str Field

Mask bit to set when there are no good input pixels. See code comments for details.

saveLogOutput

Default

True

Field type

bool Field

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

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.