open-space-toolkit-astrodynamics 13.1.0__py311-none-manylinux2014_x86_64.whl → 14.0.0__py311-none-manylinux2014_x86_64.whl

ostk/astrodynamics/trajectory/orbit/__init__.pyi

@@ -0,0 +1,361 @@
+from __future__ import annotations
+import ostk.astrodynamics.trajectory
+import ostk.core.type
+import ostk.physics.time
+import typing
+from . import message
+from . import model
+__all__ = ['OrbitModel', 'Pass', 'message', 'model']
+class OrbitModel:
+    """
+    
+                Base class for orbit models.
+    
+                Provides the interface for orbit models.
+    
+            
+    """
+    __hash__: typing.ClassVar[None] = None
+    @staticmethod
+    def _pybind11_conduit_v1_(*args, **kwargs):
+        ...
+    def __eq__(self, arg0: OrbitModel) -> bool:
+        ...
+    def __ne__(self, arg0: OrbitModel) -> bool:
+        ...
+    def __str__(self) -> str:
+        ...
+    def as_kepler(self) -> ...:
+        """
+                        Cast the orbit model to a Kepler model.
+        
+                        Returns:
+                            Kepler: The Kepler model.
+        """
+    def as_propagated(self) -> ...:
+        """
+                        Cast the orbit model to a propagated model.
+        
+                        Returns:
+                            Propagated: The propagated model.
+        """
+    def as_sgp4(self) -> ...:
+        """
+                        Cast the orbit model to an SGP4 model.
+        
+                        Returns:
+                            SGP4: The SGP4 model.
+        """
+    def calculate_revolution_number_at(self, instant: ostk.physics.time.Instant) -> ostk.core.type.Integer:
+        """
+                        Calculate the revolution number of the orbit model at a given instant.
+        
+                        Args:
+                            instant (Instant): The instant at which to calculate the revolution number.
+        
+                        Returns:
+                            int: The revolution number of the orbit model at the given instant.
+        """
+    def calculate_state_at(self, instant: ostk.physics.time.Instant) -> ostk.astrodynamics.trajectory.State:
+        """
+                        Calculate the state of the orbit model at a given instant.
+        
+                        Args:
+                            instant (Instant): The instant at which to calculate the state.
+        
+                        Returns:
+                            State: The state of the orbit model at the given instant.
+        """
+    def get_epoch(self) -> ostk.physics.time.Instant:
+        """
+                        Get the epoch of the orbit model.
+        
+                        Returns:
+                            Instant: The epoch of the orbit model.
+        """
+    def get_revolution_number_at_epoch(self) -> ostk.core.type.Integer:
+        """
+                        Get the revolution number at the epoch of the orbit model.
+        
+                        Returns:
+                            int: The revolution number at the epoch of the orbit model.
+        """
+    def is_defined(self) -> bool:
+        """
+                        Check if the orbit model is defined.
+        
+                        Returns:
+                            bool: True if the orbit model is defined, False otherwise.
+        """
+    def is_kepler(self) -> bool:
+        """
+                        Check if the orbit model is a Kepler model.
+        
+                        Returns:
+                            bool: True if the orbit model is a Kepler model, False otherwise.
+        """
+    def is_propagated(self) -> bool:
+        """
+                        Check if the orbit model is a propagated model.
+        
+                        Returns:
+                            bool: True if the orbit model is a propagated model, False otherwise.
+        """
+    def is_sgp4(self) -> bool:
+        """
+                        Check if the orbit model is an SGP4 model.
+        
+                        Returns:
+                            bool: True if the orbit model is an SGP4 model, False otherwise.
+        """
+class Pass:
+    """
+    
+                A revolution of an orbiting object.
+    
+            
+    """
+    class Phase:
+        """
+        
+                    The phase of the `Pass`.
+                
+        
+        Members:
+        
+          Undefined : Undefined
+        
+          Ascending : Ascending
+        
+          Descending : Descending
+        """
+        Ascending: typing.ClassVar[Pass.Phase]  # value = <Phase.Ascending: 1>
+        Descending: typing.ClassVar[Pass.Phase]  # value = <Phase.Descending: 2>
+        Undefined: typing.ClassVar[Pass.Phase]  # value = <Phase.Undefined: 0>
+        __members__: typing.ClassVar[dict[str, Pass.Phase]]  # value = {'Undefined': <Phase.Undefined: 0>, 'Ascending': <Phase.Ascending: 1>, 'Descending': <Phase.Descending: 2>}
+        @staticmethod
+        def _pybind11_conduit_v1_(*args, **kwargs):
+            ...
+        def __eq__(self, other: typing.Any) -> bool:
+            ...
+        def __getstate__(self) -> int:
+            ...
+        def __hash__(self) -> int:
+            ...
+        def __index__(self) -> int:
+            ...
+        def __init__(self, value: int) -> None:
+            ...
+        def __int__(self) -> int:
+            ...
+        def __ne__(self, other: typing.Any) -> bool:
+            ...
+        def __repr__(self) -> str:
+            ...
+        def __setstate__(self, state: int) -> None:
+            ...
+        def __str__(self) -> str:
+            ...
+        @property
+        def name(self) -> str:
+            ...
+        @property
+        def value(self) -> int:
+            ...
+    class Type:
+        """
+        
+                    The type of `Pass`.
+                
+        
+        Members:
+        
+          Undefined : Undefined
+        
+          Complete : Complete
+        
+          Partial : Partial
+        """
+        Complete: typing.ClassVar[Pass.Type]  # value = <Type.Complete: 1>
+        Partial: typing.ClassVar[Pass.Type]  # value = <Type.Partial: 2>
+        Undefined: typing.ClassVar[Pass.Type]  # value = <Type.Undefined: 0>
+        __members__: typing.ClassVar[dict[str, Pass.Type]]  # value = {'Undefined': <Type.Undefined: 0>, 'Complete': <Type.Complete: 1>, 'Partial': <Type.Partial: 2>}
+        @staticmethod
+        def _pybind11_conduit_v1_(*args, **kwargs):
+            ...
+        def __eq__(self, other: typing.Any) -> bool:
+            ...
+        def __getstate__(self) -> int:
+            ...
+        def __hash__(self) -> int:
+            ...
+        def __index__(self) -> int:
+            ...
+        def __init__(self, value: int) -> None:
+            ...
+        def __int__(self) -> int:
+            ...
+        def __ne__(self, other: typing.Any) -> bool:
+            ...
+        def __repr__(self) -> str:
+            ...
+        def __setstate__(self, state: int) -> None:
+            ...
+        def __str__(self) -> str:
+            ...
+        @property
+        def name(self) -> str:
+            ...
+        @property
+        def value(self) -> int:
+            ...
+    __hash__: typing.ClassVar[None] = None
+    @staticmethod
+    def _pybind11_conduit_v1_(*args, **kwargs):
+        ...
+    @staticmethod
+    def string_from_phase(phase: Pass.Phase) -> ostk.core.type.String:
+        """
+                        Get the string representation of a pass phase.
+        
+                        Args:
+                            phase (Pass.Phase): The pass phase.
+        
+                        Returns:
+                            str: The string representation of the pass phase.
+        """
+    @staticmethod
+    def string_from_type(type: Pass.Type) -> ostk.core.type.String:
+        """
+                        Get the string representation of a pass type.
+        
+                        Args:
+                            type (Pass.Type): The pass type.
+        
+                        Returns:
+                            str: The string representation of the pass type.
+        """
+    @staticmethod
+    def undefined() -> Pass:
+        """
+                        Get an undefined pass.
+        
+                        Returns:
+                            Pass: The undefined pass.
+        """
+    def __eq__(self, arg0: Pass) -> bool:
+        ...
+    def __init__(self, revolution_number: ostk.core.type.Integer, instant_at_ascending_node: ostk.physics.time.Instant, instant_at_north_point: ostk.physics.time.Instant, instant_at_descending_node: ostk.physics.time.Instant, instant_at_south_point: ostk.physics.time.Instant, instant_at_pass_break: ostk.physics.time.Instant) -> None:
+        """
+                        Constructor.
+        
+                        Args:
+                            revolution_number (int): The revolution number of the pass.
+                            instant_at_ascending_node (Instant): The instant at the ascending node of the pass.
+                            instant_at_north_point (Instant): The instant at the north point of the pass.
+                            instant_at_descending_node (Instant): The instant at the descending node of the pass.
+                            instant_at_south_point (Instant): The instant at the south point of the pass.
+                            instant_at_pass_break (Instant): The instant at break of the pass.
+        """
+    def __ne__(self, arg0: Pass) -> bool:
+        ...
+    def __repr__(self) -> str:
+        ...
+    def __str__(self) -> str:
+        ...
+    def get_duration(self) -> ostk.physics.time.Duration:
+        """
+                        Get the duration of the pass. Undefined if the pass is not complete.
+        
+                        Returns:
+                            Duration: The duration of the pass.
+        """
+    def get_end_instant(self) -> ostk.physics.time.Instant:
+        """
+                        Get the end instant of the pass. For partial passes, this is the maximum defined instant.
+        
+                        Returns:
+                            Instant: The end instant of the pass.
+        """
+    def get_instant_at_ascending_node(self) -> ostk.physics.time.Instant:
+        """
+                        Get the instant at the ascending node of the pass.
+                        i.e. z = 0 & vz > 0 in an ECI frame.
+        
+                        Returns:
+                            Instant: The instant at the ascending node of the pass.
+        """
+    def get_instant_at_descending_node(self) -> ostk.physics.time.Instant:
+        """
+                        Get the instant at the descending node of the pass.
+                        i.e. z = 0 and vz < 0 in an ECI frame.
+        
+                        Returns:
+                            Instant: The instant at the descending node of the pass.
+        """
+    def get_instant_at_north_point(self) -> ostk.physics.time.Instant:
+        """
+                        Get the instant at the north point of the pass.
+                        i.e. z = maximum and vz = 0 in an ECI frame.
+        
+                        Returns:
+                            Instant: The instant at the north point of the pass.
+        """
+    def get_instant_at_pass_break(self) -> ostk.physics.time.Instant:
+        """
+                        Get the instant at the break of the pass,
+                        i.e. the ascending node of the next pass.
+        
+                        Returns:
+                            Instant: The instant at the break of the pass.
+        """
+    def get_instant_at_south_point(self) -> ostk.physics.time.Instant:
+        """
+                        Get the instant at the south point of the pass.
+                        i.e. z = minimum and vz = 0 in an ECI frame.
+        
+                        Returns:
+                            Instant: The instant at the south point of the pass.
+        """
+    def get_interval(self) -> ostk.physics.time.Interval:
+        """
+                        Get the interval of the pass. Undefined if the pass is not complete.
+        
+                        Returns:
+                            Interval: The interval of the pass.
+        """
+    def get_revolution_number(self) -> ostk.core.type.Integer:
+        """
+                        Get the revolution number of the pass.
+        
+                        Returns:
+                            int: The revolution number of the pass.
+        """
+    def get_start_instant(self) -> ostk.physics.time.Instant:
+        """
+                        Get the start instant of the pass. For partial passes, this is the minimum defined instant.
+        
+                        Returns:
+                            Instant: The start instant of the pass.
+        """
+    def get_type(self) -> Pass.Type:
+        """
+                        Get the type of the pass.
+        
+                        Returns:
+                            Pass.Type: The type of the pass.
+        """
+    def is_complete(self) -> bool:
+        """
+                        Check if the pass is complete.
+        
+                        Returns:
+                            bool: True if the pass is complete, False otherwise.
+        """
+    def is_defined(self) -> bool:
+        """
+                        Check if the pass is defined.
+        
+                        Returns:
+                            bool: True if the pass is defined, False otherwise.
+        """

