Classes | |
| class | CoaddBaseConfig |
| class | CoaddBaseTask |
Functions | |
| makeSkyInfo (skyMap, tractId, patchId) | |
| reorderAndPadList (inputList, inputKeys, outputKeys, padWith=None) | |
| reorderRefs (inputRefs, outputSortKeyOrder, dataIdKey) | |
| subBBoxIter (bbox, subregionSize) | |
| None | growValidPolygons (coaddInputs, int growBy) |
| removeMaskPlanes (afwImage.Mask mask, Iterable mask_planes, Logger|None logger=None) | |
| list[tuple[int, int]] | setRejectedMaskMapping (StatisticsControl statsCtrl) |
Function Documentation
◆ growValidPolygons()
| None lsst.pipe.tasks.coaddBase.growValidPolygons | ( | coaddInputs, | |
| int | growBy ) |
Grow coaddInputs' ccds' ValidPolygons in place.
Either modify each ccd's validPolygon in place, or if CoaddInputs
does not have a validPolygon, create one from its bbox.
Parameters
----------
coaddInputs : `lsst.afw.image.coaddInputs`
CoaddInputs object containing the ccds to grow the valid polygons of.
growBy : `int`
The value to grow the valid polygons by.
Notes
-----
Negative values for ``growBy`` can shrink the polygons.
Definition at line 276 of file coaddBase.py.
276def growValidPolygons(coaddInputs, growBy: int) -> None:
277 """Grow coaddInputs' ccds' ValidPolygons in place.
278
279 Either modify each ccd's validPolygon in place, or if CoaddInputs
280 does not have a validPolygon, create one from its bbox.
281
282 Parameters
283 ----------
284 coaddInputs : `lsst.afw.image.coaddInputs`
285 CoaddInputs object containing the ccds to grow the valid polygons of.
286 growBy : `int`
287 The value to grow the valid polygons by.
288
289 Notes
290 -----
291 Negative values for ``growBy`` can shrink the polygons.
292 """
293 for ccd in coaddInputs.ccds:
294 polyOrig = ccd.getValidPolygon()
295 validPolyBBox = polyOrig.getBBox() if polyOrig else ccd.getBBox()
296 validPolyBBox.grow(growBy)
297 if polyOrig:
298 validPolygon = polyOrig.intersectionSingle(validPolyBBox)
299 else:
300 validPolygon = Polygon(geom.Box2D(validPolyBBox))
301
302 ccd.validPolygon = validPolygon
303
304
◆ makeSkyInfo()
| lsst.pipe.tasks.coaddBase.makeSkyInfo | ( | skyMap, | |
| tractId, | |||
| patchId ) |
Constructs SkyInfo used by coaddition tasks for multiple
patchId formats.
Parameters
----------
skyMap : `lsst.skyMap.SkyMap`
Sky map.
tractId : `int`
The ID of the tract.
patchId : `str` or `int` or `tuple` of `int`
Either Gen2-style comma delimited string (e.g. '4,5'),
tuple of integers (e.g (4, 5), Gen3-style integer.
Returns
-------
makeSkyInfo : `lsst.pipe.base.Struct`
pipe_base Struct with attributes:
``skyMap``
Sky map (`lsst.skyMap.SkyMap`).
``tractInfo``
Information for chosen tract of sky map (`lsst.skyMap.TractInfo`).
``patchInfo``
Information about chosen patch of tract (`lsst.skyMap.PatchInfo`).
``wcs``
WCS of tract (`lsst.afw.image.SkyWcs`).
``bbox``
Outer bbox of patch, as an geom Box2I (`lsst.afw.geom.Box2I`).
Definition at line 114 of file coaddBase.py.
114def makeSkyInfo(skyMap, tractId, patchId):
115 """Constructs SkyInfo used by coaddition tasks for multiple
116 patchId formats.
117
118 Parameters
119 ----------
120 skyMap : `lsst.skyMap.SkyMap`
121 Sky map.
122 tractId : `int`
123 The ID of the tract.
124 patchId : `str` or `int` or `tuple` of `int`
125 Either Gen2-style comma delimited string (e.g. '4,5'),
126 tuple of integers (e.g (4, 5), Gen3-style integer.
127
128 Returns
129 -------
130 makeSkyInfo : `lsst.pipe.base.Struct`
131 pipe_base Struct with attributes:
132
133 ``skyMap``
134 Sky map (`lsst.skyMap.SkyMap`).
135 ``tractInfo``
136 Information for chosen tract of sky map (`lsst.skyMap.TractInfo`).
137 ``patchInfo``
138 Information about chosen patch of tract (`lsst.skyMap.PatchInfo`).
139 ``wcs``
140 WCS of tract (`lsst.afw.image.SkyWcs`).
141 ``bbox``
142 Outer bbox of patch, as an geom Box2I (`lsst.afw.geom.Box2I`).
143 """
144 tractInfo = skyMap[tractId]
145
146 if isinstance(patchId, str) and ',' in patchId:
147 # patch format is "xIndex,yIndex"
148 patchIndex = tuple(int(i) for i in patchId.split(","))
149 else:
150 patchIndex = patchId
151
152 patchInfo = tractInfo.getPatchInfo(patchIndex)
153
154 return pipeBase.Struct(
155 skyMap=skyMap,
156 tractInfo=tractInfo,
157 patchInfo=patchInfo,
158 wcs=tractInfo.getWcs(),
159 bbox=patchInfo.getOuterBBox(),
160 )
161
162
◆ removeMaskPlanes()
| lsst.pipe.tasks.coaddBase.removeMaskPlanes | ( | afwImage.Mask | mask, |
| Iterable | mask_planes, | ||
| Logger | None | logger = None ) |
Unset the mask of an image for mask planes specified in the config.
Parameters
----------
mask : `lsst.afw.image.Mask`
The mask to be modified.
mask_planes : `list`
The list of mask planes to be removed.
logger : `logging.Logger`, optional
Logger to log messages.
Definition at line 305 of file coaddBase.py.
307):
308 """Unset the mask of an image for mask planes specified in the config.
309
310 Parameters
311 ----------
312 mask : `lsst.afw.image.Mask`
313 The mask to be modified.
314 mask_planes : `list`
315 The list of mask planes to be removed.
316 logger : `logging.Logger`, optional
317 Logger to log messages.
318 """
319 for maskPlane in mask_planes:
320 try:
321 mask &= ~mask.getPlaneBitMask(maskPlane)
322 except InvalidParameterError:
323 if logger:
324 logger.warning(
325 "Unable to remove mask plane %s: no mask plane with that name was found.",
326 maskPlane,
327 )
328
329
◆ reorderAndPadList()
| lsst.pipe.tasks.coaddBase.reorderAndPadList | ( | inputList, | |
| inputKeys, | |||
| outputKeys, | |||
| padWith = None ) |
Match the order of one list to another, padding if necessary
Parameters
----------
inputList : `list`
List to be reordered and padded. Elements can be any type.
inputKeys : `iterable`
Iterable of values to be compared with outputKeys. Length must match `inputList`.
outputKeys : `iterable`
Iterable of values to be compared with inputKeys.
padWith : `Unknown`
Any value to be inserted where inputKey not in outputKeys.
Returns
-------
outputList : `list`
Copy of inputList reordered per outputKeys and padded with `padWith`
so that the length matches length of outputKeys.
Definition at line 163 of file coaddBase.py.
163def reorderAndPadList(inputList, inputKeys, outputKeys, padWith=None):
164 """Match the order of one list to another, padding if necessary
165
166 Parameters
167 ----------
168 inputList : `list`
169 List to be reordered and padded. Elements can be any type.
170 inputKeys : `iterable`
171 Iterable of values to be compared with outputKeys. Length must match `inputList`.
172 outputKeys : `iterable`
173 Iterable of values to be compared with inputKeys.
174 padWith : `Unknown`
175 Any value to be inserted where inputKey not in outputKeys.
176
177 Returns
178 -------
179 outputList : `list`
180 Copy of inputList reordered per outputKeys and padded with `padWith`
181 so that the length matches length of outputKeys.
182 """
183 outputList = []
184 for d in outputKeys:
185 if d in inputKeys:
186 outputList.append(inputList[inputKeys.index(d)])
187 else:
188 outputList.append(padWith)
189 return outputList
190
191
◆ reorderRefs()
| lsst.pipe.tasks.coaddBase.reorderRefs | ( | inputRefs, | |
| outputSortKeyOrder, | |||
| dataIdKey ) |
Reorder inputRefs per outputSortKeyOrder.
Any inputRefs which are lists will be resorted per specified key e.g.,
'detector.' Only iterables will be reordered, and values can be of type
`lsst.pipe.base.connections.DeferredDatasetRef` or
`lsst.daf.butler.core.datasets.ref.DatasetRef`.
Returned lists of refs have the same length as the outputSortKeyOrder.
If an outputSortKey not in the inputRef, then it will be padded with None.
If an inputRef contains an inputSortKey that is not in the
outputSortKeyOrder it will be removed.
Parameters
----------
inputRefs : `lsst.pipe.base.connections.QuantizedConnection`
Input references to be reordered and padded.
outputSortKeyOrder : `iterable`
Iterable of values to be compared with inputRef's dataId[dataIdKey].
dataIdKey : `str`
The data ID key in the dataRefs to compare with the outputSortKeyOrder.
Returns
-------
inputRefs : `lsst.pipe.base.connections.QuantizedConnection`
Quantized Connection with sorted DatasetRef values sorted if iterable.
Definition at line 192 of file coaddBase.py.
192def reorderRefs(inputRefs, outputSortKeyOrder, dataIdKey):
193 """Reorder inputRefs per outputSortKeyOrder.
194
195 Any inputRefs which are lists will be resorted per specified key e.g.,
196 'detector.' Only iterables will be reordered, and values can be of type
197 `lsst.pipe.base.connections.DeferredDatasetRef` or
198 `lsst.daf.butler.core.datasets.ref.DatasetRef`.
199
200 Returned lists of refs have the same length as the outputSortKeyOrder.
201 If an outputSortKey not in the inputRef, then it will be padded with None.
202 If an inputRef contains an inputSortKey that is not in the
203 outputSortKeyOrder it will be removed.
204
205 Parameters
206 ----------
207 inputRefs : `lsst.pipe.base.connections.QuantizedConnection`
208 Input references to be reordered and padded.
209 outputSortKeyOrder : `iterable`
210 Iterable of values to be compared with inputRef's dataId[dataIdKey].
211 dataIdKey : `str`
212 The data ID key in the dataRefs to compare with the outputSortKeyOrder.
213
214 Returns
215 -------
216 inputRefs : `lsst.pipe.base.connections.QuantizedConnection`
217 Quantized Connection with sorted DatasetRef values sorted if iterable.
218 """
219 for connectionName, refs in inputRefs:
220 if isinstance(refs, Iterable):
221 if hasattr(refs[0], "dataId"):
222 inputSortKeyOrder = [ref.dataId[dataIdKey] for ref in refs]
223 else:
224 inputSortKeyOrder = [handle.datasetRef.dataId[dataIdKey] for handle in refs]
225 if inputSortKeyOrder != outputSortKeyOrder:
226 setattr(inputRefs, connectionName,
227 reorderAndPadList(refs, inputSortKeyOrder, outputSortKeyOrder))
228 return inputRefs
229
230
◆ setRejectedMaskMapping()
| list[tuple[int, int]] lsst.pipe.tasks.coaddBase.setRejectedMaskMapping | ( | StatisticsControl | statsCtrl | ) |
Map certain mask planes of the warps to new planes for the coadd.
If a pixel is rejected due to a mask value other than EDGE, NO_DATA,
or CLIPPED, set it to REJECTED on the coadd.
If a pixel is rejected due to EDGE, set the coadd pixel to SENSOR_EDGE.
If a pixel is rejected due to CLIPPED, set the coadd pixel to CLIPPED.
Parameters
----------
statsCtrl : `lsst.afw.math.StatisticsControl`
Statistics control object for coadd.
Returns
-------
maskMap : `list` of `tuple` of `int`
A list of mappings of mask planes of the warped exposures to
mask planes of the coadd.
Definition at line 330 of file coaddBase.py.
330def setRejectedMaskMapping(statsCtrl: StatisticsControl) -> list[tuple[int, int]]:
331 """Map certain mask planes of the warps to new planes for the coadd.
332
333 If a pixel is rejected due to a mask value other than EDGE, NO_DATA,
334 or CLIPPED, set it to REJECTED on the coadd.
335 If a pixel is rejected due to EDGE, set the coadd pixel to SENSOR_EDGE.
336 If a pixel is rejected due to CLIPPED, set the coadd pixel to CLIPPED.
337
338 Parameters
339 ----------
340 statsCtrl : `lsst.afw.math.StatisticsControl`
341 Statistics control object for coadd.
342
343 Returns
344 -------
345 maskMap : `list` of `tuple` of `int`
346 A list of mappings of mask planes of the warped exposures to
347 mask planes of the coadd.
348 """
349 edge = 2 ** afwImage.Mask.addMaskPlane("EDGE")
350 noData = 2 ** afwImage.Mask.addMaskPlane("NO_DATA")
351 clipped = 2 ** afwImage.Mask.addMaskPlane("CLIPPED")
352 toReject = statsCtrl.getAndMask() & (~noData) & (~edge) & (~clipped)
353 maskMap = [
354 (toReject, 2 ** afwImage.Mask.addMaskPlane("REJECTED")),
355 (edge, 2 ** afwImage.Mask.addMaskPlane("SENSOR_EDGE")),
356 (clipped, clipped),
357 ]
358 return maskMap
◆ subBBoxIter()
| lsst.pipe.tasks.coaddBase.subBBoxIter | ( | bbox, | |
| subregionSize ) |
Iterate over subregions of a bbox.
Parameters
----------
bbox : `lsst.geom.Box2I`
Bounding box over which to iterate.
subregionSize : `lsst.geom.Extent2I`
Size of sub-bboxes.
Yields
------
subBBox : `lsst.geom.Box2I`
Next sub-bounding box of size ``subregionSize`` or smaller; each ``subBBox``
is contained within ``bbox``, so it may be smaller than ``subregionSize`` at
the edges of ``bbox``, but it will never be empty.
Raises
------
RuntimeError
Raised if any of the following occur:
- The given bbox is empty.
- The subregionSize is 0.
Definition at line 231 of file coaddBase.py.
231def subBBoxIter(bbox, subregionSize):
232 """Iterate over subregions of a bbox.
233
234 Parameters
235 ----------
236 bbox : `lsst.geom.Box2I`
237 Bounding box over which to iterate.
238 subregionSize : `lsst.geom.Extent2I`
239 Size of sub-bboxes.
240
241 Yields
242 ------
243 subBBox : `lsst.geom.Box2I`
244 Next sub-bounding box of size ``subregionSize`` or smaller; each ``subBBox``
245 is contained within ``bbox``, so it may be smaller than ``subregionSize`` at
246 the edges of ``bbox``, but it will never be empty.
247
248 Raises
249 ------
250 RuntimeError
251 Raised if any of the following occur:
252 - The given bbox is empty.
253 - The subregionSize is 0.
254 """
255 if bbox.isEmpty():
256 raise RuntimeError("bbox %s is empty" % (bbox,))
257 if subregionSize[0] < 1 or subregionSize[1] < 1:
258 raise RuntimeError("subregionSize %s must be nonzero" % (subregionSize,))
259
260 for rowShift in range(0, bbox.getHeight(), subregionSize[1]):
261 for colShift in range(0, bbox.getWidth(), subregionSize[0]):
263 subBBox.clip(bbox)
264 if subBBox.isEmpty():
265 raise RuntimeError("Bug: empty bbox! bbox=%s, subregionSize=%s, "
266 "colShift=%s, rowShift=%s" %
267 (bbox, subregionSize, colShift, rowShift))
268 yield subBBox
269
270
271# Note that this is implemented as a free-floating function to enable reuse in
272# lsst.pipe.tasks.makeWarp and in lsst.drp.tasks.make_psf_matched_warp
273# without creating any relationships between the two classes.
274# This may be converted to a method after makeWarp.py is removed altogether in
275# DM-47916.
Generated on Sun Nov 2 2025 07:01:53 for LSST Applications by
1.13.2