Function lupnt::WrapToPi(Real)¶
Defined in File math_utils.cc
Function Documentation¶
-
Real lupnt::WrapToPi(Real angle)¶
Wrap angle in radians to [-pi, pi].
Wrap an angle to the range
(-pi, pi]viaatan2(sin(angle), cos(angle)).Used pervasively in
conversions/anomaly_conversions.cc(e.g.EccToMeanAnomaly,MeanToEccAnomaly) and time conversions (e.g.EarthRotationAngle) to keep angular quantities in a canonical range.- Parameters:
angle – Angle in radians
angle – Angle [rad]
- Returns:
Wrapped angle in radians
- Returns:
Wrapped angle [rad] in
(-pi, pi]