ostk/astrodynamics/trajectory/orbit/message/__init__.pyi

@@ -0,0 +1,3 @@
+from __future__ import annotations
+from . import spacex
+__all__ = ['spacex']

ostk/astrodynamics/trajectory/orbit/message/spacex.pyi

@@ -0,0 +1,273 @@
+from __future__ import annotations
+import ostk.astrodynamics.trajectory
+import ostk.core.container
+import ostk.core.filesystem
+import ostk.core.type
+import ostk.physics.coordinate
+import ostk.physics.time
+import ostk.physics.unit
+__all__ = ['OPM']
+class OPM:
+    """
+    
+                The SpaceX OPM message.
+    
+                See Also:
+                    `SpaceX OPM <https://public.ccsds.org/Pubs/502x0b3e1.pdf>`_.
+    
+            
+    """
+    class Deployment:
+        """
+        
+                    The deployment of the SpaceX OPM message.
+        
+                
+        """
+        @staticmethod
+        def _pybind11_conduit_v1_(*args, **kwargs):
+            ...
+        def __init__(self, name: ostk.core.type.String, sequence_number: ostk.core.type.Integer, mission_time: ostk.physics.time.Duration, date: ostk.physics.time.Instant, position: ostk.physics.coordinate.Position, velocity: ostk.physics.coordinate.Velocity, mean_perigee_altitude: ostk.physics.unit.Length, mean_apogee_altitude: ostk.physics.unit.Length, mean_inclination: ostk.physics.unit.Angle, mean_argument_of_perigee: ostk.physics.unit.Angle, mean_longitude_ascending_node: ostk.physics.unit.Angle, mean_mean_anomaly: ostk.physics.unit.Angle, ballistic_coefficient: ostk.core.type.Real) -> None:
+            """
+                            Constructor.
+            
+                            Args:
+                                name (str): The name of the deployment.
+                                sequence_number (int): The sequence number of the deployment.
+                                mission_time (Duration): The mission time of the deployment.
+                                date (Instant): The date of the deployment.
+                                position (Position): The position of the deployment.
+                                velocity (Velocity): The velocity of the deployment.
+                                mean_perigee_altitude (Length): The mean perigee altitude of the deployment.
+                                mean_apogee_altitude (Length): The mean apogee altitude of the deployment.
+                                mean_inclination (Angle): The mean inclination of the deployment.
+                                mean_argument_of_perigee (Angle): The mean argument of perigee of the deployment.
+                                mean_longitude_ascending_node (Angle): The mean longitude of the ascending node of the deployment.
+                                mean_mean_anomaly (Angle): The mean mean anomaly of the deployment.
+                                ballistic_coefficient (float): The ballistic coefficient of the deployment.
+            """
+        def to_state(self) -> ostk.astrodynamics.trajectory.State:
+            """
+                            Convert the deployment to a state.
+            
+                            Returns:
+                                state (State): The state of the deployment.
+            """
+        @property
+        def ballistic_coefficient(self) -> ostk.core.type.Real:
+            """
+                            Get the ballistic coefficient of the deployment.
+            
+                            :type: float
+            """
+        @property
+        def date(self) -> ostk.physics.time.Instant:
+            """
+                            Get the date of the deployment.
+            
+                            :type: Instant
+            """
+        @property
+        def mean_apogee_altitude(self) -> ostk.physics.unit.Length:
+            """
+                            Get the mean apogee altitude of the deployment.
+            
+                            :type: Length
+            """
+        @property
+        def mean_argument_of_perigee(self) -> ostk.physics.unit.Angle:
+            """
+                            Get the mean argument of perigee of the deployment.
+            
+                            :type: Angle
+            """
+        @property
+        def mean_inclination(self) -> ostk.physics.unit.Angle:
+            """
+                            Get the mean inclination of the deployment.
+            
+                            :type: Angle
+            """
+        @property
+        def mean_longitude_ascending_node(self) -> ostk.physics.unit.Angle:
+            """
+                            Get the mean longitude of the ascending node of the deployment.
+            
+                            :type: Angle
+            """
+        @property
+        def mean_mean_anomaly(self) -> ostk.physics.unit.Angle:
+            """
+                            Get the mean mean anomaly of the deployment.
+            
+                            :type: Angle
+            """
+        @property
+        def mean_perigee_altitude(self) -> ostk.physics.unit.Length:
+            """
+                            Get the mean perigee altitude of the deployment.
+            
+                            :type: Length
+            """
+        @property
+        def mission_time(self) -> ostk.physics.time.Duration:
+            """
+                            Get the mission time of the deployment.
+            
+                            :type: Duration
+            """
+        @property
+        def name(self) -> ostk.core.type.String:
+            """
+                            Get the name of the deployment.
+            
+                            :type: str
+            """
+        @property
+        def position(self) -> ostk.physics.coordinate.Position:
+            """
+                            Get the position of the deployment.
+            
+                            :type: Position
+            """
+        @property
+        def sequence_number(self) -> ostk.core.type.Integer:
+            """
+                            Get the sequence number of the deployment.
+            
+                            :type: int
+            """
+        @property
+        def velocity(self) -> ostk.physics.coordinate.Velocity:
+            """
+                            Get the velocity of the deployment.
+            
+                            :type: Velocity
+            """
+    class Header:
+        """
+        
+                    The header of the SpaceX OPM message.
+        
+                
+        """
+        @staticmethod
+        def _pybind11_conduit_v1_(*args, **kwargs):
+            ...
+        def __init__(self, generation_date: ostk.physics.time.Instant, launch_date: ostk.physics.time.Instant) -> None:
+            """
+                            Constructor.
+            
+                            Args:
+                                generation_date (Instant): The date at which the OPM message was generated.
+                                launch_date (Instant): The date at which the spacecraft was launched.
+            """
+        @property
+        def generation_date(self) -> ostk.physics.time.Instant:
+            """
+                            Get the date at which the OPM message was generated.
+            
+                            Returns:
+                                instant (Instant): The date at which the OPM message was generated.
+            """
+        @property
+        def launch_date(self) -> ostk.physics.time.Instant:
+            """
+                            Get the date at which the spacecraft was launched.
+            
+                            Returns:
+                                instant (Instant): The date at which the spacecraft was launched.
+            """
+    @staticmethod
+    def _pybind11_conduit_v1_(*args, **kwargs):
+        ...
+    @staticmethod
+    def dictionary(dictionary: ostk.core.container.Dictionary) -> OPM:
+        """
+                        Build an OPM message from a dictionary.
+        
+                        Args:
+                            dictionary (dict): The dictionary containing the OPM message information.
+        
+                        Returns:
+                            opm (OPM): The OPM message.
+        """
+    @staticmethod
+    def load(file: ostk.core.filesystem.File) -> OPM:
+        """
+                        Load an OPM message from a file.
+        
+                        Args:
+                            file (str): The path to the file containing the OPM message.
+        
+                        Returns:
+                            opm (OPM): The OPM message.
+        """
+    @staticmethod
+    def parse(string: ostk.core.type.String) -> OPM:
+        """
+                        Parse an OPM message from a string.
+        
+                        Args:
+                            string (str): The string containing the OPM message.
+        
+                        Returns:
+                            opm (OPM): The OPM message.
+        """
+    @staticmethod
+    def undefined() -> OPM:
+        """
+                        Return an undefined OPM message.
+        
+                        Returns:
+                            opm (OPM): An undefined OPM message.
+        """
+    def __init__(self, header: ..., deployments: list[...]) -> None:
+        """
+                        Constructor.
+        
+                        Args:
+                            header (Header): The header of the OPM message.
+                            deployments (list[Deployment]): The deployments of the OPM message.
+        """
+    def get_deployment_at(self, index: int) -> ...:
+        """
+                        Get the deployment at a given index.
+        
+                        Args:
+                            index (int): The index of the deployment.
+        
+                        Returns:
+                            deployment (Deployment): The deployment at the given index.
+        """
+    def get_deployment_with_name(self, name: ostk.core.type.String) -> ...:
+        """
+                        Get the deployment with a given name.
+        
+                        Args:
+                            name (str): The name of the deployment.
+        
+                        Returns:
+                            deployment (Deployment): The deployment with the given name.
+        """
+    def get_deployments(self) -> list[...]:
+        """
+                        Get the deployments of the OPM message.
+        
+                        Returns:
+                            deployments (list[Deployment]): The deployments of the OPM message.
+        """
+    def get_header(self) -> ...:
+        """
+                        Get the header of the OPM message.
+        
+                        Returns:
+                            header (Header): The header of the OPM message.
+        """
+    def is_defined(self) -> bool:
+        """
+                        Check if the OPM message is defined.
+        
+                        Returns:
+                            is_defined (bool): True if the OPM message is defined, False otherwise.
+        """