lsst.ip.isr.overscan.ParallelOverscanCorrectionTaskConfig Class Reference
Inheritance diagram for lsst.ip.isr.overscan.ParallelOverscanCorrectionTaskConfig:
Public Member Functions | |
| setDefaults (self) | |
Detailed Description
Definition at line 1338 of file overscan.py.
Member Function Documentation
◆ setDefaults()
| lsst.ip.isr.overscan.ParallelOverscanCorrectionTaskConfig.setDefaults | ( | self | ) |
Definition at line 1418 of file overscan.py.
Member Data Documentation
◆ doAbsoluteMaxDeviation
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply the maxDeviation to the absolute value of the deviation? If "
"False, this will be a one-sided cut for positive-only deviations "
"(typically for parallel overscan subtraction.",
default=True,
)
Definition at line 89 of file overscan.py.
◆ doMedianSmoothingOutlierRejection
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do column-by-column median smoothing outlier rejection? Columns that are rejected "
"in this way will be grown by parallelOverscanMaskedColumnGrowSize.",
default=True,
)
Definition at line 1398 of file overscan.py.
◆ doParallelOverscanSaturation
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask saturated pixels in parallel overscan region?",
default=True,
)
Definition at line 1339 of file overscan.py.
◆ fitType
|
staticinherited |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="The method for fitting the overscan bias level.",
default='MEDIAN',
allowed={
"POLY": "Fit ordinary polynomial to the longest axis of the overscan region",
"CHEB": "Fit Chebyshev polynomial to the longest axis of the overscan region",
"LEG": "Fit Legendre polynomial to the longest axis of the overscan region",
"NATURAL_SPLINE": "Fit natural spline to the longest axis of the overscan region",
"CUBIC_SPLINE": "Fit cubic spline to the longest axis of the overscan region",
"AKIMA_SPLINE": "Fit Akima spline to the longest axis of the overscan region",
"MEAN": "Correct using the mean of the overscan region",
"MEANCLIP": "Correct using a clipped mean of the overscan region",
"MEDIAN": "Correct using the median of the overscan region",
"MEDIAN_PER_ROW": "Correct using the median per row of the overscan region",
"MEAN_PER_ROW": "Correct using the mean per row of the overscan region",
},
)
Definition at line 43 of file overscan.py.
◆ leadingToSkip
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of leading values to skip in parallel overscan correction.",
default=0,
)
Definition at line 1372 of file overscan.py.
◆ maskPlanes
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=str,
doc="Mask planes to reject when measuring overscan",
default=['BAD', 'SAT'],
)
Definition at line 72 of file overscan.py.
◆ maxDeviation
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum deviation from median (in ADU) to mask in overscan correction; "
"Will be applied to the absolute deviation if doAbsoluteMaxDeviation=True.",
default=1000.0, check=lambda x: x > 0,
)
Definition at line 83 of file overscan.py.
◆ medianSmoothingKernel
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Kernel (pixels) to use to smooth the parallel overscan columns. Must be odd.",
default=5,
check=lambda x: x // 2 != x / 2,
)
Definition at line 1404 of file overscan.py.
◆ medianSmoothingOutlierThreshold
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Outlier threshold after parallel median smoothing (adu). This is applied only "
"to positive outliers.",
default=5.0,
check=lambda x: x > 0.0,
)
Definition at line 1410 of file overscan.py.
◆ numSigmaClip
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Rejection threshold (sigma) for collapsing overscan before fit",
default=3.0,
)
Definition at line 67 of file overscan.py.
◆ order
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
doc=("Order of polynomial to fit if overscan fit type is a polynomial, "
"or number of spline knots if overscan fit type is a spline."),
default=1,
)
Definition at line 61 of file overscan.py.
◆ overscanIsInt
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Treat overscan as an integer image for purposes of fitType=MEDIAN"
" and fitType=MEDIAN_PER_ROW.",
default=True,
)
Definition at line 77 of file overscan.py.
◆ parallelOverscanFraction
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="When the parallel overscan region median is greater than parallelOverscanFraction "
"and the imaging region median is greater than parallelOverscanImageThreshold "
"then parallel overscan subtraction will be turned off, as this is usually "
"due to the region being flooded with spillover from a super-saturated flat.",
default=0.5,
)
Definition at line 1382 of file overscan.py.
◆ parallelOverscanImageThreshold
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="When the parallel overscan region median is greater than parallelOverscanFraction "
"and the imaging region median is greater than parallelOverscanImageThreshold "
"then parallel overscan subtraction will be turned off, as this is usually "
"due to the region being flooded with spillover from a super-saturated flat.",
default=10000.0,
)
Definition at line 1390 of file overscan.py.
◆ parallelOverscanMaskedColumnGrowSize
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="When a full column is masked in the parallel overscan (at less "
"than saturation) the mask should be grown by this many pixels. "
"This value is determined from ITL chips in LATISS and LSSTCam.",
default=2,
)
Definition at line 1365 of file overscan.py.
◆ parallelOverscanMaskGrowSize
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Grow the SAT mask in the parallel overscan region by this many pixels. "
"This value was determined from the ITL chip in the LATISS camera.",
default=7,
)
Definition at line 1359 of file overscan.py.
◆ parallelOverscanSaturationLevel
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="The saturation level (adu) to use if not specified in call to "
"maskParallelOverscanAmp. This should be low enough to capture "
"all possible amplifiers for defect detection.",
default=20000.,
)
Definition at line 1344 of file overscan.py.
◆ parallelOverscanSaturationLevelAdjustmentFactor
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="The parallel overscan saturation level may be below that of "
"the data region. This factor is applied to the amplifier "
"saturation value when evaluating saturation in the parallel "
"overscan region.",
default=0.75,
)
Definition at line 1351 of file overscan.py.
◆ trailingToSkip
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of trailing values to skip in parallel overscan correction.",
default=0,
)
Definition at line 1377 of file overscan.py.
The documentation for this class was generated from the following file:
- python/lsst/ip/isr/overscan.py
Generated on Thu Apr 30 2026 09:00:42 for lsst.ip.isr by
1.13.2