refactor!: rename nadir_pointing profile to local_orbital_frame (#484)

* refactor!: rename nadir_pointing profile to local_orbital_frame * feat: apply feedback * feat: fix tests
open-space-collective · Jan 6, 2025 · ef11d30 · ef11d30
1 parent da2b98f
commit ef11d30
Show file tree

Hide file tree

Showing 28 changed files with 46 additions and 39 deletions.
diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile.cpp
@@ -321,17 +321,17 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile(pybind11::module& aMo
         )
 
         .def_static(
-            "nadir_pointing",
-            &Profile::NadirPointing,
+            "local_orbital_frame_pointing",
+            &Profile::LocalOrbitalFramePointing,
             R"doc(
-                Create a nadir pointing profile.
+                Create a profile aligned with the provided local orbital frame type.
 
                 Args:
                     orbit (Orbit): The orbit.
                     orbital_frame_type (OrbitalFrameType): The type of the orbital frame.
 
                 Returns:
-                    Profile: The nadir pointing profile.
+                    Profile: The profile aligned with the local orbital frame.
             )doc",
             arg("orbit"),
             arg("orbital_frame_type")

diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model/Transform.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model/Transform.cpp
@@ -116,7 +116,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Model_Transform(pybin
                 Create a transform for inertial pointing.
 
                 Args:
-                    trajectory (Trajectory): The trajectory to point at.
+                    trajectory (Trajectory): The trajectory of the satellite.
                     quaternion (Quaternion): The quaternion to rotate the axes by.
 
                 Returns:
@@ -127,17 +127,17 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Model_Transform(pybin
         )
 
         .def_static(
-            "nadir_pointing",
-            &Transform::NadirPointing,
+            "local_orbital_frame_pointing",
+            &Transform::LocalOrbitalFramePointing,
             R"doc(
-                Create a transform for nadir pointing.
+                Create a profile aligned with the provided local orbital frame type.
 
                 Args:
-                    orbit (Orbit): The orbit to point at.
+                    orbit (Orbit): The orbit of the satellite.
                     orbital_frame_type (OrbitalFrameType): The type of the orbital frame.
 
                 Returns:
-                    Transform: The transform for nadir pointing.
+                    Transform: The transform for the local orbital frame pointing.
              )doc",
             arg("orbit"),
             arg("orbital_frame_type")

diff --git a/bindings/python/test/flight/test_profile.py b/bindings/python/test/flight/test_profile.py
@@ -192,11 +192,13 @@ def test_inertial_pointing(self):
         assert isinstance(profile, Profile)
         assert profile.is_defined()
 
-    def test_nadir_pointing(
+    def test_local_orbital_frame_pointing(
         self,
         orbit: Orbit,
     ):
-        profile: Profile = Profile.nadir_pointing(orbit, Orbit.FrameType.VVLH)
+        profile: Profile = Profile.local_orbital_frame_pointing(
+            orbit, Orbit.FrameType.VVLH
+        )
 
         assert profile is not None
         assert isinstance(profile, Profile)

diff --git a/bindings/python/test/test_viewer.py b/bindings/python/test/test_viewer.py
@@ -38,7 +38,7 @@ def orbit(environment: Environment) -> Orbit:
 
 @pytest.fixture
 def profile(orbit: Orbit) -> Profile:
-    return Profile.nadir_pointing(
+    return Profile.local_orbital_frame_pointing(
         orbit=orbit,
         orbital_frame_type=Orbit.FrameType.VVLH,
     )

diff --git a/include/OpenSpaceToolkit/Astrodynamics/Flight/Profile.hpp b/include/OpenSpaceToolkit/Astrodynamics/Flight/Profile.hpp
@@ -287,12 +287,12 @@ class Profile
     /// @return Flight profile
     static Profile InertialPointing(const Trajectory& aTrajectory, const Quaternion& aQuaternion);
 
-    /// @brief Constructs a flight profile with nadir pointing
+    /// @brief Constructs a flight profile with local orbital frame pointing
     ///
     /// @param anOrbit An orbit
     /// @param anOrbitalFrameType An orbital frame type
     /// @return Flight profile
-    static Profile NadirPointing(
+    static Profile LocalOrbitalFramePointing(
         const trajectory::Orbit& anOrbit, const trajectory::Orbit::FrameType& anOrbitalFrameType
     );
 

diff --git a/include/OpenSpaceToolkit/Astrodynamics/Flight/Profile/Model/Transform.hpp b/include/OpenSpaceToolkit/Astrodynamics/Flight/Profile/Model/Transform.hpp
@@ -71,12 +71,12 @@ class Transform : public virtual Model
     /// @return Flight profile
     static Transform InertialPointing(const Trajectory& aTrajectory, const Quaternion& aQuaternion);
 
-    /// @brief Constructs a flight profile with nadir pointing
+    /// @brief Constructs a flight profile with local orbital frame pointing
     ///
     /// @param anOrbit An orbit
     /// @param anOrbitalFrameType An orbital frame type
     /// @return Flight profile
-    static Transform NadirPointing(
+    static Transform LocalOrbitalFramePointing(
         const trajectory::Orbit& anOrbit, const trajectory::Orbit::FrameType& anOrbitalFrameType
     );
 

diff --git a/src/OpenSpaceToolkit/Astrodynamics/Flight/Profile.cpp b/src/OpenSpaceToolkit/Astrodynamics/Flight/Profile.cpp
@@ -216,9 +216,11 @@ Profile Profile::InertialPointing(const Trajectory& aTrajectory, const Quaternio
     return {TransformModel::InertialPointing(aTrajectory, aQuaternion)};
 }
 
-Profile Profile::NadirPointing(const trajectory::Orbit& anOrbit, const trajectory::Orbit::FrameType& anOrbitalFrameType)
+Profile Profile::LocalOrbitalFramePointing(
+    const trajectory::Orbit& anOrbit, const trajectory::Orbit::FrameType& anOrbitalFrameType
+)
 {
-    return {TransformModel::NadirPointing(anOrbit, anOrbitalFrameType)};
+    return {TransformModel::LocalOrbitalFramePointing(anOrbit, anOrbitalFrameType)};
 }
 
 Profile Profile::CustomPointing(

diff --git a/src/OpenSpaceToolkit/Astrodynamics/Flight/Profile/Model/Transform.cpp b/src/OpenSpaceToolkit/Astrodynamics/Flight/Profile/Model/Transform.cpp
@@ -164,7 +164,7 @@ Transform Transform::InertialPointing(const Trajectory& aTrajectory, const Quate
     return {dynamicTransformProvider, Frame::GCRF()};
 }
 
-Transform Transform::NadirPointing(
+Transform Transform::LocalOrbitalFramePointing(
     const trajectory::Orbit& anOrbit, const trajectory::Orbit::FrameType& anOrbitalFrameType
 )
 {

diff --git a/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile.test.cpp b/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile.test.cpp
@@ -103,7 +103,7 @@ class OpenSpaceToolkit_Astrodynamics_Flight_Profile : public ::testing::Test
 
         this->orbit_ = {keplerianModel, environment.accessCelestialObjectWithName("Earth")};
 
-        this->profile_ = Profile::NadirPointing(this->orbit_, Orbit::FrameType::VVLH);
+        this->profile_ = Profile::LocalOrbitalFramePointing(this->orbit_, Orbit::FrameType::VVLH);
     }
 
     Orbit orbit_ = Orbit::Undefined();
@@ -382,7 +382,7 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, InertialPointing)
 }
 
 // TBI: Should move these tests to the Transform test suite and only test interface here
-TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, NadirPointing_VVLH)
+TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, LocalOrbitalFramePointing_VVLH)
 {
     // VVLH #1
 
@@ -410,7 +410,7 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, NadirPointing_VVLH)
 
         const Orbit orbit = {keplerianModel, environment.accessCelestialObjectWithName("Earth")};
 
-        const Profile profile = Profile::NadirPointing(orbit, Orbit::FrameType::VVLH);
+        const Profile profile = Profile::LocalOrbitalFramePointing(orbit, Orbit::FrameType::VVLH);
 
         const Real positionTolerance_m = 1e-3;
         const Real velocityTolerance_meterPerSec = 1e-6;
@@ -419,9 +419,10 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, NadirPointing_VVLH)
 
         // Reference data setup
 
-        const File referenceDataFile =
-            File::Path(Path::Parse("/app/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/NadirPointing/VVLH/"
-                                   "Satellite_1 t_UTC x_GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv"));
+        const File referenceDataFile = File::Path(
+            Path::Parse("/app/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/LocalOrbitalFramePointing/VVLH/"
+                        "Satellite_1 t_UTC x_GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv")
+        );
 
         const Table referenceData = Table::Load(referenceDataFile, Table::Format::CSV, true);
 
@@ -520,7 +521,7 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, NadirPointing_VVLH)
 
         const Orbit orbit = {keplerianModel, environment.accessCelestialObjectWithName("Earth")};
 
-        const Profile profile = Profile::NadirPointing(orbit, Orbit::FrameType::VVLH);
+        const Profile profile = Profile::LocalOrbitalFramePointing(orbit, Orbit::FrameType::VVLH);
 
         const Real positionTolerance_m = 1e-3;
         const Real velocityTolerance_meterPerSec = 1e-6;
@@ -529,9 +530,10 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, NadirPointing_VVLH)
 
         // Reference data setup
 
-        const File referenceDataFile =
-            File::Path(Path::Parse("/app/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/NadirPointing/VVLH/"
-                                   "Satellite_2 t_UTC x_GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv"));
+        const File referenceDataFile = File::Path(
+            Path::Parse("/app/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/LocalOrbitalFramePointing/VVLH/"
+                        "Satellite_2 t_UTC x_GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv")
+        );
 
         const Table referenceData = Table::Load(referenceDataFile, Table::Format::CSV, true);
 
@@ -630,7 +632,7 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, NadirPointing_VVLH)
 
         const Orbit orbit = {keplerianModel, environment.accessCelestialObjectWithName("Earth")};
 
