larvaworld.lib.process.importing
================================

.. py:module:: larvaworld.lib.process.importing

.. autoapi-nested-parse::

   Methods for importing data in lab-specific formats



Attributes
----------

.. autoapisummary::

   larvaworld.lib.process.importing.lab_specific_import_functions


Functions
---------

.. autoapisummary::

   larvaworld.lib.process.importing.import_Jovanic
   larvaworld.lib.process.importing.import_Schleyer
   larvaworld.lib.process.importing.import_Berni
   larvaworld.lib.process.importing.import_Arguello


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

.. py:function:: import_Jovanic(source_id: str, source_dir: str, tracker: Any, filesystem: Any, match_ids: bool = True, matchID_kws: Dict[str, Any] = {}, interpolate_ticks: bool = True, **kwargs: Any) -> Tuple[Any, Any]

    Builds a larvaworld dataset from Jovanic-lab-specific raw data

   Parameters
   ----------
    source_id : string
        The ID of the imported dataset
    source_dir : string
        The folder containing the imported dataset
    match_ids : boolean
        Whether to use the match-ID algorithm
        Defaults to True
    matchID_kws : dict
        Additional keyword arguments to be passed to the match-ID algorithm.
    interpolate_ticks : boolean
        Whether to interpolate timeseries into a fixed timestep timeseries
        Defaults to True
   **kwargs: keyword arguments
        Additional keyword arguments to be passed to the constrain_selected_tracks function.


   Returns
   -------
    s : pandas.DataFrame
        The timeseries dataframe
    e : pandas.DataFrame
        The endpoint dataframe



.. py:function:: import_Schleyer(source_dir: str, tracker: Any, filesystem: Any, save_mode: str = 'semifull', **kwargs: Any) -> Tuple[Any, Any]

    Builds a larvaworld dataset from Schleyer-lab-specific raw data.
    The data is available at https://doi.gin.g-node.org/10.12751/g-node.5e1ifd/

   Parameters
   ----------
    source_dir : string
        The folder containing the imported dataset
    save_mode : string
        Mode to define the sequence of columns/parameters to store.
        Defaults to 'semi-full'
   **kwargs: keyword arguments
        Additional keyword arguments to be passed to the generate_dataframes function.


   Returns
   -------
    s : pandas.DataFrame
        The timeseries dataframe
    e : pandas.DataFrame
        The endpoint dataframe



.. py:function:: import_Berni(source_files: List[str], tracker: Any, filesystem: Any, **kwargs: Any) -> Tuple[Any, Any]

    Builds a larvaworld dataset from Berni-lab-specific raw data

   Parameters
   ----------
    source_files : list
        List of the absolute filepaths of the data files.
   **kwargs: keyword arguments
        Additional keyword arguments to be passed to the generate_dataframes function.


   Returns
   -------
    s : pandas.DataFrame
        The timeseries dataframe
    e : pandas.DataFrame
        The endpoint dataframe



.. py:function:: import_Arguello(source_files: List[str], tracker: Any, filesystem: Any, **kwargs: Any) -> Tuple[Any, Any]

    Builds a larvaworld dataset from Arguello-lab-specific raw data

   Parameters
   ----------
    source_files : list
        List of the absolute filepaths of the data files.
   **kwargs: keyword arguments
        Additional keyword arguments to be passed to the generate_dataframes function.


   Returns
   -------
    s : pandas.DataFrame
        The timeseries dataframe
    e : pandas.DataFrame
        The endpoint dataframe



.. py:data:: lab_specific_import_functions
   :type:  dict[str, Callable[Ellipsis, tuple[Any, Any]]]