lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig Class Reference

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

Public Member Functions
	doAnySerialOverscan (self)
	doAnyParallelOverscan (self)
	getOverscanDetectorConfig (self, detector)

Static Public Attributes
	detectorRules
	defaultDetectorConfig
	detectorRuleKeyType

Detailed Description

Overscan configurations applicable to multiple detectors in
a single camera.

Definition at line 246 of file overscanAmpConfig.py.

Member Function Documentation

doAnyParallelOverscan()

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.doAnyParallelOverscan

(

self

)

Check if any of the detector/amp configs have
doParallelOverscan.

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

Definition at line 289 of file overscanAmpConfig.py.

doAnySerialOverscan()

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.doAnySerialOverscan

(

self

)

Check if any of the detector/amp configs have doSerialOverscan.

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

Definition at line 272 of file overscanAmpConfig.py.

getOverscanDetectorConfig()

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.getOverscanDetectorConfig	(		self,
			detector )

Get the OverscanDetectorConfig for a specific detector.

Parameters
----------
detector : `lsst.afw.cameraGeom.Detector`

Returns
-------
overscanDetectorConfig : `OverscanDetectorConfig`

Definition at line 307 of file overscanAmpConfig.py.

Member Data Documentation

defaultDetectorConfig

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.defaultDetectorConfig

static

Initial value:

=  pexConfig.ConfigField(
        dtype=OverscanDetectorConfig,
        doc="Default configuration for detectors.",
    )

Definition at line 256 of file overscanAmpConfig.py.

detectorRuleKeyType

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.detectorRuleKeyType

static

Initial value:

=  pexConfig.ChoiceField(
        doc="Detector rule key type.",
        dtype=str,
        default="NAME",
        allowed={
            "NAME": "DetectorRules has a key that is the detector name.",
            "SERIAL": "DetectorRules has a key that is the detector serial number.",
            "ID": "DetectorRules has a key that is the detector id number.",
        },
    )

Definition at line 260 of file overscanAmpConfig.py.

detectorRules

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.detectorRules

static

Initial value:

=  pexConfig.ConfigDictField(
        doc="Detector level rules for overscan",
        keytype=str,
        itemtype=OverscanDetectorConfig,
        default={},
    )

Definition at line 250 of file overscanAmpConfig.py.

---

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

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