OverscanDetectorConfig#

class lsst.ip.isr.OverscanDetectorConfig(*args, **kw)#

Overscan configurations applicable to multiple amplifiers in a single detector.

Attributes Summary

`ampRules`	Amplifier level rules for overscan, keyed by amp name.
`defaultAmpConfig`	Default configuration for amplifiers.
`doAnyParallelOverscan`	Check if any of the amp configs have doParallelOverscan.
`doAnySerialOverscan`	Check if any of the amp configs have doSerialOverscan.
`integerDitherMode`	Dithering mode to cancel integerization of counts.
`itlDipBackgroundFraction`	Fraction of background (scaled by width) that is in the center of the dip.
`itlDipMaxColsPerImage`	Maximum number of columns detected as `dip` columns before dip masking is disabled on the image.
`itlDipMaxWidth`	Maximum number of columns to use for a dip mask.
`itlDipMinBackgroundNoiseFraction`	Only max model dip depth greater than this fraction of the approximate background noise will be masked.
`itlDipMinHeight`	Minimum height for a saturated footprint column to contribute to a dip.
`itlDipMinWidth`	Minimum number of columns in a saturated footprint with idlDipMinHeight to contribute to a dip.
`itlDipWidthScale`	Scaling factor to widen saturated core for dip masking.
`md5`	Compute the MD5 hash of this config (detector + amps).

Methods Summary

Get the OverscanAmpConfig for a specific amplifier.

Attributes Documentation

ampRules#: Amplifier level rules for overscan, keyed by amp name. (ConfigDict, default {})

defaultAmpConfig#: Default configuration for amplifiers. (OverscanAmpConfig, default <class 'lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig'>)

doAnyParallelOverscan#: Check if any of the amp configs have doParallelOverscan.

Returns#

doAnyParallelOverscan : bool

doAnySerialOverscan#: Check if any of the amp configs have doSerialOverscan.

Returns#

doAnySerialOverscan : bool

integerDitherMode#

Dithering mode to cancel integerization of counts. (str, default 'SYMMETRIC')

Allowed values:

'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.
'None': Field is optional

itlDipBackgroundFraction#: 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. (float, default 0.0)

itlDipMaxColsPerImage#: Maximum number of columns detected as dip columns before dip masking is disabled on the image. (int, default 500)

itlDipMaxWidth#: Maximum number of columns to use for a dip mask. (int, default 50)

itlDipMinBackgroundNoiseFraction#: Only max model dip depth greater than this fraction of the approximate background noise will be masked. (float, default 0.5)

itlDipMinHeight#: Minimum height for a saturated footprint column to contribute to a dip. (int, default 50)

itlDipMinWidth#: Minimum number of columns in a saturated footprint with idlDipMinHeight to contribute to a dip. (int, default 15)

itlDipWidthScale#: Scaling factor to widen saturated core for dip masking. (float, default 1.5)

md5#

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

This can be used to ensure overscan configs are consistent.

Returns#

md5Hash : str

Methods Documentation

getOverscanAmpConfig(amplifier)#: Get the OverscanAmpConfig for a specific amplifier.

Parameters#

amplifier : lsst.afw.cameraGeom.Amplifier

Returns#

overscanAmpConfig : lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig