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()
|
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.
155 def _stringForHash(self):
156 """Turn this config into a simple string for hashing.
157
158 Only the default and amps that are different than the
159 default are used in the string representation.
160
161 Returns
162 -------
163 stringForHash : `str`
164 """
165 defaultString = self.defaultAmpConfig._stringForHash
166
167 stringForHash = f"default: {defaultString}"
168 for ampName in self.ampRules:
169 ampString = self.ampRules[ampName]._stringForHash
170 if ampString != defaultString:
171 stringForHash += f" {ampName}: {ampString}"
172
173 return stringForHash
174
◆ 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.
101 def doAnyParallelOverscan(self):
102 """Check if any of the amp configs have doParallelOverscan.
103
104 Returns
105 -------
106 doAnyParallelOverscan : `bool`
107 """
108 if self.defaultAmpConfig.doParallelOverscan:
109 return True
110
112 if ampRule.doParallelOverscan:
113 return True
114
115 return False
116
◆ 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.
118 def doAnyParallelOverscanCrosstalk(self):
119 """Check if any of the amp configs have doParallelOverscanCrosstalk.
120
121 Returns
122 -------
123 doAnyParallelOverscanCrosstalk : `bool`
124 """
125 if self.defaultAmpConfig.doParallelOverscanCrosstalk:
126 return True
127
129 if ampRule.doParallelOverscanCrosstalk:
130 return True
131
132 return False
133
◆ 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.
84 def doAnySerialOverscan(self):
85 """Check if any of the amp configs have doSerialOverscan.
86
87 Returns
88 -------
89 doAnySerialOverscan : `bool`
90 """
91 if self.defaultAmpConfig.doSerialOverscan:
92 return True
93
95 if ampRule.doSerialOverscan:
96 return True
97
98 return False
99
◆ 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.
134 def getOverscanAmpConfig(self, amplifier):
135 """Get the OverscanAmpConfig for a specific amplifier.
136
137 Parameters
138 ----------
139 amplifier : `lsst.afw.cameraGeom.Amplifier`
140
141 Returns
142 -------
143 overscanAmpConfig : `lsst.ip.isr.overscanAmpConfig.OverscanAmpConfig`
144 """
145 ampKey = amplifier.getName()
146
147 if ampKey in self.ampRules.keys():
148 overscanAmpConfig = self.ampRules[ampKey]
149 else:
150 overscanAmpConfig = self.defaultAmpConfig
151
152 return overscanAmpConfig
153
◆ 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.
176 def md5(self):
177 """Compute the MD5 hash of this config (detector + amps).
178
179 This can be used to ensure overscan configs are consistent.
180
181 Returns
182 -------
183 md5Hash : `str`
184 """
185 return hashlib.md5(self._stringForHash.encode("UTF-8")).hexdigest()
186
187
Member Data Documentation
◆ 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
|
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:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g0aad566f14+23d8574c86/python/lsst/ip/isr/overscanAmpConfig.py
