pandora.constants
=================

.. py:module:: pandora.constants

.. autoapi-nested-parse::

   This module contains all the parameters related to the validity mask, defining each bit.



Classes
-------

.. autoapisummary::

   pandora.constants.Criteria


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

.. py:class:: Criteria

   Bases: :py:obj:`enum.IntFlag`


   Validity mask criteria (bitfield per pixel).


   .. py:attribute:: PANDORA_VALID
      :value: 0



   .. py:attribute:: PANDORA_MSK_PIXEL_LEFT_NODATA_OR_BORDER


   .. py:attribute:: PANDORA_MSK_PIXEL_RIGHT_NODATA_OR_DISPARITY_RANGE_MISSING


   .. py:attribute:: PANDORA_MSK_PIXEL_RIGHT_INCOMPLETE_DISPARITY_RANGE


   .. py:attribute:: PANDORA_MSK_PIXEL_STOPPED_INTERPOLATION


   .. py:attribute:: PANDORA_MSK_PIXEL_FILLED_OCCLUSION


   .. py:attribute:: PANDORA_MSK_PIXEL_FILLED_MISMATCH


   .. py:attribute:: PANDORA_MSK_PIXEL_IN_VALIDITY_MASK_LEFT


   .. py:attribute:: PANDORA_MSK_PIXEL_IN_VALIDITY_MASK_RIGHT


   .. py:attribute:: PANDORA_MSK_PIXEL_OCCLUSION


   .. py:attribute:: PANDORA_MSK_PIXEL_MISMATCH


   .. py:attribute:: PANDORA_MSK_PIXEL_FILLED_NODATA


   .. py:attribute:: PANDORA_MSK_PIXEL_INTERVAL_REGULARIZED


   .. py:attribute:: PANDORA_MSK_PIXEL_INCOMPLETE_VARIABLE_DISPARITY_RANGE


   .. py:attribute:: PANDORA_MSK_PIXEL_INVALID


   .. py:method:: is_in(array: numpy.typing.NDArray)

      Returns a bool array, where True if Criteria value is part of array element.