DECamEdgeBleedMaskConfig#

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

Bases: Config

Attributes Summary

`approachRows`	A saturated footprint must come within this many rows of the read edge to trigger the edge bleed check.
`marginFraction`	Extra rows masked beyond the measured height, as a fraction of that height (plus one row).
`minBlockedRows`	Minimum number of blocked rows beyond the normal border at the read edge to be masked if found.
`minLowFraction`	Mean fraction of usable pixels that are low, over either nRowsCheck or nRowsCheckShort, to confirm a dip.
`minLowFractionExtent`	Fraction of usable pixels that are low that each row must exceed to count toward the bleed height; the scan stops after five consecutive rows that do not.
`minUsablePixelsPerRow`	Minimum number of pixels not saturated, bad or missing to search for dips.
`nRowsCheck`	Number of rows from the read edge to check for an edge bleed dip.
`nRowsCheckShort`	A second, shorter window from the read edge to check for a short edge bleed dip.
`nSigma`	A pixel is "low" if it is more than this many sigma below sky.
`satMinArea`	Minimum area (pixels) of a saturated footprint to be considered.
`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#: A saturated footprint must come within this many rows of the read edge to trigger the edge bleed check. (int, default 20)

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

minBlockedRows#: Minimum number of blocked rows beyond the normal border at the read edge to be masked if found. (int, default 5)

minLowFraction#: Mean fraction of usable pixels that are low, over either nRowsCheck or nRowsCheckShort, to confirm a dip. (float, default 0.03)

minLowFractionExtent#: Fraction of usable pixels that are low that each row must exceed to count toward the bleed height; the scan stops after five consecutive rows that do not. Should not exceed minLowFraction. (float, default 0.01)

minUsablePixelsPerRow#: Minimum number of pixels not saturated, bad or missing to search for dips. Rows with fewer pixels may be “blocked” due to a drained register. (int, default 30)

nRowsCheck#: Number of rows from the read edge to check for an edge bleed dip. (int, default 20)

nRowsCheckShort#: A second, shorter window from the read edge to check for a short edge bleed dip. (int, default 5)

nSigma#: A pixel is “low” if it is more than this many sigma below sky. (float, default 5.0)

satMinArea#: Minimum area (pixels) of a saturated footprint to be considered. (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.