Data loading and Datasets

Helper to load data and example in the various supported formats.

General Gait Data

Base Classes

BaseGaitDataset(*[, groupby_cols, subset_index])	Basic subclass for all normal gait datasets.
BaseGaitDatasetWithReference(*[, ...])	Base class for all gait datasets that have reference parameters.

Generic Loader Classes

GaitDatasetFromData(_data, _sampling_rate_hz)

Create dataset from data that is already loaded.

Mobilise-D Matlab format

Base Classes

BaseGenericMobilisedDataset(*[, ...])	Common base class for Datasets based on the Mobilise-D matlab format.
GenericMobilisedDataset(paths_list, ...[, ...])	A generic dataset loader for the Mobilise-D data format.

Load Functions

load_mobilised_matlab_format(path, *[, ...])	Load a single data.mat file formatted according to the Mobilise-D guidelines.
parse_reference_parameters(ref_data, *, ...)	Parse the reference data (stored per WB) into the per recording data structures used in mobgap.

Technical Validation Study (TVS) Data Loader

TVSLabDataset(base_path, *[, ...])	A dataset containing all Lab Data recorded within the Mobilise-D technical validation study.
TVSFreeLivingDataset(base_path, *[, ...])	A dataset containing all Free-Living (2.5 hour) Data recorded within the Mobilise-D technical validation study.

Base Classes

BaseTVSDataset(base_path, *[, ...])

Base class for the TVS datasets.

Example Data

Dataset Classes

LabExampleDataset(*[, raw_data_sensor, ...])

A dataset containing all lab example data provided with mobgap.

Functional Interface

Load Functions

get_all_lab_example_data_paths()

Get the paths to all lab example data.

Mobilise-D v1.0 Pipeline Result Loaders

MobilisedCvsDmoDataset(dmo_path, ...[, ...])

A dataset representing calculated DMO data of the clinical validation study.

Datatypes

ReferenceData(wb_list, ic_list, ...)

Parsed reference parameters.

MobilisedTestData(imu_data, ...)

Data representation of a single test/recording.

base.ParticipantMetadata	The required minimal set of meta-data for the algorithms.
MobilisedParticipantMetadata	Participant metadata for the Mobilise-D dataset.
base.RecordingMetadata	The required minimal set of recording meta-data for the algorithms.
MobilisedMetadata	Metadata of each individual test/recording.

Docfiller

base_gait_dataset_docfiller(func)

Decorator to fill common parts of the docstring for subclasses of BaseGaitDataset.

matlab_dataset_docfiller(func)

Fill docstring from dictionary.