Inheritance diagram for lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler:
Public Member Functions | |
| __init__ (self, interpStyle, xList, yList, scaleList) | |
| scaleMaskedImage (self, maskedImage) | |
| getInterpImage (self, bbox) | |
Protected Attributes | |
| _xList | |
| _yList | |
| _scaleList | |
Detailed Description
Multiplicative image scaler using interpolation over a grid of points.
Contains the x, y positions in tract coordinates and the scale factors.
Interpolates only when scaleMaskedImage() or getInterpImage() is called.
Currently the only type of 'interpolation' implemented is CONSTANT which calculates the mean.
Parameters
----------
interpStyle : `Unknown`
Interpolation style (`CONSTANT` is only option).
xList : `list` of `int`
List of X pixel positions.
yList : `list` of `int`
List of Y pixel positions.
scaleList : `Unknown`
List of multiplicative scale factors at (x,y).
Raises
------
RuntimeError
Raised if the lists have different lengths.
Definition at line 57 of file scaleZeroPoint.py.
Constructor & Destructor Documentation
◆ __init__()
| lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.__init__ | ( | self, | |
| interpStyle, | |||
| xList, | |||
| yList, | |||
| scaleList ) |
Reimplemented from lsst.pipe.tasks.scaleZeroPoint.ImageScaler.
Definition at line 82 of file scaleZeroPoint.py.
82 def __init__(self, interpStyle, xList, yList, scaleList):
83 if len(xList) != len(yList) or len(xList) != len(scaleList):
84 raise RuntimeError(
85 "len(xList)=%s len(yList)=%s, len(scaleList)=%s but all lists must have the same length" %
86 (len(xList), len(yList), len(scaleList)))
87
88 # Eventually want this do be: self.interpStyle = getattr(afwMath.Interpolate2D, interpStyle)
89 self._xList = xList
90 self._yList = yList
91 self._scaleList = scaleList
92
Member Function Documentation
◆ getInterpImage()
| lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.getInterpImage | ( | self, | |
| bbox ) |
Return an image containing the scale correction with same bounding box as supplied.
Parameters
----------
bbox : `lsst.geom.Box2I`
Integer bounding box for image.
Raises
------
RuntimeError
Raised if there are no fluxMag0s to interpolate.
Definition at line 104 of file scaleZeroPoint.py.
104 def getInterpImage(self, bbox):
105 """Return an image containing the scale correction with same bounding box as supplied.
106
107 Parameters
108 ----------
109 bbox : `lsst.geom.Box2I`
110 Integer bounding box for image.
111
112 Raises
113 ------
114 RuntimeError
115 Raised if there are no fluxMag0s to interpolate.
116 """
117 npoints = len(self._xList)
118
119 if npoints < 1:
120 raise RuntimeError("Cannot create scaling image. Found no fluxMag0s to interpolate")
121
122 image = afwImage.ImageF(bbox, numpy.mean(self._scaleList))
123
124 return image
125
126
◆ scaleMaskedImage()
| lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.scaleMaskedImage | ( | self, | |
| maskedImage ) |
Apply scale correction to the specified masked image.
Parameters
----------
image : `lsst.afw.image.MaskedImage`
To scale; scale is applied in place.
Reimplemented from lsst.pipe.tasks.scaleZeroPoint.ImageScaler.
Definition at line 93 of file scaleZeroPoint.py.
93 def scaleMaskedImage(self, maskedImage):
94 """Apply scale correction to the specified masked image.
95
96 Parameters
97 ----------
98 image : `lsst.afw.image.MaskedImage`
99 To scale; scale is applied in place.
100 """
101 scale = self.getInterpImage(maskedImage.getBBox())
102 maskedImage *= scale
103
Member Data Documentation
◆ _scaleList
|
protected |
Definition at line 91 of file scaleZeroPoint.py.
◆ _xList
|
protected |
Definition at line 89 of file scaleZeroPoint.py.
◆ _yList
|
protected |
Definition at line 90 of file scaleZeroPoint.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/ge6cb8fbbf7+d119aed356/python/lsst/pipe/tasks/scaleZeroPoint.py
