SpatialImageScaler

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

Bases: ImageScaler

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:

interpStyleUnknown

Interpolation style (CONSTANT is only option).

xListlist of int

List of X pixel positions.

yListlist of int

List of Y pixel positions.

scaleListUnknown

List of multiplicative scale factors at (x,y).

Raises:

RuntimeError

Raised if the lists have different lengths.

Attributes Summary

scale

Mean scale that it applies to a specified image.

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.

Attributes Documentation

scale

Mean scale that it applies to a specified image.

Deprecated since version v30: This property will be removed after v30.

Methods Documentation

getInterpImage(bbox)

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

Parameters:

bboxlsst.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:

maskedImagelsst.afw.image.MaskedImage

Masked image to scale; scale is applied in place.