BackgroundRMSBase

class photutils.background.BackgroundRMSBase(sigma_clip=SigmaClip(sigma=3.0, sigma_lower=None, sigma_upper=None, iters=5, cenfunc=<function median>, stdfunc=<function std>))[source]

Bases: object

Base class for classes that estimate scalar background RMS 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__(data[, axis]) Call self as a function.
calc_background_rms(data[, axis]) Calculate the background RMS value.

Methods Documentation

__call__(data, axis=None)[source]

Call self as a function.

calc_background_rms(data, axis=None)[source]

Calculate the background RMS value.

Parameters:
data : array_like or MaskedArray

The array for which to calculate the background RMS value.

axis : int or None, optional

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

Returns:
result : float or MaskedArray

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