ostk.astrodynamics.flight.profile.Model

class Model

Bases: pybind11_object

A flight profile model.

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.

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.

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,
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,
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,
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

is_defined(self: ostk.astrodynamics.flight.profile.Model) 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