Skip to content

Commit aa3318f

Browse files
committed
Added use-magnetometer to docstirng
1 parent 5927ca9 commit aa3318f

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

gaitmap/trajectory_reconstruction/trajectory_methods/_rts_kalman.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,9 @@ class MadgwickRtsKalman(RtsKalman):
334334
A high value should only be used if the sensor is moved slowly.
335335
A value of 0 is identical to just the Gyro Integration (i.e. identical to the
336336
:class:`~gaitmap.trajectory_reconstruction.RtsKalman`).
337+
use_magnetometer
338+
Flag to control if the magnetometer should be used in the Madgwick filter.
339+
If True, the data is expected to have the `mag_x, mag_y, mag_z` columns.
337340
338341
Attributes
339342
----------

0 commit comments

Comments
 (0)