larvaworld.lib.process.importing

Methods for importing data in lab-specific formats

Attributes

lab_specific_import_functions

Functions

import_Jovanic(→ Tuple[Any, Any])

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

import_Schleyer(→ Tuple[Any, Any])

Builds a larvaworld dataset from Schleyer-lab-specific raw data.

import_Berni(→ Tuple[Any, Any])

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

import_Arguello(→ Tuple[Any, Any])

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

Module Contents

larvaworld.lib.process.importing.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_idstring

The ID of the imported dataset

source_dirstring

The folder containing the imported dataset

match_idsboolean

Whether to use the match-ID algorithm Defaults to True

matchID_kwsdict

Additional keyword arguments to be passed to the match-ID algorithm.

interpolate_ticksboolean

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

spandas.DataFrame

The timeseries dataframe

epandas.DataFrame

The endpoint dataframe

larvaworld.lib.process.importing.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_dirstring

The folder containing the imported dataset

save_modestring

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

spandas.DataFrame

The timeseries dataframe

epandas.DataFrame

The endpoint dataframe

larvaworld.lib.process.importing.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_fileslist

List of the absolute filepaths of the data files.

**kwargs: keyword arguments

Additional keyword arguments to be passed to the generate_dataframes function.

Returns

spandas.DataFrame

The timeseries dataframe

epandas.DataFrame

The endpoint dataframe

larvaworld.lib.process.importing.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_fileslist

List of the absolute filepaths of the data files.

**kwargs: keyword arguments

Additional keyword arguments to be passed to the generate_dataframes function.

Returns

spandas.DataFrame

The timeseries dataframe

epandas.DataFrame

The endpoint dataframe

larvaworld.lib.process.importing.lab_specific_import_functions: dict[str, Callable[Ellipsis, tuple[Any, Any]]]