ostk.physics.environment.object.celestial.Sun¶

class Sun( self: ostk.physics.environment.object.celestial.Sun, ephemeris: ostk::physics::environment::Ephemeris, gravitational_model: ostk::physics::environment::gravitational::Sun, )¶

Bases: Celestial

Sun.

Constructor.

Parameters:

ephemeris (Ephemeris) -- Ephemeris.
gravitational_model (SunGravitationalModel) -- Gravitational model.

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.
`default`	Create a default Sun.
`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.
`spherical`	Spherical model.
`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

static default() → ostk.physics.environment.object.celestial.Sun¶

Create a default Sun.

Returns:: Default Sun.
Return type:: Sun

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¶