lsst.ip.isr gdc0c513512+9ee1ab4172
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig Class Reference
Inheritance diagram for lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig:

Public Member Functions

 doAnySerialOverscan (self)
 
 doAnyParallelOverscan (self)
 
 doAnyParallelOverscanCrosstalk (self)
 
 getOverscanAmpConfig (self, amplifier)
 
 md5 (self)
 

Static Public Attributes

 ampRules
 
 defaultAmpConfig
 

Protected Member Functions

 _stringForHash (self)
 

Detailed Description

Overscan configurations applicable to multiple amplifiers in
a single detector.

Definition at line 68 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 155 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 101 of file overscanAmpConfig.py.

◆ doAnyParallelOverscanCrosstalk()

lsst.ip.isr.overscanAmpConfig.OverscanDetectorConfig.doAnyParallelOverscanCrosstalk ( self)
Check if any of the amp configs have doParallelOverscanCrosstalk.

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

Definition at line 118 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 84 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 134 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 176 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 72 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 78 of file overscanAmpConfig.py.


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