lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig Class Reference

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

Public Member Functions
	doAnySerialOverscan (self)
	doAnyParallelOverscan (self)
	doAnyParallelOverscanCrosstalk (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 188 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 231 of file overscanAmpConfig.py.

    def doAnyParallelOverscan(self):
        """Check if any of the detector/amp configs have
        doParallelOverscan.
 
        Returns
        -------
        doAnyParallelOverscan : `bool`
        """
 
        if self.defaultDetectorConfig.doAnyParallelOverscan:
            return True
 
        for _, detectorRule in self.detectorRules.items():
            if detectorRule.doAnyParallelOverscan:
                return True
 
        return False
 

doAnyParallelOverscanCrosstalk()

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.doAnyParallelOverscanCrosstalk

(

self

)

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

Returns
-------
doAnyParallelOverscanCrosstalk : `bool`

Definition at line 250 of file overscanAmpConfig.py.

    def doAnyParallelOverscanCrosstalk(self):
        """Check if any of the detector/amp configs have
        doParallelOverscanCrosstalk.
 
        Returns
        -------
        doAnyParallelOverscanCrosstalk : `bool`
        """
 
        if self.defaultDetectorConfig.doAnyParallelOverscanCrosstalk:
            return True
 
        for _, detectorRule in self.detectorRules.items():
            if detectorRule.doAnyParallelOverscanCrosstalk:
                return True
 
        return False
 

doAnySerialOverscan()

lsst.ip.isr.overscanAmpConfig.OverscanCameraConfig.doAnySerialOverscan

(

self

)

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

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

Definition at line 214 of file overscanAmpConfig.py.

    def doAnySerialOverscan(self):
        """Check if any of the detector/amp configs have doSerialOverscan.
 
        Returns
        -------
        doAnySerialOverscan : `bool`
        """
        if self.defaultDetectorConfig.doAnySerialOverscan:
            return True
 
        for _, detectorRule in self.detectorRules.items():
            if detectorRule.doAnySerialOverscan:
                return True
 
        return False
 

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

    def getOverscanDetectorConfig(self, detector):
        """Get the OverscanDetectorConfig for a specific detector.
 
        Parameters
        ----------
        detector : `lsst.afw.cameraGeom.Detector`
 
        Returns
        -------
        overscanDetectorConfig : `OverscanDetectorConfig`
        """
        match self.detectorRuleKeyType:
            case "NAME":
                key = detector.getName()
            case "SERIAL":
                key = detector.getSerial()
            case "ID":
                key = str(detector.getId())
 
        if key in self.detectorRules.keys():
            overscanDetectorConfig = self.detectorRules[key]
        else:
            overscanDetectorConfig = self.defaultDetectorConfig
 
        return overscanDetectorConfig

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 198 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 202 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 192 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