Add property geodetic_vector to class WMM.

Mayitzin · Sep 14, 2023 · a887d95 · a887d95
1 parent c77f350
commit a887d95
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/ahrs/utils/wmm.py b/ahrs/utils/wmm.py
@@ -881,3 +881,19 @@ def magnetic_elements(self) -> Dict[str, float]:
         'D': -9.73078560629778, 'GV': -9.73078560629778}
         """
         return {k: self.__dict__[k] for k in ['X', 'Y', 'Z', 'H', 'F', 'I', 'D', 'GV']}
+
+    @property
+    def geodetic_vector(self) -> np.ndarray:
+        """
+        Magnetic field vector in geodetic coordinates
+
+        The magnetic field vector is returned as a 3D vector in geodetic
+        coordinates.
+
+        Example
+        -------
+        >>> wmm = WMM(datetime.date(2017, 5, 12), latitude=10.0, longitude=-20.0, height=10.5)
+        >>> wmm.geodetic_vector
+        array([ 30499.64046961,  -5230.26715847,  -1716.63331136])
+        """
+        return np.array([self.X, self.Y, self.Z])