lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase Class Reference

Inheritance diagram for lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase:

Static Public Attributes
	fitType
	order
	numSigmaClip
	maskPlanes
	overscanIsInt
	maxDeviation
	doAbsoluteMaxDeviation

Detailed Description

Overscan correction options.

Definition at line 40 of file overscan.py.

Member Data Documentation

doAbsoluteMaxDeviation

lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase.doAbsoluteMaxDeviation

static

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.

fitType

lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase.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",
            "MEAN_PER_ROW": "Correct using the mean per row of the overscan region",
        },
    )

Definition at line 43 of file overscan.py.

maskPlanes

lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase.maskPlanes

static

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

lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase.maxDeviation

static

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.

numSigmaClip

lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase.numSigmaClip

static

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

lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase.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 61 of file overscan.py.

overscanIsInt

lsst.ip.isr.overscan.OverscanCorrectionTaskConfigBase.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 77 of file overscan.py.

---

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

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