Skip to content

Commit c297bb1

Browse files
docstring fix
1 parent c27890e commit c297bb1

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

src/smsfusion/_ins_v2.py

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -241,14 +241,14 @@ def _project_velocity_ahead(dvel, v_n, R_nb, dvel_g_corr):
241241
Parameters
242242
----------
243243
dvel : ndarray, shape (3,)
244-
Velocity change vector measurement (sculling integral).
244+
Velocity increment measurement (sculling integral).
245245
v_n : ndarray, shape (3,)
246-
Current velocity estimate expressed in the navigation frame. Will be projected
247-
ahead (in place).
246+
Current velocity estimate expressed in the navigation frame (projected ahead
247+
in place).
248248
R_nb : ndarray, shape (3, 3)
249249
Current rotation matrix from body to navigation frame.
250250
dvel_g_corr : ndarray, shape (3,)
251-
Gravity correction term for the velocity change vector.
251+
Gravity correction.
252252
"""
253253
v_n[:] += R_nb @ dvel + dvel_g_corr
254254

@@ -268,9 +268,9 @@ def _state_transition_matrix(
268268
dt : float
269269
Time step in seconds.
270270
dvel : ndarray, shape (3,)
271-
Velocity change vector (sculling integral).
271+
Velocity increment measurement (sculling integral).
272272
dtheta : ndarray, shape (3,)
273-
Attitude change vector (coning integral).
273+
Attitude increment measurement (coning integral).
274274
R_nb : ndarray, shape (3, 3)
275275
Rotation matrix from body to navigation frame.
276276
gbc : float
@@ -304,9 +304,9 @@ def _update_state_transition_matrix(
304304
phi : ndarray, shape (9, 9)
305305
State transition matrix to be updated in place.
306306
dvel : ndarray, shape (3,)
307-
Velocity change vector (sculling integral).
307+
Velocity increment measurement (sculling integral).
308308
dtheta : ndarray, shape (3,)
309-
Attitude change vector (coning integral).
309+
Attitude increment measurement (coning integral).
310310
R_nb : ndarray, shape (3, 3)
311311
Rotation matrix from body to navigation frame.
312312
"""
@@ -454,9 +454,9 @@ class AHRSv2:
454454
bg : array_like, shape (3,), optional
455455
Initial gyroscope bias estimate (bgx, bgy, bgz) in rad/s. Defaults to zero bias.
456456
dvel : array_like, shape (3,), optional
457-
Initial velocity change vector measurement (sculling integral). Defaults to zero.
457+
Initial velocity increment (sculling integral). Defaults to zero (stationary).
458458
dtheta : array_like, shape (3,), optional
459-
Initial attitude change vector measurement (coning integral). Defaults to zero.
459+
Initial attitude increment (coning integral). Defaults to zero (stationary).
460460
P : array_like, shape (6, 6), optional
461461
Initial (a priori) estimate of the error covariance matrix. Defaults to
462462
a small diagonal matrix (1e-6 * np.eye(9)).
@@ -579,13 +579,13 @@ def bias_gyro(self, degrees=False) -> NDArray[np.float64]:
579579

580580
def dvel(self) -> NDArray[np.float64]:
581581
"""
582-
Previous velocity change vector measurement (sculling integral).
582+
Previous velocity increment measurement (sculling integral).
583583
"""
584584
return self._dvel.copy()
585585

586586
def dtheta(self, degrees=False) -> NDArray[np.float64]:
587587
"""
588-
Previous attitude change vector measurement (coning integral).
588+
Previous bias corrected attitude increment (coning integral).
589589
590590
Parameters
591591
----------
@@ -654,12 +654,12 @@ def update(
654654
Parameters
655655
----------
656656
dvel : array_like, shape (3,), optional
657-
Velocity change vector (sculling integral) in m/s.
657+
Velocity increment (sculling integral) in m/s.
658658
dtheta : array_like, shape (3,), optional
659-
Attitude change vector (coning integral) in radians.
659+
Attitude increment (coning integral) in radians.
660660
degrees : bool, optional
661-
Specifies whether the unit of the attitude change vector, ``dtheta``,
662-
is degrees or radians. Defaults to radians.
661+
Specifies whether the unit of the attitude increment, ``dtheta``, is
662+
degrees or radians. Defaults to radians.
663663
head : float, optional
664664
Heading measurement. I.e., the yaw angle of the 'body' frame relative to the
665665
assumed 'navigation' frame ('NED' or 'ENU') specified during initialization.

0 commit comments

Comments
 (0)