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

.. py:module:: cars.pipelines.parameters.dsm_inputs

.. autoapi-nested-parse::

   CARS dsm inputs



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


Functions
~~~~~~~~~

.. autoapisummary::

   cars.pipelines.parameters.dsm_inputs.check_dsm_inputs
   cars.pipelines.parameters.dsm_inputs.check_input_size
   cars.pipelines.parameters.dsm_inputs.modify_to_absolute_path
   cars.pipelines.parameters.dsm_inputs.check_phasing
   cars.pipelines.parameters.dsm_inputs.merge_dsm_infos
   cars.pipelines.parameters.dsm_inputs.dsm_merging_wrapper
   cars.pipelines.parameters.dsm_inputs.assemblage



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

   Check the inputs given

   :param conf: configuration of inputs
   :type conf: dict
   :param config_json_dir: directory of used json, if
       user filled paths with relative paths
   :type config_json_dir: str

   :return: overloader inputs
   :rtype: dict


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

   Check dsm, mask, color, classif given

   Images must have same size

   :param dsm: phased dsm path
   :type dsm: str
   :param classif: classif path
   :type classif: str
   :param color: color path
   :type color: str
   :param mask: mask path
   :type mask: str


.. 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_phasing(dsm_dict)

   Check if the dsm are phased, and if resolution and epsg code are equivalent

   :param dsm_dict: list of phased dsm
   :type dsm_dict: dict


.. py:function:: merge_dsm_infos(dict_path, orchestrator, roi_poly, terrain_tile_size, dump_dir=None, dsm_file_name=None, color_file_name=None, classif_file_name=None, filling_file_name=None, performance_map_file_name=None, ambiguity_file_name=None, mask_file_name=None, contributing_pair_file_name=None)

   Merge all the dsms

   :param dict_path: path of all variables from all dsms
   :type dict_path: dict
   :param orchestrator: orchestrator used
   :param terrain_tile_size: tile size to use
   :type terrain_tile_size: int
   :param dump_dir: output path
   :type dump_dir: str
   :param dsm_file_name: name of the dsm output file
   :type dsm_file_name: str
   :param color_file_name: name of the color output file
   :type color_file_name: str
   :param classif_file_name: name of the classif output file
   :type classif_file_name: str
   :param filling_file_name: name of the filling output file
   :type filling_file_name: str
   :param performance_map_file_name: name of the performance_map output file
   :type performance_map_file_name: str
   :param ambiguity_file_name: name of the ambiguity output file
   :type ambiguity_file_name: str
   :param mask_file_name: name of the mask output file
   :type mask_file_name: str
   :param contributing_pair_file_name: name of contributing_pair output file
   :type contributing_pair_file_name: str

    :return: raster DSM. CarsDataset contains:

           - Z x W Delayed tiles.                 Each tile will be a future xarray Dataset containing:

               - data : with keys : "hgt", "img", "raster_msk",optional :                   "n_pts", "pts_in_cell", "hgt_mean", "hgt_stdev",                  "hgt_inf", "hgt_sup"
               - attrs with keys: "epsg"
           - attributes containing: None

   :rtype : CarsDataset filled with xr.Dataset


.. py:function:: dsm_merging_wrapper(dict_path, tile_bounds, resolution, profile, saving_info=None, full_sources_band_descriptions=None)

   Merge all the variables

   :param dict_path: path of all variables from all dsms
   :type dict_path: dict
   :param tile_bounds: list of tiles coordinates
   :type tile_bounds: list
   :param resolution: resolution of the dsms
   :type resolution: list
   :param profile: profile of the global dsm
   :type profile: OrderedDict
   :saving_info: the saving infos


.. py:function:: assemblage(out, current_weights, method, intersect_bounds, tile_bounds, height, width, band_descriptions=None, merge_sources=False)

   Update data

   :param out: the data to update
   :type out: list of path
   :param current_weights: the current weights of the data
   :type current_weights: list of path
   :param method: the method used to update the data
   :type method: str
   :param intersect_bounds: the bounds intersection
   :type intersect_bounds: list of bounds
   :param height: the height of the tile
   :type height: int
   :param width: the width of the tile
   :type width: int
   :param band_descriptions: the band description of the data
   :type band_descriptions: str of list
   :param merge_sources: merge source pc, using full band_description
   :type merge_sources: bool