ostk.physics.environment.object.Celestial

class Celestial(*args, **kwargs)

Bases: Object

Celestial class

Overloaded function.

1. __init__(self: ostk.physics.environment.object.Celestial, name: ostk.core.type.String, type: ostk::physics::environment::object::Celestial::Type, gravitational_parameter: ostk.physics.unit.Derived, equatorial_radius: ostk.physics.unit.Length, flattening: ostk.core.type.Real, J2_parameter_value: ostk.core.type.Real, J4_parameter_value: ostk.core.type.Real, ephemeris: ostk::physics::environment::Ephemeris, gravitational_model: ostk::physics::environment::gravitational::Model, magnetic_model: ostk::physics::environment::magnetic::Model, atmospheric_model: ostk::physics::environment::atmospheric::Model) -> None

   Constructor

   Args:

   name (str): Name. type (CelestialType): Type. gravitational_parameter (Derived): Gravitational parameter [m³/s²]. equatorial_radius (Length): Equatorial radius [m]. flattening (Real): Flattening. J2_parameter_value (Real): J2 parameter value. J4_parameter_value (Real): J4 parameter value. ephemeris (Ephemeris): Ephemeris. gravitational_model (GravitationalModel): Gravitational model. magnetic_model (MagneticModel): Magnetic model. atmospheric_model (AtmosphericModel): Atmospheric model.

2. __init__(self: ostk.physics.environment.object.Celestial, name: ostk.core.type.String, type: ostk::physics::environment::object::Celestial::Type, gravitational_parameter: ostk.physics.unit.Derived, equatorial_radius: ostk.physics.unit.Length, flattening: ostk.core.type.Real, J2_parameter_value: ostk.core.type.Real, J4_parameter_value: ostk.core.type.Real, ephemeris: ostk::physics::environment::Ephemeris, gravitational_model: ostk::physics::environment::gravitational::Model, magnetic_model: ostk::physics::environment::magnetic::Model, atmospheric_model: ostk::physics::environment::atmospheric::Model, geometry: ostk.physics.environment.object.Geometry) -> None

   Constructor

   Args:

   name (str): Name. type (CelestialType): Type. gravitational_parameter (Derived): Gravitational parameter [m³/s²]. equatorial_radius (Length): Equatorial radius [m]. flattening (Real): Flattening. J2_parameter_value (Real): J2 parameter value. J4_parameter_value (Real): J4 parameter value. ephemeris (Ephemeris): Ephemeris gravitational_model (GravitationalModel): Gravitational model. magnetic_model (MagneticModel): Magnetic model. atmospheric_model (AtmosphericModel): Atmospheric model. geometry (Object.Geometry): Geometry.

Methods

access_atmospheric_model	Access the atmospheric model.
access_ephemeris	Access the ephemeris.
access_frame	Accesses the frame of the Object.
access_gravitational_model	Access the gravitational model.
access_magnetic_model	Access the magnetic model.
access_name	Accesses the name of the Object.
atmospheric_model_is_defined	Check if the atmospheric model is defined.
get_axes_in	Get the axes of the celestial object in a given frame at a given instant.
get_equatorial_radius	Get the equatorial radius of the celestial object.
get_flattening	Get the flattening of the celestial object.
get_frame_at	Get the frame at a given LLA and frame type.
get_geometry	Gets the geometry of the Object.
get_geometry_in	Gets the geometry of the Object in a given frame.
get_gravitational_parameter	Get the gravitational parameter of the celestial object.
get_j2	Get the J2 parameter value of the celestial object.
get_j4	Get the J4 parameter value of the celestial object.
get_name	Gets the name of the Object.
get_position_in	Get the position of the celestial object in a given frame at a given instant.
get_transform_to	Get the transform of the celestial object to a given frame at a given instant.
get_type	Get the type of the celestial object.
gravitational_model_is_defined	Check if the gravitational model is defined.
is_defined	Check if the celestial object is defined.
magnetic_model_is_defined	Check if the magnetic model is defined.
string_from_frame_type	Get the string representation of a frame type.
undefined	Create an undefined celestial object.

class CelestialType(

self: ostk.physics.environment.object.Celestial.CelestialType,

value: int,

)

Bases: pybind11_object

Members:

Undefined :

Undefined celestial object.

Sun :

Sun.

Mercury :

Mercury.

Venus :

Venus.

Earth :

Earth.

Moon :

Moon.

Mars :

Mars.

property name

class FrameType(

self: ostk.physics.environment.object.Celestial.FrameType,

value: int,

)

Bases: pybind11_object

Members:

Undefined :

Undefined frame.

NED :

North-East-Down (NED) frame.

property name

access_atmospheric_model(

self: ostk.physics.environment.object.Celestial,

) → ostk::physics::environment::atmospheric::Model

Access the atmospheric model.

Returns:

Atmospheric model.

Return type:

Atmospheric

access_ephemeris(

self: ostk.physics.environment.object.Celestial,

) → ostk::physics::environment::Ephemeris

Access the ephemeris.

Returns:

Ephemeris.

Return type:

Ephemeris

access_frame(

self: ostk.physics.environment.Object,

) → ostk.physics.coordinate.Frame

