open-space-toolkit-astrodynamics 15.0.0__py310-none-manylinux2014_x86_64.whl → 15.1.0__py310-none-manylinux2014_x86_64.whl

{open_space_toolkit_astrodynamics-15.0.0.dist-info → open_space_toolkit_astrodynamics-15.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: open-space-toolkit-astrodynamics
-Version: 15.0.0
+Version: 15.1.0
 Summary: Orbit, attitude, access.
 Author: Open Space Collective
 Author-email: contact@open-space-collective.org

{open_space_toolkit_astrodynamics-15.0.0.dist-info → open_space_toolkit_astrodynamics-15.1.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 ostk/__init__.py,sha256=epnVn2PwdQkUDZ1msqBRO5nEZIOUBIq-IfK3IlNPijE,21
 ostk/astrodynamics/OpenSpaceToolkitAstrodynamicsPy.cpython-310-x86_64-linux-gnu.so,sha256=gYM0JjMm4ZqA-zE01ki8UIBkTPFGOOYoRBCeWOddkI4,2631776
 ostk/astrodynamics/__init__.py,sha256=3gWyqFIbhAfcdeMhmfBPQPlPQTmaOzm-6flkJe745Zk,251
-ostk/astrodynamics/__init__.pyi,sha256=tfxDvws_Zrse_YY4O45u-DL4TJT4AAB7fyG_AIOpbIA,32231
+ostk/astrodynamics/__init__.pyi,sha256=bR00BMMwv8B3E2WWEpnVJ_afWHWHr93CUvU5FeHPg3c,32231
 ostk/astrodynamics/access.pyi,sha256=0GAFCSoMHT3L8wWOxU1-3ELqR7YGyEkt6wlpaL7UXzI,25313
 ostk/astrodynamics/converters.py,sha256=luPh30qMp9bzEkN7hUccmxlLf7zRp_AzqmBe8IUjPhU,3314
 ostk/astrodynamics/converters.pyi,sha256=HrZFyizkc6Hv_K38ZKZ80fX_bAxd6keA_NFWNQygvbs,1745
@@ -13,7 +13,7 @@ ostk/astrodynamics/guidance_law.pyi,sha256=pEoAL9CDFWNulOLv6wea3xj1fJI3xFtgx-2eY
 ostk/astrodynamics/libopen-space-toolkit-astrodynamics.so.15,sha256=_YtpT-mc45lP9dFMoUZvxx5Hw8zQZs75QIwmFJS8VEU,101370512
 ostk/astrodynamics/solver.pyi,sha256=ugi73KdRXPKFvKXFMpYKIwxYUGC2KEMlBiLv0PFcigM,9746
 ostk/astrodynamics/utilities.py,sha256=mlKL3WrOASrY_pLt7bzUz0XZT7jagzLOZjMOIqjbQ1Y,6999
-ostk/astrodynamics/viewer.py,sha256=tmkHe4K4oQ2739ETdPDu8-3YtWhgLtFLMwbenxIu1VU,12670
+ostk/astrodynamics/viewer.py,sha256=SpcvBqXx3CAZpk7UGOPT1ilxywmAmNpgqpuRY11Hwx0,16376
 ostk/astrodynamics/conjunction/__init__.pyi,sha256=HFvWl8bCmrq3cBkUh5X5RGIh8webmVGxaZdpsz3WN-E,79
 ostk/astrodynamics/conjunction/message/__init__.pyi,sha256=5H__sg_QUx7ybf9jtVWvXzrUHeK3ECotfhddAdHjJUc,75
 ostk/astrodynamics/conjunction/message/ccsds.pyi,sha256=3FCWOnInqwI5FKfodR4-xYuiBS0UzemoIXsc1GWPDQI,28690
@@ -38,7 +38,7 @@ ostk/astrodynamics/test/test_import.py,sha256=py_hALBR0IYuUzv9dfgQZzrrLHJIpnyKvt
 ostk/astrodynamics/test/test_root_solver.py,sha256=hQ8O6g-WP49gZH_H3Rdufv0F0gQorpzJyIcjBGGUQ34,1831
 ostk/astrodynamics/test/test_trajectory.py,sha256=0sgGPkMFy-u-33z6SF-sTvaBb_NU7OvaeMTVF6wevfY,3148
 ostk/astrodynamics/test/test_utilities.py,sha256=NNIyzqOxMdsNpK2z0wU0utX06iZNfbMJDE36Upard28,3048
-ostk/astrodynamics/test/test_viewer.py,sha256=rfA6daUqtATtaA2daE_kFWNK4oBBHreR5DKeXRKC-j0,6582
+ostk/astrodynamics/test/test_viewer.py,sha256=kDstRH_WKufN_0JPSXttzLMk3Afv_ylcEBfHxc35yrA,8946
 ostk/astrodynamics/test/access/__init__.py,sha256=epnVn2PwdQkUDZ1msqBRO5nEZIOUBIq-IfK3IlNPijE,21
 ostk/astrodynamics/test/access/test_generator.py,sha256=i7TnM80kF0Q_9KmyoqKt5n1ufg3ZjAIEMPVVds8ZDdI,10315
 ostk/astrodynamics/test/access/test_visibility_criterion.py,sha256=0Q_lcs6PZC_mTIHDuIPc8adKF02q2EM_ZR6jT5UhnDg,6353
@@ -124,8 +124,8 @@ ostk/astrodynamics/trajectory/orbit/model/kepler.pyi,sha256=09xlx_7dTiivctFDyW_3
 ostk/astrodynamics/trajectory/orbit/model/sgp4.pyi,sha256=2rxyPPsSCtsEKAShuZQbhZSybK01Q9u1CMieGjwWxN4,14313
 ostk/astrodynamics/trajectory/state/__init__.pyi,sha256=-sq42oF9YgXSkP1LtPcSu7mmtpjUkEzjydD9VYdIQ6g,17672
 ostk/astrodynamics/trajectory/state/coordinate_subset.pyi,sha256=iqoM-8RqiLNIsyiQXLfosvGO7ZP_KdQxrUWqiV04E1c,10566
-open_space_toolkit_astrodynamics-15.0.0.dist-info/METADATA,sha256=Bf2ectBDzmNRiENq9b31LDEhBBG-bARuZMbfdyJwswM,1913
-open_space_toolkit_astrodynamics-15.0.0.dist-info/WHEEL,sha256=esAQ49biZzN3Mxaws3kr8B8Sz08ER9fLpbEMXaWkwRw,110
-open_space_toolkit_astrodynamics-15.0.0.dist-info/top_level.txt,sha256=zOR18699uDYnafgarhL8WU_LmTZY_5NVqutv-flp_x4,5
-open_space_toolkit_astrodynamics-15.0.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-open_space_toolkit_astrodynamics-15.0.0.dist-info/RECORD,,
+open_space_toolkit_astrodynamics-15.1.0.dist-info/METADATA,sha256=52SOCFxHag6hxYwvZmHaYbAds9Sbi7efOiwqvUWHIj8,1913
+open_space_toolkit_astrodynamics-15.1.0.dist-info/WHEEL,sha256=esAQ49biZzN3Mxaws3kr8B8Sz08ER9fLpbEMXaWkwRw,110
+open_space_toolkit_astrodynamics-15.1.0.dist-info/top_level.txt,sha256=zOR18699uDYnafgarhL8WU_LmTZY_5NVqutv-flp_x4,5
+open_space_toolkit_astrodynamics-15.1.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+open_space_toolkit_astrodynamics-15.1.0.dist-info/RECORD,,

ostk/astrodynamics/__init__.pyi

@@ -19,8 +19,8 @@ from ostk import physics as OpenSpaceToolkitPhysicsPy
 from ostk.physics import Environment
 from ostk.physics import Manager
 from ostk.physics import Unit
-from ostk.physics import coordinate
 import ostk.physics.coordinate
+from ostk.physics import coordinate
 import ostk.physics.coordinate.spherical
 from ostk.physics import environment
 import ostk.physics.environment.object

ostk/astrodynamics/test/test_viewer.py

@@ -36,6 +36,24 @@ def orbit(environment: Environment) -> Orbit:
     )
 
 
+@pytest.fixture
+def orbits(environment: Environment) -> list[Orbit]:
+    return [
+        Orbit.sun_synchronous(
+            epoch=Instant.date_time(DateTime(2020, 1, 1, 0, 0, 0), Scale.UTC),
+            altitude=Length.kilometers(500.0),
+            local_time_at_descending_node=Time(14, 0, 0),
+            celestial_object=environment.access_celestial_object_with_name("Earth"),
+        ),
+        Orbit.sun_synchronous(
+            epoch=Instant.date_time(DateTime(2020, 1, 1, 0, 0, 0), Scale.UTC),
+            altitude=Length.kilometers(500.0),
+            local_time_at_descending_node=Time(12, 0, 0),
+            celestial_object=environment.access_celestial_object_with_name("Earth"),
+        ),
+    ]
+
+
 @pytest.fixture
 def profile(orbit: Orbit) -> Profile:
     return Profile.local_orbital_frame_pointing(
@@ -56,6 +74,8 @@ def interval() -> Interval:
 def viewer(interval: Interval) -> Viewer:
     return Viewer(
         interval=interval,
+        zoom_to_entity=False,
+        track_entity=False,
     )
 
 
@@ -74,6 +94,50 @@ class TestViewer:
         assert "var widget = new Cesium.Viewer" in rendered_html
         assert rendered_html.endswith("</script>")
 
+    def test_add_orbit_success(
+        self,
+        viewer: Viewer,
+        orbit: Orbit,
+    ):
+        viewer.add_orbit(
+            orbit=orbit,
+            step=Duration.seconds(5.0),
+            show_orbital_track=True,
+        )
+
+        rendered_html: str = viewer.render()
+
+        assert rendered_html.startswith('<meta charset="utf-8">')
+        assert "var widget = new Cesium.Viewer" in rendered_html
+        assert "new Cesium.SampledProperty(Cesium.Cartesian3)" in rendered_html
+        assert " widget.entities.add({position: widget" in rendered_html
+        assert "widget.entities.add({polyline:" in rendered_html
+        assert "billboard: {image:" in rendered_html
+        assert rendered_html.endswith("</script>")
+
+    def test_add_orbit_multiple_success(
+        self,
+        viewer: Viewer,
+        orbits: list[Orbit],
+    ):
+        for i, orbit in enumerate(orbits):
+            viewer.add_orbit(
+                orbit=orbit,
+                step=Duration.seconds(5.0),
+                show_orbital_track=True,
+                name=f"Satellite {i}",
+            )
+
+        rendered_html: str = viewer.render()
+
+        assert rendered_html.startswith('<meta charset="utf-8">')
+        assert "var widget = new Cesium.Viewer" in rendered_html
+        assert "new Cesium.SampledProperty(Cesium.Cartesian3)" in rendered_html
+        assert " widget.entities.add({position: widget" in rendered_html
+        assert "widget.entities.add({polyline:" in rendered_html
+        assert "billboard: {image:" in rendered_html
+        assert rendered_html.endswith("</script>")
+
     def test_add_profile_success(
         self,
         viewer: Viewer,

ostk/astrodynamics/viewer.py

@@ -24,11 +24,16 @@ from ostk.physics.coordinate import Frame
 from ostk.physics.coordinate.spherical import LLA
 
 from ostk.astrodynamics.flight import Profile
+from ostk.astrodynamics.trajectory import Orbit
 from ostk.astrodynamics.trajectory import State
 
 from .converters import coerce_to_datetime
 from .utilities import lla_from_position
 
+DEFAULT_SATELLITE_IMAGE: str = (
+    "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAADJSURBVDhPnZHRDcMgEEMZjVEYpaNklIzSEfLfD4qNnXAJSFWfhO7w2Zc0Tf9QG2rXrEzSUeZLOGm47WoH95x3Hl3jEgilvDgsOQUTqsNl68ezEwn1vae6lceSEEYvvWNT/Rxc4CXQNGadho1NXoJ+9iaqc2xi2xbt23PJCDIB6TQjOC6Bho/sDy3fBQT8PrVhibU7yBFcEPaRxOoeTwbwByCOYf9VGp1BYI1BA+EeHhmfzKbBoJEQwn1yzUZtyspIQUha85MpkNIXB7GizqDEECsAAAAASUVORK5CYII="
+)
+
 
 @dataclass
 class Sensor:
@@ -57,6 +62,8 @@ class Viewer:
         cesium_token: str | None = None,
         width: str = "1500px",
         height: str = "800px",
+        zoom_to_entity: bool = True,
+        track_entity: bool = True,
     ) -> None:
         self._interval: Interval = interval
 
@@ -81,8 +88,8 @@ class Viewer:
             scene_mode_picker=False,
             selection_indicator=False,
             scene3d_only=True,
-            zoom_to_entity=True,
-            track_entity=True,
+            zoom_to_entity=zoom_to_entity,
+            track_entity=track_entity,
             default_access_token=cesium_token,
         )
 
@@ -90,6 +97,73 @@ class Viewer:
     def interval(self) -> Interval:
         return self._interval
 
+    def add_orbit(
+        self,
+        orbit: Orbit,
+        step: Duration,
+        name: str = "Satellite",
+        show_orbital_track: bool = False,
+        color: str | None = None,
+        image: str | None = None,
+    ) -> None:
+        """
+        Add Orbit to Viewer.
+
+        Args:
+            orbit (Orbit): Orbit to be added.
+            step (Duration): Step between two consecutive states.
+            name (str, optional): Name of the orbit. Defaults to "Satellite".
+            show_orbital_track (bool, optional): Whether to show the orbital track. Defaults to False.
+            color (str, optional): Color of the orbit. Defaults to None.
+            image (str, optional): Logo to be added. Defaults to None.
+        """
+        instants: list[Instant] = self._interval.generate_grid(step)
+        states: list[State] = orbit.get_states_at(instants)
+        llas: list[LLA] = _generate_llas(states)
+
+        cesium_positions: cesiumpy.SampledPositionProperty = (
+            _generate_sampled_position_from_states(states)
+        )
+
+        self._viewer.entities.add(
+            cesiumpy.Billboard(
+                name=name,
+                position=cesium_positions,
+                image=image or DEFAULT_SATELLITE_IMAGE,
+            )
+        )
+
+        self._viewer.entities.add(
+            cesiumpy.Label(
+                position=cesium_positions,
+                text=name,
+                scale=1.0,
+                fill_color=color or cesiumpy.color.WHITE,
+                pixel_offset=[0.0, 20.0],
+            )
+        )
+
+        if show_orbital_track:
+            self._viewer.entities.add(
+                cesiumpy.Polyline(
+                    positions=cesiumpy.entities.cartesian.Cartesian3Array(
+                        functools.reduce(
+                            operator.iconcat,
+                            [
+                                [
+                                    float(lla.get_longitude().in_degrees()),
+                                    float(lla.get_latitude().in_degrees()),
+                                    float(lla.get_altitude().in_meters()),
+                                ]
+                                for lla in llas
+                            ],
+                            [],
+                        )
+                    ),
+                    width=1,
+                )
+            )
+
     def add_profile(
         self,
         profile: Profile,
@@ -144,7 +218,7 @@ class Viewer:
             )
 
         satellite = cesiumpy.Satellite(
-            position=_generate_sampled_position(instants, llas),
+            position=_generate_sampled_position_from_llas(instants, llas),
             orientation=_generate_sampled_orientation(states),
             availability=cesiumpy.TimeIntervalCollection(
                 intervals=[
@@ -294,7 +368,7 @@ def _generate_llas(states: list[State]) -> list[LLA]:
     ]
 
 
-def _generate_sampled_position(
+def _generate_sampled_position_from_llas(
     instants: list[Instant],
     llas: list[LLA],
 ) -> cesiumpy.SampledPositionProperty:
@@ -344,6 +418,33 @@ def _generate_sampled_orientation(states: list[State]) -> cesiumpy.SampledProper
     )
 
 
+def _generate_sampled_position_from_states(
+    states: list[State],
+) -> cesiumpy.SampledPositionProperty:
+    """
+    Generate a sampled position property from a list of OSTk States.
+
+    Args:
+        states (list[State]): A list of OSTk States.
+
+    Returns:
+        cesiumpy.SampledPositionProperty: Sampled position property.
+    """
+
+    return cesiumpy.SampledPositionProperty(
+        samples=[
+            (
+                coerce_to_datetime(state.get_instant()),
+                _cesium_from_ostk_position(
+                    position=state.in_frame(Frame.ITRF()).get_position()
+                ),
+                None,
+            )
+            for state in states
+        ],
+    )
+
+
 def _cesium_from_ostk_position(
     position: Position,
     instant: Instant | None = None,