Skip to main content

A Versatile Quaternion-based Filter for IMU Orientation Estimation

Project description

tests build docs version python format license downloads

This is the implementation of the IMU orientation estimation filter described in the following publication:

D. Laidig and T. Seel. “VQF: Highly Accurate IMU Orientation Estimation with Bias Estimation and Magnetic Disturbance Rejection.” Information Fusion 2023, 91, 187–204. doi:10.1016/j.inffus.2022.10.014. [Accepted manuscript available at arXiv:2203.17024.]

The filter can perform simultaneous 6D (magnetometer-free) and 9D (gyr+acc+mag) sensor fusion and can also be used without magnetometer data. Different sampling rates for gyroscopes, accelerometers, and magnetometers are supported as well. While in most cases, the defaults will be reasonable, the algorithm can be influenced via two tuning parameters.

Documentation

Detailed documentation can be found at https://vqf.readthedocs.io/.

Installation

The VQF Python package can easily be installed from PyPI via pip, e.g.:

pip install vqf

For more information, please refer to the documentation.

License

VQF is licensed under the terms of the MIT license.

Contact

Daniel Laidig <laidig at control.tu-berlin.de>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vqf-2.0.0.tar.gz (273.9 kB view hashes)

Uploaded Source

Built Distributions

vqf-2.0.0-cp311-cp311-win_amd64.whl (243.3 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

vqf-2.0.0-cp311-cp311-win32.whl (220.8 kB view hashes)

Uploaded CPython 3.11 Windows x86

vqf-2.0.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.1 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

vqf-2.0.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

vqf-2.0.0-cp311-cp311-macosx_11_0_arm64.whl (288.6 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

vqf-2.0.0-cp311-cp311-macosx_10_9_x86_64.whl (326.4 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

vqf-2.0.0-cp311-cp311-macosx_10_9_universal2.whl (556.7 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)

vqf-2.0.0-cp310-cp310-win_amd64.whl (248.1 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

vqf-2.0.0-cp310-cp310-win32.whl (225.0 kB view hashes)

Uploaded CPython 3.10 Windows x86

vqf-2.0.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.1 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

vqf-2.0.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

vqf-2.0.0-cp310-cp310-macosx_11_0_arm64.whl (291.3 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

vqf-2.0.0-cp310-cp310-macosx_10_9_x86_64.whl (329.8 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

vqf-2.0.0-cp310-cp310-macosx_10_9_universal2.whl (562.9 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64)

vqf-2.0.0-cp39-cp39-win_amd64.whl (249.5 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

vqf-2.0.0-cp39-cp39-win32.whl (226.2 kB view hashes)

Uploaded CPython 3.9 Windows x86

vqf-2.0.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.1 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

vqf-2.0.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

vqf-2.0.0-cp39-cp39-macosx_11_0_arm64.whl (292.6 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

vqf-2.0.0-cp39-cp39-macosx_10_9_x86_64.whl (331.3 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

vqf-2.0.0-cp39-cp39-macosx_10_9_universal2.whl (565.8 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ universal2 (ARM64, x86-64)

vqf-2.0.0-cp38-cp38-win_amd64.whl (250.2 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

vqf-2.0.0-cp38-cp38-win32.whl (226.9 kB view hashes)

Uploaded CPython 3.8 Windows x86

vqf-2.0.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.1 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

vqf-2.0.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

vqf-2.0.0-cp38-cp38-macosx_11_0_arm64.whl (288.2 kB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

vqf-2.0.0-cp38-cp38-macosx_10_9_x86_64.whl (324.7 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

vqf-2.0.0-cp38-cp38-macosx_10_9_universal2.whl (554.0 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ universal2 (ARM64, x86-64)

vqf-2.0.0-cp37-cp37m-win_amd64.whl (239.0 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

vqf-2.0.0-cp37-cp37m-win32.whl (218.6 kB view hashes)

Uploaded CPython 3.7m Windows x86

vqf-2.0.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (985.8 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

vqf-2.0.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (928.7 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

vqf-2.0.0-cp37-cp37m-macosx_10_9_x86_64.whl (320.7 kB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page