Inheritance diagram for lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler:

Public Member Functions
def	__init__ (self, interpStyle, xList, yList, scaleList)

def	scaleMaskedImage (self, maskedImage)

def	getInterpImage (self, bbox)

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.

Definition at line 53 of file scaleZeroPoint.py.

Constructor & Destructor Documentation

◆ init()

def lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.__init__	(	self,
		interpStyle,
		xList,
		yList,
		scaleList
	)

Constructor

@param[in] interpStyle: interpolation style (CONSTANT is only option)
@param[in] xList: list of X pixel positions
@param[in] yList: list of Y pixel positions
@param[in] scaleList: list of multiplicative scale factors at (x,y)

@raise RuntimeError if the lists have different lengths

Definition at line 62 of file scaleZeroPoint.py.

     def __init__(self, interpStyle, xList, yList, scaleList):
         """Constructor
  
         @param[in] interpStyle: interpolation style (CONSTANT is only option)
         @param[in] xList: list of X pixel positions
         @param[in] yList: list of Y pixel positions
         @param[in] scaleList: list of multiplicative scale factors at (x,y)
  
         @raise RuntimeError if the lists have different lengths
         """
         if len(xList) != len(yList) or len(xList) != len(scaleList):
             raise RuntimeError(
                 "len(xList)=%s len(yList)=%s, len(scaleList)=%s but all lists must have the same length" %
                 (len(xList), len(yList), len(scaleList)))
  
         # Eventually want this do be: self.interpStyle = getattr(afwMath.Interpolate2D, interpStyle)
         self._xList = xList
         self._yList = yList
         self._scaleList = scaleList
  

Member Function Documentation

◆ getInterpImage()

def lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.getInterpImage	(	self,
		bbox
	)

Return an image containing the scale correction with same bounding box as supplied.

@param[in] bbox: integer bounding box for image (geom.Box2I)

Definition at line 90 of file scaleZeroPoint.py.

     def getInterpImage(self, bbox):
         """Return an image containing the scale correction with same bounding box as supplied.
  
         @param[in] bbox: integer bounding box for image (geom.Box2I)
         """
         npoints = len(self._xList)
  
         if npoints < 1:
             raise RuntimeError("Cannot create scaling image. Found no fluxMag0s to interpolate")
  
         image = afwImage.ImageF(bbox, numpy.mean(self._scaleList))
  
         return image
  
  

◆ scaleMaskedImage()

def lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.scaleMaskedImage	(	self,
		maskedImage
	)

Apply scale correction to the specified masked image

@param[in,out] image to scale; scale is applied in place

Reimplemented from lsst.pipe.tasks.scaleZeroPoint.ImageScaler.

Definition at line 82 of file scaleZeroPoint.py.

     def scaleMaskedImage(self, maskedImage):
         """Apply scale correction to the specified masked image
  
         @param[in,out] image to scale; scale is applied in place
         """
         scale = self.getInterpImage(maskedImage.getBBox())
         maskedImage *= scale
  

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/scaleZeroPoint.py