lsst.pipe.tasks ga0be0691d8+ae2b9df503
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.

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.

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

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: