ostk.astrodynamics.trajectory.orbit.model.Kepler

class Kepler(*args, **kwargs)

Bases: OrbitModel

A Kepler orbit model.

Provides the interface for orbit models.

Overloaded function.

1. __init__(self: ostk.astrodynamics.trajectory.orbit.model.Kepler, coe: ostk::astrodynamics::trajectory::orbit::model::kepler::COE, epoch: ostk.physics.time.Instant, gravitational_parameter: ostk.physics.unit.Derived, equatorial_radius: ostk.physics.unit.Length, j2: ostk.core.type.Real, j4: ostk.core.type.Real, perturbation_type: ostk.astrodynamics.trajectory.orbit.model.Kepler.PerturbationType) -> None

   Constructor.

   Args:

   coe (COE): The classical orbital elements. epoch (Instant): The epoch. gravitational_parameter (Derived): The gravitational parameter. equatorial_radius (Length): The equatorial radius. j2 (float): The J2 coefficient. j4 (float): The J4 coefficient. perturbation_type (PerturbationType): The perturbation type.

2. __init__(self: ostk.astrodynamics.trajectory.orbit.model.Kepler, coe: ostk::astrodynamics::trajectory::orbit::model::kepler::COE, epoch: ostk.physics.time.Instant, celestial_object: ostk.physics.environment.object.Celestial, perturbation_type: ostk.astrodynamics.trajectory.orbit.model.Kepler.PerturbationType, in_fixed_frame: bool = False) -> None

   Constructor.

   Args:

   coe (COE): The classical orbital elements. epoch (Instant): The epoch. celestial_object (Celestial): The celestial object. perturbation_type (PerturbationType): The perturbation type. in_fixed_frame (bool): If True, the state is expressed in the fixed frame, otherwise it is expressed in the inertial frame. Default is False.

Methods

as_kepler	Cast the orbit model to a Kepler model.
as_propagated	Cast the orbit model to a propagated model.
as_sgp4	Cast the orbit model to an SGP4 model.
calculate_revolution_number_at	Calculate the revolution number of the Kepler model at a given instant.
calculate_state_at	Calculate the state of the Kepler model at a given instant.
get_classical_orbital_elements	Get the classical orbital elements of the Kepler model.
get_epoch	Get the epoch of the Kepler model.
get_equatorial_radius	Get the equatorial radius of the Kepler model.
get_gravitational_parameter	Get the gravitational parameter of the Kepler model.
get_j2	Get the J2 coefficient of the Kepler model.
get_j4	Get the J4 coefficient of the Kepler model.
get_perturbation_type	Get the perturbation type of the Kepler model.
get_revolution_number_at_epoch	Get the revolution number at the epoch of the Kepler model.
is_defined	Check if the Kepler model is defined.
is_kepler	Check if the orbit model is a Kepler model.
is_propagated	Check if the orbit model is a propagated model.
is_sgp4	Check if the orbit model is an SGP4 model.
string_from_perturbation_type	Get the string representation of a PerturbationType.

class PerturbationType(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler.PerturbationType,

value: int,

)

Bases: pybind11_object

The Perturbation Type due to Oblateness

Members:

No : No perturbation

J2 : J2 perturbation

J4 : J4 perturbation

property name

as_kepler(

self: ostk.astrodynamics.trajectory.orbit.OrbitModel,

) → ostk::astrodynamics::trajectory::orbit::model::Kepler

Cast the orbit model to a Kepler model.

Returns:

The Kepler model.

Return type:

Kepler

as_propagated(

self: ostk.astrodynamics.trajectory.orbit.OrbitModel,

) → ostk::astrodynamics::trajectory::orbit::model::Propagated

Cast the orbit model to a propagated model.

Returns:

The propagated model.

Return type:

Propagated

as_sgp4(

self: ostk.astrodynamics.trajectory.orbit.OrbitModel,

) → ostk::astrodynamics::trajectory::orbit::model::SGP4

Cast the orbit model to an SGP4 model.

Returns:

The SGP4 model.

Return type:

SGP4

calculate_revolution_number_at(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

instant: ostk.physics.time.Instant,

) → ostk.core.type.Integer

Calculate the revolution number of the Kepler model at a given instant.

Parameters:

instant (Instant) -- The instant.

Returns:

The revolution number.

Return type:

int

calculate_state_at(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

instant: ostk.physics.time.Instant,

) → ostk.astrodynamics.trajectory.State

Calculate the state of the Kepler model at a given instant.

Parameters:

instant (Instant) -- The instant.

Returns:

The state.

Return type:

State

get_classical_orbital_elements(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk::astrodynamics::trajectory::orbit::model::kepler::COE

Get the classical orbital elements of the Kepler model.

Returns:

The classical orbital elements.

Return type:

COE

get_epoch(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk.physics.time.Instant

Get the epoch of the Kepler model.

Returns:

The epoch.

Return type:

Instant

get_equatorial_radius(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk.physics.unit.Length

Get the equatorial radius of the Kepler model.

Returns:

The equatorial radius.

Return type:

Length

get_gravitational_parameter(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk.physics.unit.Derived

Get the gravitational parameter of the Kepler model.

Returns:

The gravitational parameter.

Return type:

Derived

get_j2(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk.core.type.Real

Get the J2 coefficient of the Kepler model.

Returns:

The J2 coefficient.

Return type:

float

get_j4(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk.core.type.Real

Get the J4 coefficient of the Kepler model.

Returns:

The J4 coefficient.

Return type:

float

get_perturbation_type(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk.astrodynamics.trajectory.orbit.model.Kepler.PerturbationType

Get the perturbation type of the Kepler model.

Returns:

The perturbation type.

Return type:

PerturbationType

get_revolution_number_at_epoch(

self: ostk.astrodynamics.trajectory.orbit.model.Kepler,

) → ostk.core.type.Integer

Get the revolution number at the epoch of the Kepler model.

Returns:

The revolution number.

Return type:

int

is_defined(self: ostk.astrodynamics.trajectory.orbit.model.Kepler) → bool

Check if the Kepler model is defined.

Returns:

True if the Kepler model is defined, False otherwise.

Return type:

bool

is_kepler(self: ostk.astrodynamics.trajectory.orbit.OrbitModel) → bool

Check if the orbit model is a Kepler model.

Returns:

True if the orbit model is a Kepler model, False otherwise.

Return type:

bool

is_propagated(self: ostk.astrodynamics.trajectory.orbit.OrbitModel) → bool

Check if the orbit model is a propagated model.

Returns:

True if the orbit model is a propagated model, False otherwise.

Return type:

bool

is_sgp4(self: ostk.astrodynamics.trajectory.orbit.OrbitModel) → bool

Check if the orbit model is an SGP4 model.

Returns:

True if the orbit model is an SGP4 model, False otherwise.

Return type:

bool

static string_from_perturbation_type(

perturbation_type: ostk.astrodynamics.trajectory.orbit.model.Kepler.PerturbationType,

) → ostk.core.type.String

Get the string representation of a PerturbationType.

Parameters:

perturbation_type (PerturbationType) -- The perturbation type.

Returns:

The string representation.

Return type:

str