cars.pipelines.default.default_pipeline
=======================================

.. py:module:: cars.pipelines.default.default_pipeline

.. autoapi-nested-parse::

   CARS default pipeline class file



Attributes
----------

.. autoapisummary::

   cars.pipelines.default.default_pipeline.package_path
   cars.pipelines.default.default_pipeline.FIRST_RES
   cars.pipelines.default.default_pipeline.INTERMEDIATE_RES
   cars.pipelines.default.default_pipeline.FINAL_RES
   cars.pipelines.default.default_pipeline.PIPELINE_CONFS


Classes
-------

.. autoapisummary::

   cars.pipelines.default.default_pipeline.DefaultPipeline


Functions
---------

.. autoapisummary::

   cars.pipelines.default.default_pipeline.extract_conf_section
   cars.pipelines.default.default_pipeline.extract_conf_with_resolution
   cars.pipelines.default.default_pipeline.generate_filling_applications_for_surface_modeling
   cars.pipelines.default.default_pipeline.overide_pipeline_conf
   cars.pipelines.default.default_pipeline.merge_used_conf


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

.. py:data:: package_path

.. py:data:: FIRST_RES
   :value: 'first_resolution'


.. py:data:: INTERMEDIATE_RES
   :value: 'intermediate_resolution'


.. py:data:: FINAL_RES
   :value: 'final_resolution'


.. py:data:: PIPELINE_CONFS

.. py:class:: DefaultPipeline(conf, config_dir=None)

   Bases: :py:obj:`cars.pipelines.pipeline_template.PipelineTemplate`


   DefaultPipeline


   .. py:attribute:: config_dir
      :value: None



   .. py:attribute:: metadata


   .. py:attribute:: out_dir


   .. py:attribute:: pipeline_to_use


   .. py:attribute:: intermediate_data_dir


   .. py:attribute:: positions


   .. py:attribute:: used_conf


   .. py:attribute:: keep_low_res_dir
      :value: True



   .. py:method:: check_inputs(conf, config_json_dir=None)

      Check the inputs given

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

      :return: overloader inputs
      :rtype: dict



   .. py:method:: check_output(conf)

      Check the output given

      :param conf: configuration of output
      :type conf: dict

      :return overloader output
      :rtype : dict



   .. py:method:: check_pipeline(conf)

      Check the pipeline section



   .. py:method:: check_subsampling(conf)

      Check the subsampling section

      :param conf: configuration of subsampling
      :type conf: dict



   .. py:method:: check_filling(conf)

      Check the filling section

      :param conf: configuration of subsampling
      :type conf: dict



   .. py:method:: check_pipeline_section(pipeline_name, pipeline_conf)

      Check any pipeline section

      :param pipeline_name: key name in conf
      :type pipeline_name: str
      :param pipeline_conf: pipeline configuration
      :type pipeline_conf: dict



   .. py:method:: cleanup_low_res_dir()

      Clean low res dir



   .. py:method:: construct_merging_conf(conf)

      Construct the right conf for merging



   .. py:method:: construct_subsampling_conf(conf)

      Construct the right conf for subsampling



   .. py:method:: construct_formatting_conf(input_dir)

      Construct the right conf for formatting



   .. py:method:: construct_filling_conf(conf)

      Construct the right conf for filling



   .. py:method:: run(args=None)

      Run pipeline




.. py:function:: extract_conf_section(current_conf_section, res, default_conf_for_res=None, filling_applications=None)

   Extract applications for current resolution

   :param current_applications_conf: current applications configuration
   :type current_applications_conf: dict
   :param res: resolution to extract
   :type res: int
   :param default_conf_for_res: default configuration for resolution
   :type default_conf_for_res: dict
   :param filling_applications: filling applications configuration
   :type filling_applications: dict

   :return: configuration for the given resolution
   :rtype: dict


.. py:function:: extract_conf_with_resolution(current_conf, res, first_res, intermediate_res, last_res, intermediate_data_dir, pipeline_to_use)

   Extract the configuration for the given resolution

   :param current_conf: current configuration
   :type current_conf: dict
   :param res: resolution to extract
   :type res: int
   :return: configuration for the given resolution
   :rtype: dict
   :param first_res: is first resolution
   :type first_res: bool
   :param intermediate_res: is intermediate resolution
   :type intermediate_res: bool
   :param last_res: is last resolution
   :type last_res: bool
   :param previous_out_dir: path to previous outdir
   :type: previous_out_dir: str


.. py:function:: generate_filling_applications_for_surface_modeling(inputs_conf)

   Generate filling applications configuration according to inputs

   :param inputs_conf: inputs configuration
   :type inputs_conf: dict


.. py:function:: overide_pipeline_conf(conf, overiding_conf, append_classification=False)

   Merge two dictionaries recursively without removing keys from the base conf.

   :param conf: base configuration dictionary
   :type conf: dict
   :param overiding_conf: overriding configuration dictionary
   :type overiding_conf: dict
   :return: merged configuration
   :rtype: dict


.. py:function:: merge_used_conf(used_configurations, resolutions, out_dir)

   Merge all used configuration