cars_mesh.state_machine
=======================

.. py:module:: cars_mesh.state_machine

.. autoapi-nested-parse::

   Class associated to CARS-MESH state machine



Classes
-------

.. autoapisummary::

   cars_mesh.state_machine.CarsMeshMachine


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

.. py:class:: CarsMeshMachine(mesh_data: cars_mesh.tools.handlers.Mesh, initial_state: str = 'initial_pcd')

   Bases: :py:obj:`transitions.Machine`


   CARS-MESH state machine


   .. py:attribute:: mesh_data


   .. py:attribute:: initial_state
      :value: 'initial_pcd'



   .. py:attribute:: states_
      :value: ['initial_pcd', 'filtered_pcd', 'denoised_pcd', 'meshed_pcd', 'textured_pcd']



   .. py:attribute:: transitions_


   .. py:method:: run(step: dict, cfg: dict) -> None

      Run CARS-MESH step by triggering the corresponding machine transition

      :param step: Name of the step to trigger
      :type step: str
      :param cfg: Configuration dictionary
      :type cfg: dict



   .. py:method:: filter_run(step: dict, cfg: dict, check_mode: bool = False) -> None

      Filter the point cloud from outliers

      :param step: Parameters of the step to run
      :type step: dict
      :param cfg: Configuration dictionary
      :type cfg: dict
      :param check_mode: Option to run the transition checker
      :type check_mode: bool (default=False)



   .. py:method:: denoise_pcd_run(step: dict, cfg: dict, check_mode: bool = False) -> None

      Denoise the point cloud

      :param step: Parameters of the step to run
      :type step: dict
      :param cfg: Configuration dictionary
      :type cfg: dict
      :param check_mode: Option to run the transition checker
      :type check_mode: bool (default=False)



   .. py:method:: mesh_run(step: dict, cfg: dict, check_mode: bool = False) -> None

      Mesh the point cloud

      :param step: Parameters of the step to run
      :type step: dict
      :param cfg: Configuration dictionary
      :type cfg: dict
      :param check_mode: Option to run the transition checker
      :type check_mode: bool (default=False)



   .. py:method:: simplify_mesh_run(step: dict, cfg: dict, check_mode: bool = False) -> None

      Simplify the mesh to reduce the number of faces

      :param step: Parameters of the step to run
      :type step: dict
      :param cfg: Configuration dictionary
      :type cfg: dict
      :param check_mode: Option to run the transition checker
      :type check_mode: bool (default=False)



   .. py:method:: denoise_mesh_run(step: dict, cfg: dict, check_mode: bool = False) -> None

      Denoise the mesh

      :param step: Parameters of the step to run
      :type step: dict
      :param cfg: Configuration dictionary
      :type cfg: dict
      :param check_mode: Option to run the transition checker
      :type check_mode: bool (default=False)



   .. py:method:: texture_run(step: dict, cfg: dict, check_mode: bool = False) -> None

      Texture the mesh

      :param step: Parameters of the step to run
      :type step: dict
      :param cfg: Configuration dictionary
      :type cfg: dict
      :param check_mode: Option to run the transition checker
      :type check_mode: bool (default=False)



   .. py:method:: check_transitions(cfg: dict) -> None

      Browse user defined steps and pass them just to check they are valid
      steps in the state machine.
      No action is done.

      :param cfg: Configuration dictionary
      :type cfg: dict