dcnum.feat.feat_brightness
==========================

.. py:module:: dcnum.feat.feat_brightness

.. autoapi-nested-parse::

   Feature computation: brightness-based features



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/dcnum/feat/feat_brightness/bright_all/index
   /autoapi/dcnum/feat/feat_brightness/common/index


Attributes
----------

.. autoapisummary::

   dcnum.feat.feat_brightness.brightness_names


Functions
---------

.. autoapisummary::

   dcnum.feat.feat_brightness.brightness_features


Package Contents
----------------

.. py:function:: brightness_features(image: numpy.typing.NDArray[numpy.uint8], mask: numpy.typing.NDArray[numpy.bool_], image_bg: numpy.typing.NDArray[numpy.uint8] | None = None, image_corr: numpy.typing.NDArray[numpy.int16] | None = None, bg_off: float | None = None)

   Compute brightness features

   :param image: 2D array of "image" of shape (H, W)
   :type image: np.ndarray
   :param mask: 3D array containing the N masks of shape (N, H, W)
   :type mask: np.ndarray
   :param image_bg: 2D array of "image_bg" of shape (H, W), required for computing
                    the "bg_med" feature.
   :type image_bg: np.ndarray
   :param image_corr: 2D array of (image - image_bg), which can be optionally passed
                      to this method. If not given, will be computed.
   :type image_corr: np.ndarray
   :param bg_off: Systematic offset value for correcting the brightness of the
                  background data which has an effect on "bright_bc_avg",
                  "bright_perc_10", "bright_perc_90", and "bg_med" (`bg_off` is
                  generated by sparsemed background correction).
   :type bg_off: float


.. py:data:: brightness_names
   :value: ['bg_med', 'bright_avg', 'bright_sd', 'bright_bc_avg', 'bright_bc_sd', 'bright_perc_10',...