cars.conf.input_parameters
==========================

.. py:module:: cars.conf.input_parameters

.. autoapi-nested-parse::

   This input module refers to parameters and configuration inputs



Attributes
----------

.. autoapisummary::

   cars.conf.input_parameters.STATIC_PARAMS_TAG
   cars.conf.input_parameters.ConfigType
   cars.conf.input_parameters.INPUT_SECTION_TAG
   cars.conf.input_parameters.PRODUCT1_KEY
   cars.conf.input_parameters.PRODUCT2_KEY
   cars.conf.input_parameters.IMG_TAG_ROOT
   cars.conf.input_parameters.MODEL_TAG_ROOT
   cars.conf.input_parameters.MODEL_TYPE_TAG_ROOT
   cars.conf.input_parameters.IMG1_TAG
   cars.conf.input_parameters.IMG2_TAG
   cars.conf.input_parameters.MODEL1_TAG
   cars.conf.input_parameters.MODEL2_TAG
   cars.conf.input_parameters.MODEL1_TYPE_TAG
   cars.conf.input_parameters.MODEL2_TYPE_TAG
   cars.conf.input_parameters.SRTM_DIR_TAG
   cars.conf.input_parameters.COLOR1_TAG
   cars.conf.input_parameters.MASK1_TAG
   cars.conf.input_parameters.MASK2_TAG
   cars.conf.input_parameters.CLASSIFICATION1_TAG
   cars.conf.input_parameters.CLASSIFICATION2_TAG
   cars.conf.input_parameters.NODATA1_TAG
   cars.conf.input_parameters.NODATA2_TAG
   cars.conf.input_parameters.DEFAULT_ALT_TAG
   cars.conf.input_parameters.USE_EPIPOLAR_A_PRIORI
   cars.conf.input_parameters.EPIPOLAR_A_PRIORI
   cars.conf.input_parameters.INPUT_CONFIGURATION_SCHEMA


Functions
---------

.. autoapisummary::

   cars.conf.input_parameters.read_input_parameters
   cars.conf.input_parameters.create_img_tag_from_product_key
   cars.conf.input_parameters.create_model_tag_from_product_key
   cars.conf.input_parameters.create_model_type_tag_from_product_key


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

.. py:data:: STATIC_PARAMS_TAG
   :value: 'static_parameters'


.. py:data:: ConfigType

.. py:function:: read_input_parameters(filename: ConfigType) -> ConfigType

   Read an input parameters json file.
   Relative paths will be made absolute.

   :param filename: Path to json file
   :type filename: ConfigType

   :return: The dictionary read from file
   :rtype: ConfigType


.. py:function:: create_img_tag_from_product_key(product_key: str)

   Create images tags from IMG_TAG_ROOT and the given product key
   :param product_key: PRODUCT1_KEY or PRODUCT2_KEY
   :return: IMG1_TAG or IMG2_TAG


.. py:function:: create_model_tag_from_product_key(product_key: str)

   Create images tags from MODEL_TAG_ROOT and the given product key
   :param product_key: PRODUCT1_KEY or PRODUCT2_KEY
   :return: MODEL1_TAG or MODEL2_TAG


.. py:function:: create_model_type_tag_from_product_key(product_key: str)

   Create images tags from MODEL_TAG_ROOT and the given product key
   :param product_key: PRODUCT1_KEY or PRODUCT2_KEY
   :return: MODEL1_TAG or MODEL2_TAG


.. py:data:: INPUT_SECTION_TAG
   :value: 'input'


.. py:data:: PRODUCT1_KEY
   :value: '1'


.. py:data:: PRODUCT2_KEY
   :value: '2'


.. py:data:: IMG_TAG_ROOT
   :value: 'img'


.. py:data:: MODEL_TAG_ROOT
   :value: 'model'


.. py:data:: MODEL_TYPE_TAG_ROOT
   :value: 'model_type'


.. py:data:: IMG1_TAG
   :value: 'img1'


.. py:data:: IMG2_TAG
   :value: 'img2'


.. py:data:: MODEL1_TAG
   :value: 'model1'


.. py:data:: MODEL2_TAG
   :value: 'model2'


.. py:data:: MODEL1_TYPE_TAG
   :value: 'model_type1'


.. py:data:: MODEL2_TYPE_TAG
   :value: 'model_type2'


.. py:data:: SRTM_DIR_TAG
   :value: 'srtm_dir'


.. py:data:: COLOR1_TAG
   :value: 'color1'


.. py:data:: MASK1_TAG
   :value: 'mask1'


.. py:data:: MASK2_TAG
   :value: 'mask2'


.. py:data:: CLASSIFICATION1_TAG
   :value: 'classification1'


.. py:data:: CLASSIFICATION2_TAG
   :value: 'classification2'


.. py:data:: NODATA1_TAG
   :value: 'nodata1'


.. py:data:: NODATA2_TAG
   :value: 'nodata2'


.. py:data:: DEFAULT_ALT_TAG
   :value: 'default_alt'


.. py:data:: USE_EPIPOLAR_A_PRIORI
   :value: 'use_epipolar_a_priori'


.. py:data:: EPIPOLAR_A_PRIORI
   :value: 'epipolar_a_priori'


.. py:data:: INPUT_CONFIGURATION_SCHEMA