.. Pandora2D documentation master file, created by
   sphinx-quickstart on Fri Apr  3 16:11:03 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Pandora2D's documentation!
=====================================

**Pandora2D is an Image Registration framework. It computes 2D displacement maps from a pair of images taken over the same scene.** **It uses** `Pandora <https://github.com/cnes/pandora>`_.

**The framework features a high level of modularity, allowing users to configure their own pipeline from a broad class of algorithms described in** :ref:`step_by_step` **chapter.**

**Although Pandora2D was funded by CNES for Earth Observation applications, it is, in practice, agnostic to the type of sensor used for image acquisition.** 
**Therefore, it can be used for any application derived from** `image registration <https://en.wikipedia.org/wiki/Image_registration>`_.

.. warning::
    The maturity of Pandora2D is tightly linked to the progress of the `Trishna mission <https://trishna.cnes.fr>`_.
    
    As long as this mission is in the development phase, released versions of Pandora2D should be considered experimental. 

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting_started
   exploring_the_field
   userguide
   api_reference/index.rst
   developer_guide


.. api_reference is automatically generated by sphinx-autoapi


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`