mmgp.preprocessing
==================

.. py:module:: mmgp.preprocessing


Functions
---------

.. autoapisummary::

   mmgp.preprocessing.pretreat_sample
   mmgp.preprocessing.pre_process


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

.. py:function:: pretreat_sample(configuration: dict, common_morphed_mesh: Muscat.Containers.Mesh.Mesh, i_sample: int) -> dict

   Compute and Save the precomputed FE projection and inverse FE projection operators.

   :param configuration: A dictionary containing various parameters and settings for the pretreatment process. It should include the following keys:

                         - 'case_name' (str): The name or identifier for the specific case or scenario being analyzed.
                         - 'base_name' (str): The name of a specific base on which to pretreat samples.
                         - 'zone_name' (str): The name of a specific zone on which to pretreat samples.
                         - 'morphing' (dict): A dictionary containing morphing-related parameters with the following keys:
                             - algo (str): A string indicating the morphing algorithm to be used. This parameter specifies the technique for mesh parametrization or transformation.
                             - options (str): A string containing options or settings for the chosen morphing algorithm.
                         - init_dataset_location (str): A string specifying the location or path to the initial dataset or data source used for the calculations.
                         - generated_data_folder (str): A string representing the folder where the morphed mesh and transported fields, the common morphed mesh and projected coordinate fields and fields of interest, and precomputed FE projection and inverse FE projection operators will be saved.
   :type configuration: dict
   :param common_morphed_mesh: The target common morphed mesh.
   :type common_morphed_mesh: Mesh
   :param i_sample: An integer representing the index or identifier of the sample being processed.
   :type i_sample: int

   .. hint::

      The following samples will alsos be saved in the generated data folder:
      
      - Sample with morphed mesh and transported fields
      - Sample with common morphed mesh and projected coordinate fields and fields of interest

   .. caution:: This function will load the initial PLAID dataset. Make sure it has been created and is located correctly.


.. py:function:: pre_process(configuration: dict) -> List[dict]

   Parallel apply pretreat_sample function on the entire Dataset.

   :param configuration: A dictionary containing various parameters and settings for the pretreatment process. It should include the following keys:

                         - 'init_dataset_location' (str): A string specifying the location or path to the initial dataset or data source used for the calculations.
                         - 'generated_data_folder' (str): A string representing the folder where the morphed mesh and transported fields, the common morphed mesh, projected coordinate fields, fields of interest, and precomputed FE projection and inverse FE projection operators will be saved.
                         - 'case_name' (str): The name or identifier for the specific case or scenario being analyzed.
                         - 'morphing' (dict): A dictionary containing morphing-related parameters with the following keys:
                             - 'algo' (str): A string indicating the morphing algorithm to be used.
                             - 'options' (str): A string containing options or settings for the chosen morphing algorithm.
                         - 'common_mesh_index' (int): An integer specifying the index for the common mesh.
   :type configuration: dict

   .. caution:: This function will load the initial PLAID dataset. Make sure it has been created and is located correctly.