-        const Profile profile = Profile::NadirPointing(orbit, Orbit::FrameType::VVLH);
+        const Profile profile = Profile::LocalOrbitalFramePointing(orbit, Orbit::FrameType::VVLH);
 
         const Real positionTolerance_m = 1e-3;
         const Real velocityTolerance_meterPerSec = 1e-6;
@@ -639,9 +641,10 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, NadirPointing_VVLH)
 
         // Reference data setup
 
-        const File referenceDataFile =
-            File::Path(Path::Parse("/app/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/NadirPointing/VVLH/"
-                                   "Satellite_3 t_UTC x_GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv"));
+        const File referenceDataFile = File::Path(
+            Path::Parse("/app/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/LocalOrbitalFramePointing/VVLH/"
+                        "Satellite_3 t_UTC x_GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv")
+        );
 
         const Table referenceData = Table::Load(referenceDataFile, Table::Format::CSV, true);
 
@@ -988,7 +991,7 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile, CustomPointing)
 
         // Compare against Orbit VNC frame which has been validated
 
-        const Profile expectedProfile = Profile::NadirPointing(orbit, Orbit::FrameType::VNC);
+        const Profile expectedProfile = Profile::LocalOrbitalFramePointing(orbit, Orbit::FrameType::VNC);
 
         for (const auto instant :
              Interval::Closed(epoch, epoch + Duration::Hours(1.0)).generateGrid(Duration::Minutes(5.0)))

