MergeDefectsCombinedTaskConfig

class lsst.cp.pipe.MergeDefectsCombinedTaskConfig(*args, **kw)

Bases: MergeDefectsTaskConfig

Configuration for merging defects from combined exposure.

Attributes Summary

assertSameRun	Ensure that all visits are from the same run? Raises if this is not the case, or if the run key isn't found.
combinationFraction	The fraction (0..1) of visits in which a pixel was found to be defective across the visit list in order to be marked as a defect.
combinationMode	Which types of defects to identify (str, default 'FRACTION')
connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
doManualDefects	Apply manual defects? (bool, default False)
edgesAsDefects	Mark all edge pixels, as defined by nPixBorder[UpDown, LeftRight], as defects.
ignoreFilters	Set the filters used in the CALIB_ID to NONE regardless of the filters on the input images.
nPixBorderLeftRight	Number of pixels on left & right of image to mask as defects if edgesAsDefects is True.
nPixBorderUpDown	Number of pixels on top & bottom of image to mask as defects if edgesAsDefects is True.
nullFilterName	The name of the null filter if ignoreFilters is True.
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

assertSameRun

Ensure that all visits are from the same run? Raises if this is not the case, or if the run key isn’t found. (bool, default False)

combinationFraction

The fraction (0..1) of visits in which a pixel was found to be defective across the visit list in order to be marked as a defect. Note, upper bound is exclusive, so use mode AND to require pixel to appear in all images. (float, default 0.7)

Valid Range = [0,1)

combinationMode

Which types of defects to identify (str, default 'FRACTION')

Allowed values:

'AND'

Logical AND the pixels found in each visit to form set

'OR'

Logical OR the pixels found in each visit to form set

'FRACTION'

Use pixels found in more than config.combinationFraction of visits

'None'

Field is optional

connections: pexConfig.ConfigField

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

doManualDefects

Apply manual defects? (bool, default False)

edgesAsDefects

Mark all edge pixels, as defined by nPixBorder[UpDown, LeftRight], as defects. (bool, default False)

ignoreFilters

Set the filters used in the CALIB_ID to NONE regardless of the filters on the input images. Allows mixing of filters in the input flats. Set to False if you think your defects might be chromatic and want to have registry support for varying defects with respect to filter. (bool, default True)

nPixBorderLeftRight

Number of pixels on left & right of image to mask as defects if edgesAsDefects is True. (int, default 5)

nPixBorderUpDown

Number of pixels on top & bottom of image to mask as defects if edgesAsDefects is True. (int, default 5)

nullFilterName

The name of the null filter if ignoreFilters is True. Usually something like NONE or EMPTY (str, default 'NONE')

saveLogOutput

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

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.