lsst.ip.isr g4205f5f34a+4f2d74446d
Loading...
Searching...
No Matches
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
 
 doParallelOverscan
 
 parallelOverscanMaskThreshold
 
 parallelOverscanMaskGrowSize
 
 leadingColumnsToSkip
 
 trailingColumnsToSkip
 
 leadingRowsToSkip
 
 trailingRowsToSkip
 
 maxDeviation
 

Detailed Description

Overscan correction options.

Definition at line 35 of file overscan.py.

Member Data Documentation

◆ doParallelOverscan

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.doParallelOverscan
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Correct using parallel overscan after serial overscan correction?",
default=False,
)

Definition at line 78 of file overscan.py.

◆ 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 38 of file overscan.py.

◆ leadingColumnsToSkip

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.leadingColumnsToSkip
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of leading columns to skip in serial overscan correction.",
default=0,
)

Definition at line 96 of file overscan.py.

◆ leadingRowsToSkip

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.leadingRowsToSkip
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of leading rows to skip in parallel overscan correction.",
default=0,
)

Definition at line 106 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=['BAD', 'SAT'],
)

Definition at line 66 of file overscan.py.

◆ maxDeviation

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.maxDeviation
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum deviation from median (in ADU) to mask in overscan correction.",
default=1000.0, check=lambda x: x > 0,
)

Definition at line 117 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 61 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 55 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 71 of file overscan.py.

◆ parallelOverscanMaskGrowSize

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.parallelOverscanMaskGrowSize
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Masks created from saturated bleeds should be grown by this many "
"pixels during construction of the parallel overscan mask. "
"This value determined from the ITL chip in the LATISS camera",
default=7,
)

Definition at line 88 of file overscan.py.

◆ parallelOverscanMaskThreshold

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.parallelOverscanMaskThreshold
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Threshold above which pixels in the parallel overscan are masked as bleeds.",
default=100000,
)

Definition at line 83 of file overscan.py.

◆ trailingColumnsToSkip

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.trailingColumnsToSkip
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of trailing columns to skip in serial overscan correction.",
default=0,
)

Definition at line 101 of file overscan.py.

◆ trailingRowsToSkip

lsst.ip.isr.overscan.OverscanCorrectionTaskConfig.trailingRowsToSkip
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of trailing rows to skip in parallel overscan correction.",
default=0,
)

Definition at line 111 of file overscan.py.


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