ostk.physics.coordinate.Frame¶

class Frame¶

Bases: pybind11_object

Reference frame

Reference:: https://en.wikipedia.org/wiki/Frame_of_reference
Note:: Implementation heavily inspired by (the great!) https://www.orekit.org/static/architecture/frames.html

Methods

`CIRF`	Get the Celestial Intermediate Reference Frame (CIRF).
`GCRF`	Get the Geocentric Celestial Reference Frame (GCRF).
`ITRF`	Get the International Terrestrial Reference Frame (ITRF).
`J2000`	Get the J2000 frame.
`MOD`	Get the MOD frame.
`TEME`	Get the True Equator Mean Equinox (TEME) frame.
`TEME_of_epoch`	Get the True Equator Mean Equinox (TEME) frame of epoch.
`TIRF`	Get the Terrestrial Intermediate Reference Frame (TIRF).
`TOD`	Get the TOD frame.
`access_ancestor`	Access the ancestor frame.
`access_parent`	Access the parent frame.
`access_provider`	Access the provider.
`construct`	Construct a frame.
`destruct`	Destruct a frame.
`exists`	Check if a frame exists.
`get_axes_in`	Get the axes in another frame.
`get_name`	Get the name.
`get_origin_in`	Get the origin in another frame.
`get_transform_to`	Get the transformation to another frame.
`get_velocity_in`	Get the velocity in another frame.
`has_parent`	Check if the frame has a parent.
`is_defined`	Check if the instance is defined.
`is_quasi_inertial`	Check if the frame is quasi-inertial.
`undefined`	Get undefined frame.
`with_name`	Get the frame with a given name.

static CIRF() → ostk.physics.coordinate.Frame¶

Get the Celestial Intermediate Reference Frame (CIRF).

Returns:: CIRtorch.nn.functional.
Return type:: Frame

static GCRF() → ostk.physics.coordinate.Frame¶

Get the Geocentric Celestial Reference Frame (GCRF).

Returns:: GCRtorch.nn.functional.
Return type:: Frame

static ITRF() → ostk.physics.coordinate.Frame¶

Get the International Terrestrial Reference Frame (ITRF).

Returns:: ITRtorch.nn.functional.
Return type:: Frame

static J2000( theory: ostk::physics::coordinate::frame::provider::iau::Theory, ) → ostk.physics.coordinate.Frame¶

Get the J2000 frame.

Parameters:: theory (Theory) -- Theory.
Returns:: J2000.
Return type:: Frame

static MOD(epoch: ostk.physics.time.Instant) → ostk.physics.coordinate.Frame¶

Get the MOD frame.

Parameters:: epoch (Instant) -- Epoch.
Returns:: MOD.
Return type:: Frame

static TEME() → ostk.physics.coordinate.Frame¶

Get the True Equator Mean Equinox (TEME) frame.

Returns:: TEME.
Return type:: Frame

static TEME_of_epoch(epoch: ostk.physics.time.Instant) → ostk.physics.coordinate.Frame¶

Get the True Equator Mean Equinox (TEME) frame of epoch.

Parameters:: epoch (Instant) -- Epoch.
Returns:: TEME of epoch.
Return type:: Frame

static TIRF() → ostk.physics.coordinate.Frame¶

Get the Terrestrial Intermediate Reference Frame (TIRF).

Returns:: TIRtorch.nn.functional.
Return type:: Frame

static TOD( epoch: ostk.physics.time.Instant, theory: ostk::physics::coordinate::frame::provider::iau::Theory, ) → ostk.physics.coordinate.Frame¶

Get the TOD frame.

Parameters:

epoch (Instant) -- Epoch.
theory (Theory) -- Theory.

Returns:

TOD.

Return type:

Frame

access_ancestor( self: ostk.physics.coordinate.Frame, ancestor_degree: int, ) → ostk.physics.coordinate.Frame¶

Access the ancestor frame.

Parameters:: ancestor_degree (int) -- Ancestor degree.
Returns:: Ancestor frame.
Return type:: Frame

access_parent( self: ostk.physics.coordinate.Frame, ) → ostk.physics.coordinate.Frame¶

Access the parent frame.

Returns:: Parent frame.
Return type:: Frame

access_provider( self: ostk.physics.coordinate.Frame, ) → ostk::physics::coordinate::frame::Provider¶

Access the provider.

Returns:: Provider.
Return type:: Provider

static construct( name: ostk.core.type.String, is_quasi_inertial: bool, parent_frame: ostk.physics.coordinate.Frame, provider: ostk::physics::coordinate::frame::Provider, ) → ostk.physics.coordinate.Frame¶