API Reference#

When working with gaitmap-datasets, you should interact with the highlevel Dataset classes listed below. To better understand which class belongs to which dataset and how to use the respective classes, checkout the README (Getting Started) and the Examples.

If you don’t want to use the High Level API, you can also import the helper module of respective dataset. However, be carefull, when doing that. These low level function might return data formats that might not be in line with the return values of the high-level interface.

EgaitSegmentationValidation2014([...])

Egait stride segmentation validation 2014 dataset.

EgaitParameterValidation2013([data_folder, ...])

Egait parameter validation 2013 dataset.

StairAmbulationHealthy2021PerTest([...])

Dataset class representing the Stair Ambulation dataset.

StairAmbulationHealthy2021Full([...])

Dataclass representing the full sessions of Stair Ambulation dataset not split into individual tests.

SensorPositionComparison2019Segmentation([...])

A dataset for stride segmentation benchmarking.

SensorPositionComparison2019Mocap([...])

A dataset for trajectory benchmarking.

Kluge2017([data_folder, memory, ...])

A dataset to validate spatial-temporal parameters in healthy and PD.

PyShoe2019Vicon([data_folder, groupby_cols, ...])

Dataset helper for the Vicon portion for the PyShoe dataset.

PyShoe2019Hallway([data_folder, ...])

Dataset helper for the hallway portion for the PyShoe dataset.

PyShoe2019Stairs([data_folder, ...])

Dataset helper for the staircase portion for the PyShoe dataset.

General Utility Functions#

convert_segmented_stride_list(stride_list, ...)

Convert a segmented stride list with detected events into other types of stride lists.

Config API#

config()

Get the global config object containing configured paths for the datasets.

set_config([config_obj_or_path])

Set the global config object containing configured paths for the datasets.

reset_config()

Reset the global config to None.

create_config_template(path)

Create a template json file that can be used to configure the datasets paths.

get_dataset_path(dataset_name)

Get the path to a dataset be reading the global config.

DatasetsConfig([...])

Configuration class for the dataset paths.