Skip to content

ostk.astrodynamics.flight.profile.model.Transform¶

class Transform( self: ostk.astrodynamics.flight.profile.model.Transform, dynamic_provider: ostk.physics.coordinate.frame.provider.Dynamic, frame: ostk.physics.coordinate.Frame, )¶

Bases: Model

A flight profile model defined by a transform.

Constructor.

Parameters:

dynamic_provider (DynamicProvider) -- The dynamic provider of the transform.
frame (Frame) -- The frame of the transform.

Methods

`as_tabulated`	Cast the model to a tabulated model.
`as_transform`	Cast the model to a transform model.
`calculate_state_at`	Calculate the state of the model at a specific instant.
`calculate_states_at`	Calculate the states of the model at specific instants.
`get_axes_at`	Get the axes of the model at a specific instant.
`get_body_frame`	Get the body frame of the model with the specified name.
`inertial_pointing`	Create a transform for inertial pointing.
`is_defined`	Check if the model is defined.
`is_tabulated`	Check if the model is a tabulated model.
`is_transform`	Check if the model is a transform model.
`local_orbital_frame_pointing`	Create a profile aligned with the provided local orbital frame type.
`undefined`	Get an undefined transform.

as_tabulated( self: ostk.astrodynamics.flight.profile.Model, ) → ostk::astrodynamics::flight::profile::model::Tabulated¶

Cast the model to a tabulated model.

Returns:: The tabulated model.
Return type:: Tabulated

as_transform( self: ostk.astrodynamics.flight.profile.Model, ) → ostk::astrodynamics::flight::profile::model::Transform¶

Cast the model to a transform model.

Returns:: The transform model.
Return type:: Transform

calculate_state_at( self: ostk.astrodynamics.flight.profile.model.Transform, instant: ostk.physics.time.Instant, ) → ostk.astrodynamics.trajectory.State¶

Calculate the state of the model at a specific instant.

Parameters:: instant (Instant) -- The instant at which to calculate the state.
Returns:: The state of the model at the specified instant.
Return type:: State

calculate_states_at( self: ostk.astrodynamics.flight.profile.Model, instants: list[ostk.physics.time.Instant], ) → list[ostk.astrodynamics.trajectory.State]¶

Calculate the states of the model at specific instants. It can be more performant than looping calculate_state_at for multiple instants.

Parameters:: instants (list[Instant]) -- The instants at which to calculate the states.
Returns:: The states of the model at the specified instants.
Return type:: list[State]

get_axes_at( self: ostk.astrodynamics.flight.profile.model.Transform, instant: ostk.physics.time.Instant, ) → ostk.physics.coordinate.Axes¶

Get the axes of the model at a specific instant.

Parameters:: instant (Instant) -- The instant at which to get the axes.
Returns:: The axes of the model at the specified instant.
Return type:: numpy.ndarray

get_body_frame( self: ostk.astrodynamics.flight.profile.model.Transform, frame_name: ostk.core.type.String, ) → ostk.physics.coordinate.Frame¶

Get the body frame of the model with the specified name.

Parameters:: frame_name (str) -- The name of the body frame.
Returns:: The body frame of the model with the specified name.
Return type:: Frame

static inertial_pointing( trajectory: ostk.astrodynamics.Trajectory, quaternion: ostk.mathematics.geometry.d3.transformation.rotation.Quaternion, ) → ostk.astrodynamics.flight.profile.model.Transform¶

Create a transform for inertial pointing.

Parameters:

trajectory (Trajectory) -- The trajectory of the satellite.
quaternion (Quaternion) -- The quaternion to rotate the axes by.

Returns:

The transform for inertial pointing.

Return type:

is_defined(self: ostk.astrodynamics.flight.profile.model.Transform) → bool¶

Check if the model is defined.

Returns:: True if the model is defined, False otherwise.
Return type:: bool

is_tabulated(self: ostk.astrodynamics.flight.profile.Model) → bool¶

Check if the model is a tabulated model.

Returns:: True if the model is a tabulated model, False otherwise.
Return type:: bool

is_transform(self: ostk.astrodynamics.flight.profile.Model) → bool¶

Check if the model is a transform model.

Returns:: True if the model is a transform model, False otherwise.
Return type:: bool

static local_orbital_frame_pointing( orbit: ostk.astrodynamics.trajectory.Orbit, orbital_frame_type: ostk.astrodynamics.trajectory.Orbit.FrameType, ) → ostk.astrodynamics.flight.profile.model.Transform¶

Create a profile aligned with the provided local orbital frame type.

Parameters:

orbit (Orbit) -- The orbit of the satellite.
orbital_frame_type (OrbitalFrameType) -- The type of the orbital frame.

Returns:

The transform for the local orbital frame pointing.

Return type:

static undefined() → ostk.astrodynamics.flight.profile.model.Transform¶

Get an undefined transform.

Returns:: The undefined transform.
Return type:: Transform