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

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 51 of file overscanAmpConfig.py.

    def _stringForHash(self):
        """Turn this config into a simple string for hashing.
 
        Only essential data for tracking is returned.
 
        Returns
        -------
        stringForHash : `str`
        """
        stringForHash = (f"doSerial={self.doSerialOverscan} "
                         f"serialFitType={self.serialOverscanConfig.fitType} "
                         f"doParallelCrosstalk={self.doParallelOverscanCrosstalk} "
                         f"doParallel={self.doParallelOverscan} "
                         f"parallelFitType={self.parallelOverscanConfig.fitType}")
        return stringForHash
 
 

setDefaults()

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.setDefaults

(

self

)

Definition at line 40 of file overscanAmpConfig.py.

    def setDefaults(self):
        super().setDefaults()
 
        self.serialOverscanConfig.fitType = "MEDIAN_PER_ROW"
        self.serialOverscanConfig.leadingToSkip = 3
        self.serialOverscanConfig.trailingToSkip = 3
        self.parallelOverscanConfig.fitType = "MEDIAN_PER_ROW"
        self.parallelOverscanConfig.leadingToSkip = 3
        self.parallelOverscanConfig.trailingToSkip = 3
 

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 30 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,
    )

Definition at line 25 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.

parallelOverscanConfig

lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig.parallelOverscanConfig

static

Initial value:

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

Definition at line 35 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.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+21ad69e7e1/python/lsst/ip/isr/overscanAmpConfig.py