BackgroundBase

class photutils.BackgroundBase[source]

Bases: object

Base class for classes that estimate scalar background values.

Parameters:

sigma_clip : astropy.stats.SigmaClip object, optional

A SigmaClip object that defines the sigma clipping parameters. If None then no sigma clipping will be performed. The default is to perform sigma clipping with sigma=3. and iters=5.

Methods Summary

__call__(…) <==> x(…)
calc_background(data[, axis]) Calculate the background value.

Methods Documentation

__call__(...) <==> x(...)[source]
calc_background(data, axis=None)[source]

Calculate the background value.

Parameters:

data : array_like or MaskedArray

The array for which to calculate the background value.

axis : int or None, optional

The array axis along which the background is calculated. If None, then the entire array is used.

Returns:

result : float or MaskedArray

The calculated background value. If axis is None then a scalar will be returned, otherwise a MaskedArray will be returned.