BackgroundBase#

class photutils.background.BackgroundBase(sigma_clip=<default: SigmaClip(sigma=3.0, maxiters=10)>)[source]#

Bases: _BackgroundCommonBase, ABC

Base class for classes that estimate scalar background values.

Methods Summary

`__call__`(data[, axis, masked])	Call self as a function.
`calc_background`(data, *[, axis, masked])	Calculate the background value.

Methods Documentation

__call__(data, axis=None, masked=False)[source]#: Call self as a function.

abstractmethod calc_background(data, *, axis=None, masked=False)[source]#

Calculate the background value.

Parameters:

dataarray_like or MaskedArray: The array for which to calculate the background value.
axisint or None, optional: The array axis along which the background is calculated. If None, then the entire array is used.
maskedbool, optional: If True, then a MaskedArray is returned. If False, then a ndarray is returned, where masked values have a value of NaN. The default is False.

Returns:

resultfloat, ndarray, or MaskedArray: The calculated background value. If masked is False, then a ndarray is returned, otherwise a MaskedArray is returned. A scalar result is always returned as a float.