API Reference

Ferraris(based) Calibrations

Calibration Classes

Classes to actually calculate calibrations based on the Ferraris method.

FerrarisCalibration(grav, expected_angle, ...)	Calculate a Ferraris calibration matrices based on a set of calibration movements.
TurntableCalibration(grav, expected_angle, ...)	Calculate a Ferraris calibration matrices based on a turntable measurement.

Calibration Info Classes

Class objects representing the calibration results and have methods to apply these calibrations to data, save them to disk and load them again.

FerrarisCalibrationInfo([acc_unit, ...])	Calibration object that represents all the required information to apply a Ferraris calibration to a dataset.
TurntableCalibrationInfo([acc_unit, ...])	Calibration object that represents all the required information to apply a Turntable calibration to a dataset.

Data Preparation Helper

Helper Functions to generate valid input data for Ferraris-like calibrations.

ferraris_regions_from_interactive_plot(data)	Create a Calibration object by selecting the individual signal sections manually in an interactive GUI.
ferraris_regions_from_df(df[, acc_cols, ...])	Create a Calibration object based on a dataframe which has all required sections labeled.
ferraris_regions_from_section_list(data, ...)	Create a Calibration object based on a valid section list.

FerrarisSignalRegions(acc_x_p, acc_x_a, ...)

NamedTuple containing all signal regions required for a Ferraris Calibration.

Calibration File Management

A set of highly opinionated helper functions to store and load calibration files for a medium number of sensors.

load_calibration_info(path[, file_type, ...])	Load any calibration info object from file.
save_calibration_info(cal_info, sensor_id, ...)	Save a calibration info object in the correct format and file name for NilsPods.
find_calibration_info_for_sensor(sensor_id, ...)	Find possible calibration files based on the filename.
find_closest_calibration_info_to_date(...[, ...])	Find the calibration file for a sensor_type, that is closes to a given date.

CalibrationWarning

Indicate potential issues with a calibration.

Legacy Support

Helper functions to import calibration info export from older imucal versions.

load_v1_json_files(path[, base_class])	Load a exported json file that was created using imucal <= 2.0.
load_v1_json(json_str[, base_class])	Load a json string that was created using imucal <= 2.0.

Label GUI

The gui label class. Normally, you do not need to interact with these directly.

Classes

CalibrationGui(acc, gyro, expected_labels[, ...])

A Gui that can be used to label the different required sections of a calibration.

Constants

Base Classes

This is only interesting for developers!

CalibrationInfo([acc_unit, gyr_unit, ...])

Abstract BaseClass for all Calibration Info objects.