BkgZoomInterpolator

class photutils.background.BkgZoomInterpolator(order=3, mode='reflect', cval=0.0)[source]

Bases: object

This class generates full-sized background and background RMS images from lower-resolution mesh images using the zoom (spline) interpolator.

This class must be used in concert with the Background2D class.

Parameters:
order : int, optional

The order of the spline interpolation used to resize the low-resolution background and background RMS mesh images. The value must be an integer in the range 0-5. The default is 3 (bicubic interpolation).

mode : {‘reflect’, ‘constant’, ‘nearest’, ‘wrap’}, optional

Points outside the boundaries of the input are filled according to the given mode. Default is ‘reflect’.

cval : float, optional

The value used for points outside the boundaries of the input if mode='constant'. Default is 0.0

Methods Summary

__call__(mesh, bkg2d_obj) Resize the 2D mesh array.

Methods Documentation

__call__(mesh, bkg2d_obj)[source]

Resize the 2D mesh array.

Parameters:
mesh : 2D ndarray

The low-resolution 2D mesh array.

bkg2d_obj : Background2D object

The Background2D object that prepared the mesh array.

Returns:
result : 2D ndarray

The resized background or background RMS image.