pandora2d.constants
===================

.. py:module:: pandora2d.constants

.. autoapi-nested-parse::

   This module contains all the parameters related to the criteria dataset, defining each bit.



Classes
-------

.. autoapisummary::

   pandora2d.constants.Criteria


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

.. py:class:: Criteria

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


   Criteria class


   .. py:attribute:: VALID
      :value: 0



   .. py:attribute:: P2D_LEFT_BORDER

      The pixel is invalid : border of left image according to window size.



   .. py:attribute:: P2D_LEFT_NODATA

      The pixel is invalid : nodata in left mask.



   .. py:attribute:: P2D_RIGHT_NODATA

      The pixel is invalid : nodata in right mask.



   .. py:attribute:: P2D_RIGHT_DISPARITY_OUTSIDE

      The pixel is invalid : disparity is out the right image.



   .. py:attribute:: P2D_INVALID_MASK_LEFT

      The pixel is invalid : invalidated by validity mask of left image.



   .. py:attribute:: P2D_INVALID_MASK_RIGHT

      The pixel is invalid : invalidated by validity mask of right image.



   .. py:attribute:: P2D_PEAK_ON_EDGE

      The pixel is invalid : The correlation peak is at the edge of disparity range.
      The calculations stopped at the pixellic stage.



   .. py:attribute:: P2D_INVALID_INIT_DISPARITY

      The pixel is invalid : initial disparity of the pixel is invalid.



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

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