:py:mod:`cars.pipelines.parameters.advanced_parameters`
=======================================================

.. py:module:: cars.pipelines.parameters.advanced_parameters

.. autoapi-nested-parse::

   CARS module containing functions to check advanced parameters configuration



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


Functions
~~~~~~~~~

.. autoapisummary::

   cars.pipelines.parameters.advanced_parameters.check_advanced_parameters
   cars.pipelines.parameters.advanced_parameters.check_performance_classes
   cars.pipelines.parameters.advanced_parameters.validate_epipolar_a_priori
   cars.pipelines.parameters.advanced_parameters.check_ground_truth_dsm_data
   cars.pipelines.parameters.advanced_parameters.update_conf



.. py:function:: check_advanced_parameters(inputs, conf, check_epipolar_a_priori=True)

   Check the advanced parameters consistency

   :param inputs: configuration of inputs
   :type inputs: dict
   :param conf: configuration of advanced parameters
   :type conf: dict
   :param check_epipolar_a_priori: use epipolar a priori parameters
   :type check_epipolar_a_priori: bool

   :return: overloaded configuration
   :rtype: dict


.. py:function:: check_performance_classes(performance_map_classes)

   Check performance classes

   :param performance_map_classes: list for step defining border of class
   :type performance_map_classes: list or None


.. py:function:: validate_epipolar_a_priori(overloaded_conf, checker_epipolar)

   Validate inner epipolar configuration

   :param conf : input configuration json
   :type conf: dict
   :param overloaded_conf : overloaded configuration json
   :type overloaded_conf: dict
   :param checker_epipolar : json checker
   :type checker_epipolar: Checker


.. py:function:: check_ground_truth_dsm_data(conf)

   Check data of the image ground truth

   :param conf: ground truth dsm configuration
   :type conf: str


.. py:function:: update_conf(conf, grid_correction_coef=None, dmin=None, dmax=None, pair_key=None, dem_median=None, dem_min=None, dem_max=None, altitude_delta_max=None, altitude_delta_min=None)

   Update the conf with grid correction and disparity range
   :param grid_correction_coef: grid correction coefficient
   :type grid_correction_coef: list
   :param dmin: disparity range minimum
   :type dmin: float
   :param dmax: disparity range maximum
   :type dmax: float
   :param pair_key: name of the inputs key pair
   :type pair_key: str