imucal.ferraris_regions_from_section_list

imucal.ferraris_regions_from_section_list(data: DataFrame, section_list: DataFrame, acc_cols: Iterable[str] | None = ('acc_x', 'acc_y', 'acc_z'), gyr_cols: Iterable[str] | None = ('gyr_x', 'gyr_y', 'gyr_z')) → FerrarisSignalRegions

Create a Calibration object based on a valid section list.

A section list marks the start and the endpoints of each required section in the data object. A valid section list is usually created using FerrarisCalibration.from_interactive_plot(). This section list can be stored on disk and this method can be used to turn it back into a valid calibration object.

Parameters:

data

6 column dataframe (3 acc, 3 gyro)

section_list

A pandas dataframe representing a section list

acc_cols

The name of the 3 acceleration columns in order x,y,z. Defaults to FerrarisCalibration.ACC_COLS

gyr_cols

The name of the 3 acceleration columns in order x,y,z. Defaults to FerrarisCalibration.GYRO_COLS

Returns:

ferraris_cal_objFerrarisSignalRegions

See also

ferraris_regions_from_interactive_plot

ferraris_regions_from_df

Examples

>>> import pandas as pd
>>> # Load a valid section list from disk. Note the `index_col=0` to preserve correct format!
>>> section_list = pd.read_csv('./calibration_sections.csv', index_col=0)
>>> sampling_rate = 100 #Hz
>>> df = ... # my data as 6 col pandas dataframe
>>> regions = ferraris_regions_from_section_list(df)
>>> regions
FerrarisSignalRegions(x_a=array([...]), ..., z_rot=array([...]))

Examples using imucal.ferraris_regions_from_section_list

Annotate a session and perform a Ferraris Calibration

Annotate a session and perform a Ferraris Calibration