DECamEdgeBleedMaskConfig#

class lsst.ip.isr.DECamEdgeBleedMaskConfig(*args, **kw)#

Bases: Config

Attributes Summary

approachRows

Saturated footprint must come within this many rows of the read edge.

marginFraction

Extra rows masked beyond the measured edge bleed height, as a fraction of that height (plus one row).

minLowPixelsExtent

Depressed pixels a row must have (more than this) to count toward the edge bleed height.

minLowPixelsPerRow

Mean depressed pixels per row over the check rows required (exceeded) to confirm an edge bleed.

nRowsCheck

Number of rows from the read edge used to confirm an edge bleed.

nSigma

A pixel is counted as depressed if it is below sky by more than this many sigma.

satMaxArea

Maximum area (pixels, exclusive) of a saturated footprint to be an edge bleed candidate.

satMinArea

Minimum area (pixels) of a saturated footprint to be an edge bleed candidate.

saturatedMaskName

Name of mask plane holding saturated pixels; must match the parent ISR task.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

approachRows#

Saturated footprint must come within this many rows of the read edge. (int, default 20)

marginFraction#

Extra rows masked beyond the measured edge bleed height, as a fraction of that height (plus one row). (float, default 0.125)

minLowPixelsExtent#

Depressed pixels a row must have (more than this) to count toward the edge bleed height. Should be smaller than minLowPixelsPerRow. (int, default 10)

minLowPixelsPerRow#

Mean depressed pixels per row over the check rows required (exceeded) to confirm an edge bleed. Read-edge rows with fewer usable pixels than this are skipped before the check rows start. (int, default 30)

nRowsCheck#

Number of rows from the read edge used to confirm an edge bleed. (int, default 20)

nSigma#

A pixel is counted as depressed if it is below sky by more than this many sigma. (float, default 5.0)

satMaxArea#

Maximum area (pixels, exclusive) of a saturated footprint to be an edge bleed candidate. (int, default 100000)

satMinArea#

Minimum area (pixels) of a saturated footprint to be an edge bleed candidate. (int, default 10000)

saturatedMaskName#

Name of mask plane holding saturated pixels; must match the parent ISR task. (str, default 'SAT')

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.