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

.. py:module:: cars.pipelines.parameters.sensor_inputs

.. autoapi-nested-parse::

   CARS containing inputs checking for sensor input data
   Used for full_res and low_res pipelines



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


Functions
~~~~~~~~~

.. autoapisummary::

   cars.pipelines.parameters.sensor_inputs.sensors_check_inputs
   cars.pipelines.parameters.sensor_inputs.check_sensors
   cars.pipelines.parameters.sensor_inputs.check_geometry_plugin
   cars.pipelines.parameters.sensor_inputs.generate_geometry_plugin_with_dem
   cars.pipelines.parameters.sensor_inputs.modify_to_absolute_path
   cars.pipelines.parameters.sensor_inputs.check_srtm
   cars.pipelines.parameters.sensor_inputs.check_input_data
   cars.pipelines.parameters.sensor_inputs.get_initial_elevation
   cars.pipelines.parameters.sensor_inputs.check_input_size
   cars.pipelines.parameters.sensor_inputs.check_nbits
   cars.pipelines.parameters.sensor_inputs.compare_image_type
   cars.pipelines.parameters.sensor_inputs.check_all_nbits_equal_one
   cars.pipelines.parameters.sensor_inputs.generate_inputs



Attributes
~~~~~~~~~~

.. autoapisummary::

   cars.pipelines.parameters.sensor_inputs.CARS_GEOID_PATH


.. py:data:: CARS_GEOID_PATH
   :value: 'geoid/egm96.grd'

   

.. py:function:: sensors_check_inputs(conf, config_json_dir=None)

   Check the inputs given

   :param conf: configuration of inputs
   :type conf: dict
   :param config_json_dir: path to dir containing json
   :type config_json_dir: str


.. py:function:: check_sensors(conf, overloaded_conf, config_json_dir=None)

   Check sensors



.. py:function:: check_geometry_plugin(conf_inputs, conf_geom_plugin)

   Check the geometry plugin with inputs

   :param conf_inputs: checked configuration of inputs
   :type conf_inputs: type
   :param conf_advanced: checked configuration of advanced
   :type conf_advanced: type
   :param conf_geom_plugin: name of geometry plugin
   :type conf_geom_plugin: str
   :return: overload inputs conf
            overloaded geometry plugin conf
            geometry plugin without dem
            geometry plugin with dem


.. py:function:: generate_geometry_plugin_with_dem(conf_geom_plugin, conf_inputs, dem=None, crop_dem=True)

   Generate geometry plugin with dem and geoid

   :param conf_geom_plugin: plugin configuration
   :param conf_inputs: inputs configuration
   :param dem: dem to overide the one in inputs

   :return: geometry plugin object, with a dem


.. py:function:: modify_to_absolute_path(config_json_dir, overloaded_conf)

   Modify input file path to absolute path

   :param config_json_dir: directory of the json configuration
   :type config_json_dir: str
   :param overloaded_conf: overloaded configuration json
   :dict overloaded_conf: dict


.. py:function:: check_srtm(srtm_dir)

   Check srtm data

   :param srtm_dir: directory of srtm
   :type srtm_dir: str


.. py:function:: check_input_data(image, color)

   Check data of the image and color

   :param image: image path
   :type image: str
   :param color: color path
   :type color: str


.. py:function:: get_initial_elevation(config)

   Return initial elevation parameters (dem and geoid paths)
   from input configuration.

   :param config: input initial elevation
   :type config: str, dict or None


.. py:function:: check_input_size(image, mask, color, classif)

   Check image, mask, classif and color given

   Images must have same size

   :param image: image path
   :type image: str
   :param mask: mask path
   :type mask: str
   :param color: color path
   :type color: str
   :param classif: classif path
   :type classif: str


.. py:function:: check_nbits(mask, classif)

   Check the bits number of the mask, classif
   mask and classification are limited to 1 bits per band

   :param mask: mask path
   :type mask: str
   :param classif: classif path
   :type classif: str


.. py:function:: compare_image_type(imgs, image_type, key1, key2)

   Compare the data type between a pair of images

   :param imgs: list of image paths
   :type imgs: str
   :param key1: key of the images pair
   :type key1: str
   :param image_type: type of cardataset image (IMG, MASK, CLASSIF...)
   :type image_type: int
   :param key1: other key of the images pair
   :type key1: str


.. py:function:: check_all_nbits_equal_one(nbits)

   Check if all the nbits = 1
   :param nbits: list of the nbits
   :return: True if all the nbits = 1


.. py:function:: generate_inputs(conf, geometry_plugin)

   Generate sensors inputs form inputs conf :

   a list of (sensor_left, sensor_right)

   :param conf: input conf
   :type conf: dict

   :return: list of sensors pairs
   :rtype: list(tuple(dict, dict))