CalibCombineConfig#

class lsst.cp.pipe.CalibCombineConfig(*args, **kw)#

Bases: PipelineTaskConfig

Configuration for combining calib exposures.

Attributes Summary

`calibrationType`	Name of calibration to be generated.
`censorMaskPlanes`	Unset mask planes other than NO_DATA in output calibration? (`bool`, default `True`)
`checkNoData`	Check that the calibration does not have NO_DATA set? (`bool`, default `True`)
`clip`	Clipping threshold for combination (`float`, default `3.0`)
`combine`	Statistic name to use for combination (from `Property`) (`str`, default `'MEANCLIP'`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`distributionPercentiles`	Percentile levels to measure on the final combined calibration.
`doPartialVignetteMask`	Compute a PARTLY_VIGNETTED mask plane for partly vignetted regions? (Used for LSST flats).
`doVignette`	Copy vignette polygon to output and censor vignetted pixels? (Used for non-LSST flats).
`doVignetteMask`	Compute and attach a validPolygon and mask excluding the totally vignetted regions? (Used for LSST flats).
`exposureScaling`	Scaling to be applied to each input exposure.
`mask`	Mask planes to respect (`List`, default `['SAT', 'DETECTED', 'INTRP']`)
`maxVisitsToCalcErrorFromInputVariance`	Maximum number of visits to estimate variance from input variance, not per-pixel spread (`int`, default `5`)
`nIter`	Clipping iterations for combination (`int`, default `3`)
`noGoodPixelsMask`	Mask bit to set when there are no good input pixels.
`partialVignette`	Vignetting task, configured for partial vignetting.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`scalingLevel`	Region to scale.
`stats`	Background statistics configuration (`ConfigurableInstance`, default `<class 'lsst.cp.pipe.cpCombine.CalibStatsConfig'>`)
`subregionSize`	Width, height of subregion size.
`vignette`	Vignetting task.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

calibrationType#: Name of calibration to be generated. (str, default 'calibration')

censorMaskPlanes#: Unset mask planes other than NO_DATA in output calibration? (bool, default True)

checkNoData#: Check that the calibration does not have NO_DATA set? (bool, default True)

clip#: Clipping threshold for combination (float, default 3.0)

combine#: Statistic name to use for combination (from Property) (str, default 'MEANCLIP')

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

distributionPercentiles#: Percentile levels to measure on the final combined calibration. (List, default [0, 5, 16, 50, 84, 95, 100])

doPartialVignetteMask#: Compute a PARTLY_VIGNETTED mask plane for partly vignetted regions? (Used for LSST flats). (bool, default False)

doVignette#: Copy vignette polygon to output and censor vignetted pixels? (Used for non-LSST flats). (bool, default False)

doVignetteMask#: Compute and attach a validPolygon and mask excluding the totally vignetted regions? (Used for LSST flats). (bool, default False)

exposureScaling#

Scaling to be applied to each input exposure. (str, default 'Unity')

Allowed values:

'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

mask#: Mask planes to respect (List, default ['SAT', 'DETECTED', 'INTRP'])

maxVisitsToCalcErrorFromInputVariance#: Maximum number of visits to estimate variance from input variance, not per-pixel spread (int, default 5)

nIter#: Clipping iterations for combination (int, default 3)

noGoodPixelsMask#: Mask bit to set when there are no good input pixels. See code comments for details. (str, default 'BAD')

partialVignette#: Vignetting task, configured for partial vignetting. (ConfigurableInstance, default <class 'lsst.ip.isr.vignette.VignetteConfig'>)

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

scalingLevel#

Region to scale. (str, default 'DETECTOR')

Allowed values:

'DETECTOR': Scale by detector.
'AMP': Scale by amplifier.
'None': Field is optional

stats#: Background statistics configuration (ConfigurableInstance, default <class 'lsst.cp.pipe.cpCombine.CalibStatsConfig'>)

subregionSize#: Width, height of subregion size. (List, default (10000, 200))

vignette#: Vignetting task. (ConfigurableInstance, default <class 'lsst.ip.isr.vignette.VignetteConfig'>)

Methods Documentation

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.