cars.applications.resampling.resampling_wrappers
================================================

.. py:module:: cars.applications.resampling.resampling_wrappers

.. autoapi-nested-parse::

   Resampling module:
   contains functions used for epipolar resampling



Functions
---------

.. autoapisummary::

   cars.applications.resampling.resampling_wrappers.get_paths_and_bands_from_image
   cars.applications.resampling.resampling_wrappers.get_path_and_values_from_classif
   cars.applications.resampling.resampling_wrappers.get_sensors_bounds
   cars.applications.resampling.resampling_wrappers.check_tiles_in_sensor
   cars.applications.resampling.resampling_wrappers.check_tile_inclusion


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

.. py:function:: get_paths_and_bands_from_image(sensor_image, required_bands=None)

   Reformat file paths and bands required from each file to ease reading

   :param sensor_image: input configuration of an image
   :type sensor_image: dict
   :param required_bands: required bands for resampling
   :type required_bands: list


.. py:function:: get_path_and_values_from_classif(sensor_classif)

   Reformat file paths and bands required from each file to ease reading

   :param sensor_classif: input configuration of a classif
   :type sensor_image: dict


.. py:function:: get_sensors_bounds(sensor_image_left, sensor_image_right)

   Get bounds of sensor images
   Bounds: BoundingBox(left, bottom, right, top)

   :param sensor_image_left: left sensor
   :type sensor_image_left: dict
   :param sensor_image_right: right sensor
   :type sensor_image_right: dict

   :return: left image bounds, right image bounds
   :rtype: tuple(list, list)


.. py:function:: check_tiles_in_sensor(sensor_image_left, sensor_image_right, image_tiling, grid_left, grid_right, geom_plugin)

   Check if epipolar tiles will be used.
   A tile is not used if is outside sensor bounds

   :param sensor_image_left: left sensor
   :type sensor_image_left: dict
   :param sensor_image_right: right sensor
   :type sensor_image_right: dict
   :param image_tiling: epipolar tiling grid
   :type image_tiling: np.array
   :param grid_left: left epipolar grid
   :type grid_left: CarsDataset
   :param grid_right: right epipolar grid
   :type grid_right: CarsDataset

   :return: left in sensor, right in sensor
   :rtype: np.array(bool), np.array(bool)



.. py:function:: check_tile_inclusion(left_sensor_bounds, right_sensor_bounds, sensor_pos_left, sensor_pos_right)

   Check if tile is in sensor image

   :param left_sensor_bounds: bounds of left sensor
   :type left_sensor_bounds: list
   :param right_sensor_bounds: bounds of right sensor
   :type right_sensor_bounds: list
   :param sensor_pos_left: left sensor position
   :type sensor_pos_left: np.array
   :param sensor_pos_right: right sensor position
   :type sensor_pos_right: np.array

   :return: left tile in sensor image left, right tile in sensor image right
   :rtype: tuple(bool, bool)