Tracker using kinematic Kalman filters.
Project description
Kinematic Tracker
📖 Live docs: https://kovalp.github.io/kinematic-tracker-docs/
This tracker is based on kinematic Kalman filters. The system state can consist of multiple parts,
each defined by its kinematic order and dimensionality. For example, to track cuboids
aligned with Cartesian axes, we might decide for a constant-acceleration motion model
for Cartesian coordinates and a constant-position motion model for the sizes of the cuboids.
This choice encoded by orders = [3, 1]. The dimensionality of both parts (coordinates and sizes)
is 3. Therefore dimensions = [3, 3] in our example.
The state of the cuboids aligned with Cartesian axis will have 12 variables. Internally, a block-diagonal states are used, i.e.
state = p_x, v_x, a_x, p_y, v_y, a_y, p_z, v_z, a_z, s_x, s_y, s_z
To simplify the input/output processing, one might find attractive a derivative-sorted order
state = p_x, p_y, p_z, s_x, s_y, s_z, v_x, v_y, v_z, a_x, a_y, a_z
This package provides utility classes for such conversion (block-diagonal ↔ derivative sorted).
Process noise models
The tracker supports various process noise models, including a custom adaptive process noise model based on a white-noise assumption.
Association metrics
A number of association metrics are implemented. Some of the metrics are experimental.
- Mahalanobis with a process-measurement noise sum covariance (HPH + R) -- default.
- 3D axes-aligned GIoU (volumetric GIoU for cuboids).
- 3D yaw-only GIoU (volumetric GIoU for cuboids oriented by yaw).
- Mahalanobis with size-modulated covariance (experimental).
- IoU-like two-yaw (experimental): based on Mahalanobis distance with diagonal covariance.
Installation
If you plan to use OpenCV with HighGUI, then
pip install kinematic-tracker[gui]
If you do not plan to use OpenCV's GUI, then
pip install kinematic-tracker[headless]
In any case, you choose one extra: gui or headless.
Usage
Simple examples are available in the test/tutorials folder.
The test folder is available in the source package
pip download kinematic-tracker --no-binary :all: --no-deps
Use the kinematic-tracker as dependency
uv add kinematic-tracker --extra headless
If you happen to need GUI-enabled version of OpenCV, then
uv add kinematic-tracker --extra gui
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kinematic_tracker-21.0.0.tar.gz.
File metadata
- Download URL: kinematic_tracker-21.0.0.tar.gz
- Upload date:
- Size: 268.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
be6d379717c4d9af34bc0fe3a1966d498313d7dff6d513a73e81780f020c7902
|
|
| MD5 |
6d226f88546533fee5e773cb07b32380
|
|
| BLAKE2b-256 |
a7d317ff9eb5171d6068a8af62b239fd59426b05b99ce9f36e45e12c9d1cd511
|
File details
Details for the file kinematic_tracker-21.0.0-py3-none-any.whl.
File metadata
- Download URL: kinematic_tracker-21.0.0-py3-none-any.whl
- Upload date:
- Size: 59.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8951e60907db8458e63308fa4d6250d458fb22f57953bbda90282b3ba5423b19
|
|
| MD5 |
1bb46140d4564913d1783a110bd0b190
|
|
| BLAKE2b-256 |
76ab44b2ea15ec003892aaf17f20bea04bf40c6f517583640ab56b25fb7bbbbe
|
