lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler Class Reference

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

Public Member Functions
	__init__ (self, interpStyle, xList, yList, scaleList)
float	scale (self)
	scaleMaskedImage (self, maskedImage)
	getInterpImage (self, bbox)

Protected Attributes
	_xList = xList
	_yList = yList
	_scaleList = scaleList
float	_scale = scale

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 68 of file scaleZeroPoint.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 93 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 122 of file scaleZeroPoint.py.

scale()

float lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler.scale

(

self

)

Mean scale that it applies to a specified image.

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

Definition at line 107 of file scaleZeroPoint.py.

scaleMaskedImage()

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

Apply scale correction to the specified masked image.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    Masked image to scale; scale is applied in place.

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

Definition at line 111 of file scaleZeroPoint.py.

Member Data Documentation

_scale

float lsst.pipe.tasks.scaleZeroPoint.ImageScaler._scale = scale

protectedinherited

Definition at line 48 of file scaleZeroPoint.py.

_scaleList

lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler._scaleList = scaleList

protected

Definition at line 102 of file scaleZeroPoint.py.

_xList

lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler._xList = xList

protected

Definition at line 100 of file scaleZeroPoint.py.

_yList

lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler._yList = yList

protected

Definition at line 101 of file scaleZeroPoint.py.

---

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

• python/lsst/pipe/tasks/scaleZeroPoint.py