gaitmap.utils.datatype_helper: Helper to perform validation of the default datatypes#

A couple of helper functions that easy the use of the typical gaitmap data formats.

Functions#

is_single_sensor_data(data[, check_acc, ...])

Check if an object is a valid dataset following all conventions.

is_multi_sensor_data(data[, check_acc, ...])

Check if an object is a valid multi-sensor data object.

is_sensor_data(data[, check_acc, check_gyr, ...])

Check if an object is valid multi-sensor or single-sensor data.

get_multi_sensor_names(dataset)

Get the list of sensor names from a multi-sensor dataset.

is_single_sensor_stride_list(stride_list[, ...])

Check if an input is a single-sensor stride list.

is_multi_sensor_stride_list(stride_list[, ...])

Check if an input is a multi-sensor stride list.

is_stride_list(stride_list[, stride_type, ...])

Check if an object is a valid multi-sensor or single-sensor stride list.

is_single_sensor_regions_of_interest_list(...)

Check if an input is a single-sensor regions-of-interest list.

is_multi_sensor_regions_of_interest_list(...)

Check if an input is a multi-sensor stride list.

is_regions_of_interest_list(roi_list[, ...])

Check if an object is a valid multi-sensor or single-sensor regions of interest list.

get_single_sensor_regions_of_interest_types(...)

Identify which type of region of interest list is passed by checking the existing columns.

is_single_sensor_orientation_list(...[, ...])

Check if an input is a single-sensor orientation list.

is_multi_sensor_orientation_list(...[, ...])

Check if an input is a multi-sensor orientation list.

is_single_sensor_position_list(position_list)

Check if an input is a single-sensor position list.

is_multi_sensor_position_list(position_list)

Check if an input is a multi-sensor position list.

set_correct_index(df, index_cols[, ...])

Set the correct columns as index, or leave them if they are already in the index.