diff --git a/...ofile/NadirPointing/Scenario/Satellite.sa → ...rbitalFramePointing/Scenario/Satellite.sa b/...ofile/NadirPointing/Scenario/Satellite.sa → ...rbitalFramePointing/Scenario/Satellite.sa
diff --git a/...file/NadirPointing/Scenario/Satellite.sa3 → ...bitalFramePointing/Scenario/Satellite.sa3 b/...file/NadirPointing/Scenario/Satellite.sa3 → ...bitalFramePointing/Scenario/Satellite.sa3
diff --git a/...file/NadirPointing/Scenario/Satellite1.sa → ...bitalFramePointing/Scenario/Satellite1.sa b/...file/NadirPointing/Scenario/Satellite1.sa → ...bitalFramePointing/Scenario/Satellite1.sa
diff --git a/...ile/NadirPointing/Scenario/Satellite1.sa3 → ...italFramePointing/Scenario/Satellite1.sa3 b/...ile/NadirPointing/Scenario/Satellite1.sa3 → ...italFramePointing/Scenario/Satellite1.sa3
diff --git a/...ile/NadirPointing/Scenario/Satellite_1.sa → ...italFramePointing/Scenario/Satellite_1.sa b/...ile/NadirPointing/Scenario/Satellite_1.sa → ...italFramePointing/Scenario/Satellite_1.sa
diff --git a/...le/NadirPointing/Scenario/Satellite_1.sa3 → ...talFramePointing/Scenario/Satellite_1.sa3 b/...le/NadirPointing/Scenario/Satellite_1.sa3 → ...talFramePointing/Scenario/Satellite_1.sa3
diff --git a/...ile/NadirPointing/Scenario/Satellite_2.sa → ...italFramePointing/Scenario/Satellite_2.sa b/...ile/NadirPointing/Scenario/Satellite_2.sa → ...italFramePointing/Scenario/Satellite_2.sa
diff --git a/...le/NadirPointing/Scenario/Satellite_2.sa3 → ...talFramePointing/Scenario/Satellite_2.sa3 b/...le/NadirPointing/Scenario/Satellite_2.sa3 → ...talFramePointing/Scenario/Satellite_2.sa3
diff --git a/...ile/NadirPointing/Scenario/Satellite_3.sa → ...italFramePointing/Scenario/Satellite_3.sa b/...ile/NadirPointing/Scenario/Satellite_3.sa → ...italFramePointing/Scenario/Satellite_3.sa
diff --git a/...le/NadirPointing/Scenario/Satellite_3.sa3 → ...talFramePointing/Scenario/Satellite_3.sa3 b/...le/NadirPointing/Scenario/Satellite_3.sa3 → ...talFramePointing/Scenario/Satellite_3.sa3
diff --git a/...ting/Scenario/Scenario STK ScenarioWB.wsp → ...ting/Scenario/Scenario STK ScenarioWB.wsp b/...ting/Scenario/Scenario STK ScenarioWB.wsp → ...ting/Scenario/Scenario STK ScenarioWB.wsp
diff --git a/...ng/Scenario/Scenario STK ScenarioWB.wsptb → ...ng/Scenario/Scenario STK ScenarioWB.wsptb b/...ng/Scenario/Scenario STK ScenarioWB.wsptb → ...ng/Scenario/Scenario STK ScenarioWB.wsptb
diff --git a/...rofile/NadirPointing/Scenario/Scenario.sc → ...OrbitalFramePointing/Scenario/Scenario.sc b/...rofile/NadirPointing/Scenario/Scenario.sc → ...OrbitalFramePointing/Scenario/Scenario.sc
diff --git a/...ofile/NadirPointing/Scenario/Scenario.sc3 → ...rbitalFramePointing/Scenario/Scenario.sc3 b/...ofile/NadirPointing/Scenario/Scenario.sc3 → ...rbitalFramePointing/Scenario/Scenario.sc3
diff --git a/...inting/Scenario/ScenarioTimelinePrefs.xml → ...inting/Scenario/ScenarioTimelinePrefs.xml b/...inting/Scenario/ScenarioTimelinePrefs.xml → ...inting/Scenario/ScenarioTimelinePrefs.xml
diff --git a/...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv → ...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv b/...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv → ...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv
diff --git a/...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv → ...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv b/...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv → ...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv
diff --git a/...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv → ...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv b/...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv → ...GCRF v_GCRF q_B_GCRF w_B_GCRF_in_GCRF.csv
diff --git a/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/Transform.test.cpp b/test/OpenSpaceToolkit/Astrodynamics/Flight/Profile/Transform.test.cpp
@@ -76,7 +76,7 @@ class OpenSpaceToolkit_Astrodynamics_Flight_Profile_Models_Transform : public ::
 
         this->orbit_ = {keplerianModel, environment.accessCelestialObjectWithName("Earth")};
 
