ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider¶

class LocalOrbitalFrameTransformProvider( self: ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider, transform: ostk.physics.coordinate.Transform, )¶

Bases: pybind11_object

Local orbital frame transform provider, frame provider. Generates a specific transform based on a State (instant, position, velocity) and a LOF type.

Constructs a local orbital frame transform provider.

Parameters:: transform (Transform) -- The transform.
Returns:: The provider.
Return type:: LocalOrbitalFrameTransformProvider

Methods

`construct`	Constructs a local orbital frame transform provider for the provided type.
`get_transform_at`	Returns the transform at a given instant.
`get_transform_generator`	Returns the transform generator function for a given type.
`is_defined`	Returns true if the provider is defined.

class Type( self: ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider.Type, value: int, )¶

Bases: pybind11_object

The local orbital frame type.

Members:

Undefined : Undefined

NED : North-East-Down

LVLH : Local Vertical-Local Horizontal

LVLHGD : Local Vertical-Local Horizontal Geodetic

VVLH : Vertical-Local Horizontal

QSW : Quasi-Satellite West

TNW : Tangent-Normal-Wideband

VNC : Velocity-Normal-Conormal

property name¶

static construct( type: ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider.Type, state: ostk::astrodynamics::trajectory::State, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider¶

Constructs a local orbital frame transform provider for the provided type.

Parameters:

type (LocalOrbitalFrameTransformProvider.Type) -- The local orbital frame provider type.
state (State) -- The state.

Returns:

The provider.

Return type:

LocalOrbitalFrameTransformProvider

get_transform_at( self: ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider, instant: ostk.physics.time.Instant, ) → ostk.physics.coordinate.Transform¶

Returns the transform at a given instant.

Parameters:: instant (Instant) -- The instant.
Returns:: The transform at the given instant.
Return type:: Transform

static get_transform_generator( type: ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider.Type, ) → Callable[[ostk::astrodynamics::trajectory::State], ostk.physics.coordinate.Transform]¶

Returns the transform generator function for a given type.

Parameters:: type (LocalOrbitalFrameTransformProvider.Type) -- The local orbital frame provider type.
Returns:: The transform generator function.
Return type:: callable[[State], Transform]

is_defined( self: ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider, ) → bool¶

Returns true if the provider is defined.

Returns:: True if the provider is defined.
Return type:: bool