Cleaning up and documenting scmp code.

This commit is contained in:
2023-10-20 02:59:36 -07:00
parent 4eb4008130
commit b49caa3ec9
12 changed files with 343 additions and 108 deletions

View File

@@ -55,7 +55,6 @@ public:
Madgwick() : deltaT(0.0), previousSensorFrame(), sensorFrame()
{};
/// \brief The Madgwick filter is initialised with a sensor frame.
///
/// \param sf A sensor frame; if zero, the sensor frame will be
@@ -67,7 +66,6 @@ public:
}
}
/// \brief Initialise the filter with a sensor frame quaternion.
///
/// \param sf A quaternion representing the current Orientation.
@@ -75,7 +73,6 @@ public:
deltaT(0.0), previousSensorFrame(), sensorFrame(sf)
{};
/// \brief Return the current orientation as measured by the
/// filter.
///
@@ -86,7 +83,6 @@ public:
return this->sensorFrame;
}
/// \brief Return the filter's rate of angular change from a
/// sensor frame.
///
@@ -152,7 +148,6 @@ public:
this->UpdateFrame(this->sensorFrame + q, delta);
}
/// \brief Update the sensor frame with a gyroscope reading.
///
/// If no Δt is provided, the filter's default is used.
@@ -168,7 +163,6 @@ public:
this->UpdateAngularOrientation(gyro, this->deltaT);
}
/// \brief Retrieve a vector of the Euler angles in ZYX Orientation.
///
/// \return A vector of Euler angles as <ψ, θ, ϕ>.