ostk.astrodynamics.trajectory.LocalOrbitalFrameDirection

class LocalOrbitalFrameDirection(
self: ostk.astrodynamics.trajectory.LocalOrbitalFrameDirection,
vector: numpy.ndarray[numpy.float64[3, 1]],
local_orbital_frame_factory: ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory,
)

Bases: pybind11_object

A local orbital frame direction.

Construct a new LocalOrbitalFrameDirection object.

Parameters:
  • vector (numpy.ndarray) -- The vector expressed in the local orbital frame.

  • local_orbital_frame_factory (LocalOrbitalFrameFactory) -- The local orbital frame factory that defines the frame.

Returns:

The new LocalOrbitalFrameDirection object.

Return type:

LocalOrbitalFrameDirection

Methods

get_local_orbital_frame_factory

Get the local orbital frame factory that defines the frame.

get_value

Get the vector expressed in the local orbital frame.

is_defined

Check if the local orbital frame direction is defined.

undefined

Get an undefined local orbital frame direction.

get_local_orbital_frame_factory(
self: ostk.astrodynamics.trajectory.LocalOrbitalFrameDirection,
) ostk.astrodynamics.trajectory.LocalOrbitalFrameFactory

Get the local orbital frame factory that defines the frame.

Returns:

The local orbital frame factory that defines the frame.

Return type:

LocalOrbitalFrameFactory

get_value(
self: ostk.astrodynamics.trajectory.LocalOrbitalFrameDirection,
) numpy.ndarray[numpy.float64[3, 1]]

Get the vector expressed in the local orbital frame.

Returns:

The vector expressed in the local orbital frame.

Return type:

Vector3d

is_defined(
self: ostk.astrodynamics.trajectory.LocalOrbitalFrameDirection,
) bool

Check if the local orbital frame direction is defined.

Returns:

True if the local orbital frame direction is defined, False otherwise.

Return type:

bool

static undefined() ostk.astrodynamics.trajectory.LocalOrbitalFrameDirection

Get an undefined local orbital frame direction.

Returns:

The undefined local orbital frame direction.

Return type:

LocalOrbitalFrameDirection