ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

class LocalOrbitalFrameFactory¶

Bases: pybind11_object

The local orbital frame factory.

Methods

`LVLH`	Get a Local Vertical Local Horizontal (LVLH) local orbital frame factory.
`NED`	Get a North-East-Down (NED) local orbital frame factory.
`QSW`	Get a Quasi-Satellite World (QSW) local orbital frame factory.
`TNW`	Get a Tangent-Normal-Wideband (TNW) local orbital frame factory.
`VNC`	Get a Velocity-Normal-Co-normal (VNC) local orbital frame factory.
`VVLH`	Get a Velocity Local Vertical Local Horizontal (VVLH) local orbital frame factory.
`access_parent_frame`	Get the parent frame.
`construct`	Overloaded function.
`generate_frame`	Generate a local orbital frame.
`get_provider_type`	Get the provider type.
`is_defined`	Check if the local orbital frame factory is defined.
`undefined`	Get an undefined local orbital frame factory.

static LVLH( parent_frame: ostk.physics.coordinate.Frame, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

Get a Local Vertical Local Horizontal (LVLH) local orbital frame factory.

Parameters:: parent_frame (Frame) -- The parent frame.
Returns:: The LVLH local orbital frame factory.
Return type:: LocalOrbitalFrameFactory

static NED( parent_frame: ostk.physics.coordinate.Frame, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

Get a North-East-Down (NED) local orbital frame factory.

Parameters:: parent_frame (Frame) -- The parent frame.
Returns:: The NED local orbital frame factory.
Return type:: LocalOrbitalFrameFactory

static QSW( parent_frame: ostk.physics.coordinate.Frame, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

Get a Quasi-Satellite World (QSW) local orbital frame factory.

Parameters:: parent_frame (Frame) -- The parent frame.
Returns:: The QSW local orbital frame factory.
Return type:: LocalOrbitalFrameFactory

static TNW( parent_frame: ostk.physics.coordinate.Frame, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

Get a Tangent-Normal-Wideband (TNW) local orbital frame factory.

Parameters:: parent_frame (Frame) -- The parent frame.
Returns:: The TNW local orbital frame factory.
Return type:: LocalOrbitalFrameFactory

static VNC( parent_frame: ostk.physics.coordinate.Frame, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

Get a Velocity-Normal-Co-normal (VNC) local orbital frame factory.

Parameters:: parent_frame (Frame) -- The parent frame.
Returns:: The VNC local orbital frame factory.
Return type:: LocalOrbitalFrameFactory

static VVLH( parent_frame: ostk.physics.coordinate.Frame, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

Get a Velocity Local Vertical Local Horizontal (VVLH) local orbital frame factory.

Parameters:: parent_frame (Frame) -- The parent frame.
Returns:: The VVLH local orbital frame factory.
Return type:: LocalOrbitalFrameFactory

access_parent_frame( self: ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory, ) → ostk.physics.coordinate.Frame¶

Get the parent frame.

Returns:: The parent frame.
Return type:: Frame

static construct(*args, **kwargs)¶

Overloaded function.

construct(type: ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider.Type, parent_frame: ostk.physics.coordinate.Frame) -> ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory

Construct a local orbital frame factory for the provided type.

Args:
type (LocalOrbitalFrameTransformProvider.Type): The type of local orbital frame transform provider. parent_frame (Frame): The parent frame.

Returns:
LocalOrbitalFrameFactory: The local orbital frame factory.
construct(transform_generator: Callable[[ostk::astrodynamics::trajectory::State], ostk.physics.coordinate.Transform], parent_frame: ostk.physics.coordinate.Frame) -> ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory

Construct a local orbital frame factory for a custom type, using the provided transform generator.

Args:
transform_generator (callable[[State], Transform]): The transform generator. parent_frame (Frame): The parent frame.

Returns:
LocalOrbitalFrameFactory: The local orbital frame factory.

generate_frame( self: ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory, state: ostk::astrodynamics::trajectory::State, ) → ostk.physics.coordinate.Frame¶

Generate a local orbital frame.

Parameters:: state (State) -- The state.
Returns:: The local orbital frame.
Return type:: Frame

get_provider_type( self: ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory, ) → ostk.astrodynamics.trajectory.LocalOrbitalFrameTransformProvider.Type¶

Get the provider type.

Returns:: The provider type.
Return type:: LocalOrbitalFrameTransformProvider.Type

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

Check if the local orbital frame factory is defined.

Returns:: True if the local orbital frame factory is defined, False otherwise.
Return type:: Frame

static undefined() → ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory¶

Get an undefined local orbital frame factory.

Returns:: The undefined local orbital frame factory.
Return type:: LocalOrbitalFrameFactory