lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig Class Reference

Inheritance diagram for lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig:

Public Member Functions
	setDefaults (self)

Static Public Attributes
	doSerialOverscan
	serialOverscanConfig
	doParallelOverscanCrosstalk
	doParallelOverscan
	parallelOverscanConfig
	saturation
	suspectLevel
	gain

Protected Member Functions
	_stringForHash (self)

Detailed Description

Overscan configurations applicable to a single amplifier.

Definition at line 14 of file overscanAmpConfig.py.

Member Function Documentation

_stringForHash()

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig._stringForHash ( self )

protected

Turn this config into a simple string for hashing.

Only essential data for tracking is returned.

Returns
-------
stringForHash : `str`

Definition at line 76 of file overscanAmpConfig.py.

setDefaults()

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.setDefaults

(

self

)

Definition at line 60 of file overscanAmpConfig.py.

Member Data Documentation

doParallelOverscan

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.doParallelOverscan

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Do parallel overscan subtraction?",
        default=True,
    )

Definition at line 32 of file overscanAmpConfig.py.

doParallelOverscanCrosstalk

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.doParallelOverscanCrosstalk

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Apply crosstalk correction in parallel overscan region?",
        default=True,
        deprecated="This field is no longer used, and will be removed after v29.",
    )

Definition at line 26 of file overscanAmpConfig.py.

doSerialOverscan

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.doSerialOverscan

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Do serial overscan subtraction?",
        default=True,
    )

Definition at line 16 of file overscanAmpConfig.py.

gain

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.gain

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="The gain to use to override any calibration product value (ignored if NaN). "
            "Units are e-/ADU.",
        default=float("NaN"),
    )

Definition at line 53 of file overscanAmpConfig.py.

parallelOverscanConfig

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.parallelOverscanConfig

static

Initial value:

=  pexConfig.ConfigField(
        dtype=ParallelOverscanCorrectionTaskConfig,
        doc="Parallel overscan configuration.",
    )

Definition at line 37 of file overscanAmpConfig.py.

saturation

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.saturation

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="The saturation level to use to override any detector/calibration product value "
            "(ignored if NaN). Units are ADU.",
        default=float("NaN"),
    )

Definition at line 41 of file overscanAmpConfig.py.

serialOverscanConfig

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.serialOverscanConfig

static

Initial value:

=  pexConfig.ConfigField(
        dtype=SerialOverscanCorrectionTaskConfig,
        doc="Serial overscan configuration.",
    )

Definition at line 21 of file overscanAmpConfig.py.

suspectLevel

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.suspectLevel

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="The ``suspect`` level to use to override any detector/calibration product value "
            "(ignored if NaN). Units are ADU.",
        default=float("NaN"),
    )

Definition at line 47 of file overscanAmpConfig.py.

---

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

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