lsst.ip.isr  22.0.0-12-ga88477b+898e48ea30
Static Public Attributes | List of all members
lsst.ip.isr.overscan.OverscanCorrectionTaskConfig Class Reference
Inheritance diagram for lsst.ip.isr.overscan.OverscanCorrectionTaskConfig:

Static Public Attributes

 fitType
 
 order
 
 numSigmaClip
 
 maskPlanes
 
 overscanIsInt
 

Detailed Description

Overscan correction options.

Definition at line 31 of file overscan.py.

Member Data Documentation

◆ fitType

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.fitType
static
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",
},
)

Definition at line 34 of file overscan.py.

◆ maskPlanes

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.maskPlanes
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="Mask planes to reject when measuring overscan",
default=['SAT'],
)

Definition at line 62 of file overscan.py.

◆ numSigmaClip

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.numSigmaClip
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Rejection threshold (sigma) for collapsing overscan before fit",
default=3.0,
)

Definition at line 57 of file overscan.py.

◆ order

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.order
static
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 51 of file overscan.py.

◆ overscanIsInt

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.overscanIsInt
static
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 67 of file overscan.py.


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