Skip to content

Commit

Permalink
DOC: improve orientation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MateusStano committed May 16, 2024
1 parent c1864b2 commit a20d31d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions rocketpy/sensors/accelerometer.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,10 @@ def __init__(
Orientation of the sensor in the rocket. The orientation can be
given as:
- A list of length 3, where the elements are the Euler angles for
the rotation roll (φ), pitch (θ) and yaw (ψ) in radians. The
the rotation yaw (ψ), pitch (θ) and roll (φ) in radians. The
standard rotation sequence is z-y-x (3-2-1) is used, meaning the
sensor is first rotated by ψ around the z axis, then by θ around
the new y axis and finally by φ around the new x axis.
sensor is first rotated by ψ around the x axis, then by θ around
the new y axis and finally by φ around the new z axis.
- A list of lists (matrix) of shape 3x3, representing the rotation
matrix from the sensor frame to the rocket frame. The sensor frame
of reference is defined as to have z axis along the sensor's normal
Expand Down
6 changes: 3 additions & 3 deletions rocketpy/sensors/gyroscope.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,10 @@ def __init__(
Orientation of the sensor in the rocket. The orientation can be
given as:
- A list of length 3, where the elements are the Euler angles for
the rotation roll (φ), pitch (θ) and yaw (ψ) in radians. The
the rotation yaw (ψ), pitch (θ) and roll (φ) in radians. The
standard rotation sequence is z-y-x (3-2-1) is used, meaning the
sensor is first rotated by ψ around the z axis, then by θ around
the new y axis and finally by φ around the new x axis.
sensor is first rotated by ψ around the x axis, then by θ around
the new y axis and finally by φ around the new z axis.
- A list of lists (matrix) of shape 3x3, representing the rotation
matrix from the sensor frame to the rocket frame. The sensor frame
of reference is defined as to have z axis along the sensor's normal
Expand Down
6 changes: 3 additions & 3 deletions rocketpy/sensors/sensors.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ def __init__(
Orientation of the sensor in the rocket. The orientation can be
given as:
- A list of length 3, where the elements are the Euler angles for
the rotation roll (φ), pitch (θ) and yaw (ψ) in radians. The
the rotation yaw (ψ), pitch (θ) and roll (φ) in radians. The
standard rotation sequence is z-y-x (3-2-1) is used, meaning the
sensor is first rotated by ψ around the z axis, then by θ around
the new y axis and finally by φ around the new x axis.
sensor is first rotated by ψ around the x axis, then by θ around
the new y axis and finally by φ around the new z axis.
TODO: x and y are not defined in the rocket class. User has no
way to know which axis is which.
- A list of lists (matrix) of shape 3x3, representing the rotation
Expand Down

0 comments on commit a20d31d

Please sign in to comment.