lsst.pipe.tasks gba22ec62b9+c4b3d61057
Public Member Functions | 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

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

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

Definition at line 62 of file scaleZeroPoint.py.

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.

◆ 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.


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