opticam.background.global_background
====================================

.. py:module:: opticam.background.global_background


Classes
-------

.. autoapisummary::

   opticam.background.global_background.BaseBackground
   opticam.background.global_background.DefaultBackground


Module Contents
---------------

.. py:class:: BaseBackground(box_size)

   Bases: :py:obj:`abc.ABC`


   Base class for OPTICAM background estimators.


   .. py:attribute:: box_size


   .. py:method:: __call__(image)
      :abstractmethod:


      Compute the 2D background for an image.

      Parameters
      ----------
      image : NDArray
          The image.

      Returns
      -------
      Background2D
          The two-dimensional background.



.. py:class:: DefaultBackground(box_size)

   Bases: :py:obj:`BaseBackground`


   Default background estimator.


   .. py:method:: __call__(image)

      Compute the 2D background for an image.

      Parameters
      ----------
      image : NDArray
          The image.

      Returns
      -------
      Background2D
          The two-dimensional background.