mmgp.processing
===============

.. py:module:: mmgp.processing


Functions
---------

.. autoapisummary::

   mmgp.processing.read_proj_in_coord_fields
   mmgp.processing.train
   mmgp.processing.infer


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

.. py:function:: read_proj_in_coord_fields(sample: plaid.containers.sample.Sample, zone_name: str, base_name: str) -> numpy.ndarray

   Read and concatenate coordinate fields from a Sample object.

   :param sample: The Sample object containing coordinate fields.
   :type sample: Sample
   :param zone_name: The zone name of the coorinates fields.
   :type zone_name: str
   :param base_name: The base name of the coordinate fields.
   :type base_name: str

   :returns: A NumPy array containing concatenated coordinate fields.
   :rtype: np.ndarray


.. py:function:: train(configuration: dict, problem: plaid.problem_definition.ProblemDefinition) -> dict

   Train a model using provided data in the ProblemDefinition and configuration settings.

   :param configuration: A dictionary containing various parameters and settings for the training 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 train the model.
                         - 'zone_name' (str): The name of a specific zone on which to train the model.
                         - 'generated_data_folder' (str): A string representing the folder where the training data and model will be saved.
   :type configuration: dict
   :param problem: An instance of ProblemDefinition class containing the training data and problem-specific information, such as input and output names.
   :type problem: ProblemDefinition

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


.. py:function:: infer(configuration: dict, problem: plaid.problem_definition.ProblemDefinition) -> dict

   Perform inference using the provided ProblemDefinition instance and configuration settings.

   :param configuration: A dictionary containing various parameters and settings for the inference process. It should include the following keys:
                         - 'init_dataset_location' (str): A string specifying the location or path to the initial PLAID dataset.
                         - 'generated_data_folder' (str): A string representing the folder where the inference results will be saved.
                         - '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 perform inference.
                         - 'zone_name' (str): The name of a specific zone on which to perform inference.
   :type configuration: dict
   :param problem: An object of the ProblemDefinition class containing the inference data and problem-specific information.
   :type problem: ProblemDefinition

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