cars_mesh.evaluate_pipeline
===========================

.. py:module:: cars_mesh.evaluate_pipeline

.. autoapi-nested-parse::

   Main pipeline module for evaluation.



Functions
---------

.. autoapisummary::

   cars_mesh.evaluate_pipeline.check_config
   cars_mesh.evaluate_pipeline.run
   cars_mesh.evaluate_pipeline.main


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

.. py:function:: check_config(cfg_path: str) -> dict

   Check if the evaluate config is valid and readable

   :param cfg_path: Path to the JSON configuration file
   :type cfg_path: str

   :returns: **cfg** -- Configuration dictionary
   :rtype: dict


.. py:function:: run(cfg: dict, mesh_data_1: cars_mesh.tools.handlers.Mesh, mesh_data_2: cars_mesh.tools.handlers.Mesh) -> pandas.DataFrame

   Run evaluation

   :param cfg: Configuration dictionary
   :type cfg: dict
   :param mesh_data_1:
   :type mesh_data_1: Mesh
   :param mesh_data_2:
   :type mesh_data_2: Mesh

   :returns: **df_metrics** -- Metrics
   :rtype: pandas DataFrame


.. py:function:: main(cfg_path: str) -> None

   Main function to evaluate a point cloud or a mesh

   :param cfg_path: Path to the JSON configuration file
   :type cfg_path: str