ostk.astrodynamics.dynamics.Tabulated

class Tabulated(self: ostk.astrodynamics.dynamics.Tabulated, instants: list[ostk.physics.time.Instant], contribution_profile: numpy.ndarray[numpy.float64[m, n]], coordinate_subsets: list[ostk.astrodynamics.trajectory.state.CoordinateSubset], frame: ostk.physics.coordinate.Frame, interpolation_type: ostk.mathematics.curve_fitting.Interpolator.Type = <Type.BarycentricRational: 0>)

Bases: Dynamics

The tabulated dynamics.

Constructor.

Parameters:
  • instants (list[Instant]) -- An array of instants.

  • contribution_profile (numpy.ndarray) -- A contribution profile.

  • coordinate_subsets (list[CoordinateSubset]) -- An array of coordinate subsets related to the contribution profile.

  • frame (Frame) -- A frame.

  • interpolation_type (Interpolator.Type, optional) -- The interpolation type. Defaults to Barycentric Rational.

Methods

access_contribution_profile

Access the contribution profile.

access_frame

Access the reference frame.

access_instants

Access the contribution instants.

compute_contribution

Compute the contribution from the contribution profile to the state vector.

from_environment

Create a list of Dynamics objects from an environment.

get_contribution_profile_from_coordinate_subsets

Get the contribution profile corresponding to a subset of coordinates.

get_interpolation_type

Get the interpolation type used for each row of the contribution profile (they are all the same).

get_name

Get the name of the dynamics.

get_read_coordinate_subsets

Get the coordinate subsets that the dynamics reads.

get_write_coordinate_subsets

Get the coordinate subsets that the dynamics writes.

is_defined

Check if the tabulated dynamics is defined.

access_contribution_profile(
self: ostk.astrodynamics.dynamics.Tabulated,
) numpy.ndarray[numpy.float64[m, n]]

Access the contribution profile.

Returns:

The contribution profile.

Return type:

np.ndarray

access_frame(
self: ostk.astrodynamics.dynamics.Tabulated,
) ostk.physics.coordinate.Frame

Access the reference frame.

Returns:

The reference frame.

Return type:

Frame

access_instants(
self: ostk.astrodynamics.dynamics.Tabulated,
) list[ostk.physics.time.Instant]

Access the contribution instants.

Returns:

The contribution instants.

Return type:

list[Instant]

compute_contribution(
self: ostk.astrodynamics.dynamics.Tabulated,
instant: ostk.physics.time.Instant,
x: numpy.ndarray[numpy.float64[m, 1]],
frame: ostk.physics.coordinate.Frame,
) numpy.ndarray[numpy.float64[m, 1]]

Compute the contribution from the contribution profile to the state vector.

Parameters:
  • instant (Instant) -- The instant of the state vector.

  • x (numpy.ndarray) -- The state vector.

  • frame (Frame) -- The reference frame.

Returns:

The contribution from the contribution profile to the state vector.

Return type:

numpy.ndarray

static from_environment(
environment: ostk.physics.Environment,
) list[ostk.astrodynamics.Dynamics]

Create a list of Dynamics objects from an environment.

Parameters:

environment (Environment) -- The environment to create the dynamics from.

Returns:

The list of Dynamics objects created from the environment.

Return type:

dynamics (list[Dynamics])

get_contribution_profile_from_coordinate_subsets(
self: ostk.astrodynamics.dynamics.Tabulated,
coordinate_subsets: list[ostk.astrodynamics.trajectory.state.CoordinateSubset],
) numpy.ndarray[numpy.float64[m, n]]

Get the contribution profile corresponding to a subset of coordinates.

Parameters:

coordinate_subsets (list[CoordinateSubset]) -- The coordinate subsets.

Returns:

The contribution profile.

Return type:

numpy.ndarray

get_interpolation_type(
self: ostk.astrodynamics.dynamics.Tabulated,
) ostk.mathematics.curve_fitting.Interpolator.Type

Get the interpolation type used for each row of the contribution profile (they are all the same).

Returns:

The interpolation type.

Return type:

Interpolator.Type

get_name(self: ostk.astrodynamics.Dynamics) ostk.core.type.String

Get the name of the dynamics.

Returns:

The name of the dynamics.

Return type:

name (str)

get_read_coordinate_subsets(
self: ostk.astrodynamics.Dynamics,
) list[ostk.astrodynamics.trajectory.state.CoordinateSubset]

Get the coordinate subsets that the dynamics reads.

Returns:

The coordinate subsets that the dynamics reads.

Return type:

read_coordinate_subsets (Array<CoordinateSubset>)

get_write_coordinate_subsets(
self: ostk.astrodynamics.Dynamics,
) list[ostk.astrodynamics.trajectory.state.CoordinateSubset]

Get the coordinate subsets that the dynamics writes.

Returns:

The coordinate subsets that the dynamics writes.

Return type:

write_coordinate_subsets (Array<CoordinateSubset>)

is_defined(self: ostk.astrodynamics.dynamics.Tabulated) bool

Check if the tabulated dynamics is defined.

Returns:

True if the tabulated dynamics is defined, False otherwise.

Return type:

bool