lsst.ip.isr g28faec7dd2+abea79d9cf
Loading...
Searching...
No Matches
lsst.ip.isr.masking.DECamEdgeBleedMaskConfig Class Reference
Inheritance diagram for lsst.ip.isr.masking.DECamEdgeBleedMaskConfig:

Public Member Functions

 validate (self)

Static Public Attributes

 satMinArea
 satMaxArea
 approachRows
 nSigma
 nRowsCheck
 minLowPixelsPerRow
 minLowPixelsExtent
 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 113 of file masking.py.

Member Data Documentation

◆ approachRows

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.approachRows
static
Initial value:
= Field(
dtype=int,
doc="Saturated footprint must come within this many rows of the read edge.",
default=20,
)

Definition at line 73 of file masking.py.

◆ marginFraction

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.marginFraction
static
Initial value:
= Field(
dtype=float,
doc=("Extra rows masked beyond the measured edge bleed height, as a fraction of that height "
"(plus one row)."),
default=0.125,
)

Definition at line 101 of file masking.py.

◆ minLowPixelsExtent

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.minLowPixelsExtent
static
Initial value:
= Field(
dtype=int,
doc=("Depressed pixels a row must have (more than this) to count toward the edge bleed "
"height. Should be smaller than minLowPixelsPerRow."),
default=10,
)

Definition at line 95 of file masking.py.

◆ minLowPixelsPerRow

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.minLowPixelsPerRow
static
Initial value:
= Field(
dtype=int,
doc=("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."),
default=30,
)

Definition at line 88 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 used to confirm an edge bleed.",
default=20,
)

Definition at line 83 of file masking.py.

◆ nSigma

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.nSigma
static
Initial value:
= Field(
dtype=float,
doc="A pixel is counted as depressed if it is below sky by more than this many sigma.",
default=5.0,
)

Definition at line 78 of file masking.py.

◆ satMaxArea

lsst.ip.isr.masking.DECamEdgeBleedMaskConfig.satMaxArea
static
Initial value:
= Field(
dtype=int,
doc="Maximum area (pixels, exclusive) of a saturated footprint to be an edge bleed candidate.",
default=100000,
)

Definition at line 68 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 an edge bleed candidate.",
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 107 of file masking.py.


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