Accesses the frame of the Object.

Returns:

The frame of the Object.

Return type:

Frame

access_gravitational_model(

self: ostk.physics.environment.object.Celestial,

) → ostk::physics::environment::gravitational::Model

Access the gravitational model.

Returns:

Gravitational model.

Return type:

Gravitational

access_magnetic_model(

self: ostk.physics.environment.object.Celestial,

) → ostk::physics::environment::magnetic::Model

Access the magnetic model.

Returns:

Magnetic model.

Return type:

Magnetic

access_name(self: ostk.physics.environment.Object) → ostk.core.type.String

Accesses the name of the Object.

Returns:

The name of the Object.

Return type:

str

atmospheric_model_is_defined(

self: ostk.physics.environment.object.Celestial,

) → bool

Check if the atmospheric model is defined.

Returns:

True if the atmospheric model is defined, false otherwise.

Return type:

bool

get_axes_in(

self: ostk.physics.environment.object.Celestial,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk.physics.coordinate.Axes

Get the axes of the celestial object in a given frame at a given instant.

Parameters:

• frame (Frame) -- Frame.

• instant (Instant) -- Instant.

Returns:

Axes.

Return type:

Axes

get_equatorial_radius(

self: ostk.physics.environment.object.Celestial,

) → ostk.physics.unit.Length

Get the equatorial radius of the celestial object.

Returns:

Equatorial radius [m].

Return type:

Length

get_flattening(

self: ostk.physics.environment.object.Celestial,

) → ostk.core.type.Real

Get the flattening of the celestial object.

Returns:

Flattening.

Return type:

float

get_frame_at(

self: ostk.physics.environment.object.Celestial,

lla: ostk.physics.coordinate.spherical.LLA,

frame_type: ostk::physics::environment::object::Celestial::FrameType,

) → ostk.physics.coordinate.Frame

Get the frame at a given LLA and frame type.

Parameters:

• lla (LLA) -- LLA

• frame_type (Celestial.FrameType) -- Frame type

Returns:

Frame.

Return type:

Frame

get_geometry(

self: ostk.physics.environment.Object,

) → ostk::physics::environment::object::Geometry

Gets the geometry of the Object.

Returns:

The geometry of the Object.

Return type:

Geometry

get_geometry_in(

self: ostk.physics.environment.Object,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk::physics::environment::object::Geometry

Gets the geometry of the Object in a given frame.

Parameters:

• frame (Frame) -- The frame in which the geometry is expressed.

• instant (Instant) -- The instant at which the geometry is computed.

Returns:

the geometry of the Object.

Return type:

Geometry

get_gravitational_parameter(

self: ostk.physics.environment.object.Celestial,

) → ostk.physics.unit.Derived

Get the gravitational parameter of the celestial object.

Returns:

Gravitational parameter [m³/s²].

Return type:

Derived

get_j2(self: ostk.physics.environment.object.Celestial) → ostk.core.type.Real

Get the J2 parameter value of the celestial object.

Returns:

J2 parameter value.

Return type:

float

get_j4(self: ostk.physics.environment.object.Celestial) → ostk.core.type.Real

Get the J4 parameter value of the celestial object.

Returns:

J4 parameter value.

Return type:

float

get_name(self: ostk.physics.environment.Object) → ostk.core.type.String

Gets the name of the Object.

Returns:

The name of the Object.

Return type:

str

get_position_in(

self: ostk.physics.environment.object.Celestial,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk.physics.coordinate.Position

Get the position of the celestial object in a given frame at a given instant.

Parameters:

• frame (Frame) -- Frame.

• instant (Instant) -- Instant.

Returns:

Position.

Return type:

Position

get_transform_to(

self: ostk.physics.environment.object.Celestial,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk.physics.coordinate.Transform

Get the transform of the celestial object to a given frame at a given instant.

Parameters:

• frame (Frame) -- Frame.

• instant (Instant) -- Instant.

Returns:

Transform.

Return type:

Transform

get_type(

self: ostk.physics.environment.object.Celestial,

) → ostk::physics::environment::object::Celestial::Type

Get the type of the celestial object.

Returns:

Type.

Return type:

Celestial.Type

gravitational_model_is_defined(

self: ostk.physics.environment.object.Celestial,

) → bool

Check if the gravitational model is defined.

Returns:

True if the gravitational model is defined, false otherwise.

Return type:

bool

is_defined(self: ostk.physics.environment.object.Celestial) → bool

Check if the celestial object is defined.

Returns:

True if the celestial object is defined, false otherwise.

Return type:

bool

magnetic_model_is_defined(

self: ostk.physics.environment.object.Celestial,

) → bool

Check if the magnetic model is defined.

Returns:

True if the magnetic model is defined, false otherwise.

Return type:

bool

static string_from_frame_type(

frame_type: ostk::physics::environment::object::Celestial::FrameType,

) → ostk.core.type.String

Get the string representation of a frame type.

Parameters:

frame_type (Celestial.FrameType) -- Frame type.

Returns:

String representation.

Return type:

str

static undefined() → ostk.physics.environment.object.Celestial

Create an undefined celestial object.

Returns:

Undefined celestial object.

Return type:

Celestial