opticam.background.global_background

Classes

BaseBackground	Base class for OPTICAM background estimators.
DefaultBackground	Default background estimator.

Module Contents

class opticam.background.global_background.BaseBackground(box_size)

Bases: abc.ABC

Base class for OPTICAM background estimators.

Parameters:

box_size (int | Tuple[int, int])

box_size

abstractmethod __call__(image)

Compute the 2D background for an image.

Parameters

imageNDArray

The image.

Returns

Background2D

The two-dimensional background.

Parameters:

image (numpy.typing.NDArray)

Return type:

photutils.background.Background2D

class opticam.background.global_background.DefaultBackground(box_size)

Bases: BaseBackground

Default background estimator.

Parameters:

box_size (int | Tuple[int, int])

__call__(image)

Compute the 2D background for an image.

Parameters

imageNDArray

The image.

Returns

Background2D

The two-dimensional background.

Parameters:

image (numpy.typing.NDArray)

Return type:

photutils.background.Background2D