lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig Class Reference

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

Public Member Functions
	doAnySerialOverscan (self)
	doAnyParallelOverscan (self)
	getOverscanAmpConfig (self, amplifier)
	md5 (self)

Static Public Attributes
	ampRules
	defaultAmpConfig
	integerDitherMode
	itlDipMinHeight
	itlDipMinWidth
	itlDipMaxWidth
	itlDipWidthScale
	itlDipBackgroundFraction
	itlDipMinBackgroundNoiseFraction
	itlDipMaxColsPerImage

Protected Member Functions
	_stringForHash (self)

Detailed Description

Overscan configurations applicable to multiple amplifiers in
a single detector.

Definition at line 92 of file overscanAmpConfig.py.

Member Function Documentation

_stringForHash()

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

protected

Turn this config into a simple string for hashing.

Only the default and amps that are different than the
default are used in the string representation.

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

Definition at line 213 of file overscanAmpConfig.py.

doAnyParallelOverscan()

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.doAnyParallelOverscan

(

self

)

Check if any of the amp configs have doParallelOverscan.

Returns
-------
doAnyParallelOverscan : `bool`

Definition at line 176 of file overscanAmpConfig.py.

doAnySerialOverscan()

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.doAnySerialOverscan

(

self

)

Check if any of the amp configs have doSerialOverscan.

Returns
-------
doAnySerialOverscan : `bool`

Definition at line 159 of file overscanAmpConfig.py.

getOverscanAmpConfig()

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.getOverscanAmpConfig	(		self,
			amplifier )

Get the OverscanAmpConfig for a specific amplifier.

Parameters
----------
amplifier : `lsst.afw.cameraGeom.Amplifier`

Returns
-------
overscanAmpConfig : `lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig`

Definition at line 192 of file overscanAmpConfig.py.

md5()

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.md5

(

self

)

Compute the MD5 hash of this config (detector + amps).

This can be used to ensure overscan configs are consistent.

Returns
-------
md5Hash : `str`

Definition at line 234 of file overscanAmpConfig.py.

Member Data Documentation

ampRules

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.ampRules

static

Initial value:

=  pexConfig.ConfigDictField(
        doc="Amplifier level rules for overscan, keyed by amp name.",
        keytype=str,
        itemtype=OverscanAmpConfig,
        default={},
    )

Definition at line 96 of file overscanAmpConfig.py.

defaultAmpConfig

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.defaultAmpConfig

static

Initial value:

=  pexConfig.ConfigField(
        dtype=OverscanAmpConfig,
        doc="Default configuration for amplifiers.",
    )

Definition at line 102 of file overscanAmpConfig.py.

integerDitherMode

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.integerDitherMode

static

Initial value:

=  pexConfig.ChoiceField(
        dtype=str,
        doc="Dithering mode to cancel integerization of counts.",
        default="SYMMETRIC",
        allowed={
            "POSITIVE": "Dithering is done with a uniform random in the range [0, 1).",
            "NEGATIVE": "Dithering is done with a uniform random in the range [-1, 0).",
            "SYMMETRIC": "Dithering is done with a uniform random in the range [-0.5, 0.5).",
            "NONE": "No dithering is performed.",
        },
    )

Definition at line 106 of file overscanAmpConfig.py.

itlDipBackgroundFraction

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.itlDipBackgroundFraction

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Fraction of background (scaled by width) that is in the center of the dip. "
            "Only dips that are greater than itlDipMinSkyNoiseFraction will be masked. "
            "If equal to 0.0, dip masking will be skipped.",
        default=0.0,
    )

Definition at line 138 of file overscanAmpConfig.py.

itlDipMaxColsPerImage

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.itlDipMaxColsPerImage

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Maximum number of columns detected as ``dip`` columns before dip masking "
            "is disabled on the image.",
        default=500,
    )

Definition at line 151 of file overscanAmpConfig.py.

itlDipMaxWidth

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.itlDipMaxWidth

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Maximum number of columns to use for a dip mask.",
        default=50,
    )

Definition at line 128 of file overscanAmpConfig.py.

itlDipMinBackgroundNoiseFraction

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.itlDipMinBackgroundNoiseFraction

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Only max model dip depth greater than this fraction of the approximate "
            "background noise will be masked.",
        default=0.5,
    )

Definition at line 145 of file overscanAmpConfig.py.

itlDipMinHeight

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.itlDipMinHeight

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Minimum height for a saturated footprint column to contribute to a dip.",
        default=50,
    )

Definition at line 117 of file overscanAmpConfig.py.

itlDipMinWidth

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.itlDipMinWidth

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Minimum number of columns in a saturated footprint with idlDipMinHeight "
            "to contribute to a dip.",
        default=15,
    )

Definition at line 122 of file overscanAmpConfig.py.

itlDipWidthScale

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.itlDipWidthScale

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Scaling factor to widen saturated core for dip masking.",
        default=1.5,
    )

Definition at line 133 of file overscanAmpConfig.py.

---

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

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