LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler Class Reference
Inheritance diagram for lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler:
lsst.pipe.tasks.scaleZeroPoint.ImageScaler

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

lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler._scaleList
protected

Definition at line 91 of file scaleZeroPoint.py.

◆ _xList

lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler._xList
protected

Definition at line 89 of file scaleZeroPoint.py.

◆ _yList

lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler._yList
protected

Definition at line 90 of file scaleZeroPoint.py.


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