-        this->transform_ = Transform::NadirPointing(this->orbit_, Orbit::FrameType::VVLH);
+        this->transform_ = Transform::LocalOrbitalFramePointing(this->orbit_, Orbit::FrameType::VVLH);
     }
 
     Orbit orbit_ = Orbit::Undefined();
@@ -101,7 +101,7 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile_Models_Transform, Construct
         );
     };
 
-    EXPECT_NO_THROW(Transform transform_ (DynamicProvider(dynamicProviderGenerator), Frame::GCRF()));
+    EXPECT_NO_THROW(Transform transform_(DynamicProvider(dynamicProviderGenerator), Frame::GCRF()));
 }
 
 TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile_Models_Transform, StreamOperator)
@@ -209,9 +209,9 @@ TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile_Models_Transform, InertialP
     }
 }
 
-TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile_Models_Transform, NadirPointing)
+TEST_F(OpenSpaceToolkit_Astrodynamics_Flight_Profile_Models_Transform, LocalOrbitalFramePointing)
 {
     {
-        EXPECT_TRUE(Transform::NadirPointing(orbit_, Orbit::FrameType::VVLH).isDefined());
+        EXPECT_TRUE(Transform::LocalOrbitalFramePointing(orbit_, Orbit::FrameType::VVLH).isDefined());
     }
 }