SpatialImageScaler¶

class lsst.pipe.tasks.scaleZeroPoint.SpatialImageScaler(interpStyle, xList, yList, scaleList)¶

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.

Methods Summary

`getInterpImage`(bbox)	Return an image containing the scale correction with same bounding box as supplied.
`scaleMaskedImage`(maskedImage)	Apply scale correction to the specified masked image.

Methods Documentation

getInterpImage(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.

scaleMaskedImage(maskedImage)¶

Apply scale correction to the specified masked image.

Parameters:	image : `lsst.afw.image.MaskedImage` To scale; scale is applied in place.