Recent Releases of imucal - A Python library to calibrate 6 DOF IMUs
imucal - A Python library to calibrate 6 DOF IMUs - v2.6.0 - Figure size fix
[2.6.0] - 31.10.2024
- Added the option to control the initial figure size of the interactive plot. This should help resolve #24
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 1 year ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.5.0 - GUI QoL Improvements
[2.5.0] - 31.10.2024
- Tooling overhaul to make the development process easier and fix doc building issues
- A bunch of quality of life improvements for the GUI. You can now use shortcuts (o, p, h, b, and f) to activate the matplib tools for zooming, panning, home, back, and forward. Once zoomed in, you can use the scrollwheel to scroll along the x-axis. The first section is also activated by default now, so you can start labeling right away.
- Updated minimal versions of dependencies. Notable: pandas >=2.0, python >=3.9
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 1 year ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.4.0 - Better dev tooling
[2.4.0] - 26.05.2023
- Tooling overhal to make the development process easier and fix doc building issues
- Changed some ValueError to TypeError
Scientific Software - Peer-reviewed
- Python
Published by AKuederle about 3 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.3.1
[2.3.1] - 17.10.2022
- Fixed import so that no tkinter or matplotlib are required when the GUI is not required
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 3 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.3.0
[2.3.0] - 17.10.2022
- Removed upper version bounds to reduce the chance of version conflicts
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 3 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.2.1 - Joss Paper
- Some minor updates to README.md
- Improved the doc building process: No additional requirements.txt file!
- JOSS paper accepted! :)
Scientific Software - Peer-reviewed
- Python
Published by AKuederle about 4 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.2.0
- Dropped support for
h5py< 3.0.0. This should only affect users using the hdf5 export feature. Dropping old versions allows for proper support of Python 3.10.
Scientific Software - Peer-reviewed
- Python
Published by AKuederle about 4 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.1.1
Scientific Software - Peer-reviewed
- Python
Published by AKuederle about 4 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.1.0 - Joss submission
[2.1.0] - 08.03.2022
- switched from
distutilstopackagingfor version handling. - Added a paper describing the basics of imucal for submission in JOSS
- Fixed small issues in README and docs
- manual gui test is working again
- dependency updates
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 4 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.0.2 - Zenodo Release
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 4 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.0.1 - Bug Fix for Docker
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 5 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v2.0.0 Major rewrite and breaking changes (READ CHANGELOG)
[2.0] - 09.01.2021
2.0 is a rewrite of a lot of the API and requires multiple changes to legacy code using this library. Please refer to the migration guide for more information. During this refactoring multiple bugs were fixed as well. Therefore, it is highly suggested upgrading to the new version, even if it takes some work!
Added
- A new
calibrate_dfmethod for theCalibrationInfothat can calibrate df directly. - It is now possible to define which
CalibrationInfosubclass should be used by theFerrarisCalibration - A set of "management" functions to save, find, and load IMU calibrations of multiple sensors
- The ability to add a custom comment to a
CalibrationInfo - The user is now forced to provide the units of the input data to avoid applying calibrations that were meant for unit conversion.
- Applying a calibration now checks if the units of your data match with the input unit of the calibration.
- The export format of calibration-info objects is now versioned. This helps to make changes to the format in the future while still supporting old exports. See the migration guide for more information.
- Helper functions to load "legacy" calibration info objects. (
imucal.legacy)
Changed
FerrarisCalibrationhas a new interface. Instead of providing all calibration and data related parameters in the__init__, the__init__is now only used to configure the calibration. The data and all data related parameter are now passed to thecomputemethod (replacescompute_calibration_matrix)- Using
from_...constructors on a subclass ofCalibrationInfodoes not search all subclasses ofCalibrationInfoanymore, but only the subclasses (and the class itself), it is called on. For example,FerrarisCalibrationInfo.from_jsonwill only consider subclasses ofFerrarisCalibrationInfo, but not other subclasses ofCalibrationInfo. - The short hand "gyro" is not replaced with "gyr" in all parameter and variable names. This might cause an issue when loading old calibration files.
Deprecated
Removed
FerrarisCalibrationdoes not have anyfrom_...constructors anymore. The functionality of these constructors can now be accessed via theferraris_regions_from_...helper functions.- It is not possible anymore to calibrate the acc and gyro separately. No one was using this feature, and hence, was removed to simplify the API.
Fixed
Migration Guide
- The main change is how
FerrarisCalibrationandTurntableCalibrationare used. Before you would do: ```python from imucal import FerrarisCalibration
cal, sectionlist = FerrarisCalibration.frominteractiveplot(data, samplingrate=samplingrate) calinfo = cal.computecalibrationmatrix() ```
Now you need to first create your Ferraris sections and then provide them as arguments for the compute method:
```python from imucal import FerrarisCalibration, ferrarisregionsfrominteractiveplot
sections, sectionlist = ferrarisregionsfrominteractiveplot(data) cal = FerrarisCalibration() calinfo = cal.compute(sections, samplingratehz=samplingrate, fromaccunit="m/s^2", fromgyr_unit="deg/s") ```
Note, that you are also forced to provide the units of the input data.
We always recommend to first turn your data into the same units you would expect after the calibration and then using
the calibrations as refinement.
- CalibrationInfot.calibrate now requires you to specify the units of your data and validates that they match the
units expected by the calibration.
You need to add the parameters acc_unit and gyr_unit to all calls to calibrate.
Note, that older calibrations will not have from units and hence, can not perform this check.
In this case you can set the units to None to avoid an error.
However, it is recommended to recreate the calibrations with proper from units.
- If you were using from_json_file before, double check, if this still works for you, as the way the correct baseclass
is selected have been chosen.
In any case, you should consider to use imucal.management.load_calibration_info instead, as it is more flexible.
- If you were using any parameters or package variables, that contained the short hand gyro, replace it with gyr.
Note that this also effects the exported calibration files.
You will not be able to load them unless you replace gyro_unit with gyr_unit in all files.
- The CalibrationInfo objects now have more fields by default.
To avoid issues with missing values, we highly recommend recreating all calibration files you have using the original
session data and the most current version of imucal.
Alternatively you can use the functions provided in imucal.legacy to load the old
calibration.
Then you can modify the loaded calibration info object and save it again to replace the old calibration.
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 5 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v1.1.0
So far the units on the calibration object were not corretly written to file and read from there. This is done now. However, they are still not used in any other way besides documentation
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 5 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v1.0.1
Fixed a bug with newer matplotlib version with the GUI
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 5 years ago
imucal - A Python library to calibrate 6 DOF IMUs - v1.0.0 First official release
imucal goes open-source!
Scientific Software - Peer-reviewed
- Python
Published by AKuederle over 5 years ago