lsst.ip.isr.masking.DECamEdgeBleedMaskConfig Class Reference

Inheritance diagram for lsst.ip.isr.masking.DECamEdgeBleedMaskConfig:

Public Member Functions
	validate (self)

Static Public Attributes
	satMinArea
	approachRows
	nSigma
	nRowsCheck
	nRowsCheckShort
	minUsablePixelsPerRow
	minLowFraction
	minLowFractionExtent
	minBlockedRows
	marginFraction
	saturatedMaskName

Detailed Description

Definition at line 62 of file masking.py.

Member Function Documentation

validate()

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.validate

(

self

)

Definition at line 125 of file masking.py.

Member Data Documentation

approachRows

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.approachRows

static

Initial value:

=  Field(
        dtype=int,
        doc=("A saturated footprint must come within this many rows of the read edge to trigger the "
             "edge bleed check."),
        default=20,
    )

Definition at line 68 of file masking.py.

marginFraction

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.marginFraction

static

Initial value:

=  Field(
        dtype=float,
        doc=("Extra rows masked beyond the measured height, as a fraction of that height "
             "(plus one row)."),
        default=0.125,
    )

Definition at line 113 of file masking.py.

minBlockedRows

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.minBlockedRows

static

Initial value:

=  Field(
        dtype=int,
        doc="Minimum number of blocked rows beyond the normal border at the read edge to be masked if found.",
        default=5,
    )

Definition at line 108 of file masking.py.

minLowFraction

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.minLowFraction

static

Initial value:

=  Field(
        dtype=float,
        doc=("Mean fraction of usable pixels that are low, over either nRowsCheck or nRowsCheckShort, "
             "to confirm a dip."),
        default=0.03,
    )

Definition at line 95 of file masking.py.

minLowFractionExtent

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.minLowFractionExtent

static

Initial value:

=  Field(
        dtype=float,
        doc=("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."),
        default=0.01,
    )

Definition at line 101 of file masking.py.

minUsablePixelsPerRow

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.minUsablePixelsPerRow

static

Initial value:

=  Field(
        dtype=int,
        doc=("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."),
        default=30,
    )

Definition at line 89 of file masking.py.

nRowsCheck

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.nRowsCheck

static

Initial value:

=  Field(
        dtype=int,
        doc="Number of rows from the read edge to check for an edge bleed dip.",
        default=20,
    )

Definition at line 79 of file masking.py.

nRowsCheckShort

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.nRowsCheckShort

static

Initial value:

=  Field(
        dtype=int,
        doc="A second, shorter window from the read edge to check for a short edge bleed dip.",
        default=5,
    )

Definition at line 84 of file masking.py.

nSigma

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.nSigma

static

Initial value:

=  Field(
        dtype=float,
        doc="A pixel is \"low\" if it is more than this many sigma below sky.",
        default=5.0,
    )

Definition at line 74 of file masking.py.

satMinArea

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.satMinArea

static

Initial value:

=  Field(
        dtype=int,
        doc="Minimum area (pixels) of a saturated footprint to be considered.",
        default=10000,
    )

Definition at line 63 of file masking.py.

saturatedMaskName

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.saturatedMaskName

static

Initial value:

=  Field(
        dtype=str,
        doc="Name of mask plane holding saturated pixels; must match the parent ISR task.",
        default="SAT",
    )

Definition at line 119 of file masking.py.

---

The documentation for this class was generated from the following file:

• python/lsst/ip/isr/masking.py