ostk.astrodynamics.trajectory.state.CoordinateSubset¶

class CoordinateSubset( self: ostk.astrodynamics.trajectory.state.CoordinateSubset, name: ostk.core.type.String, size: int, )¶

Bases: pybind11_object

State coordinate subset. It contains information related to a particular group of coordinates. It does not contain the coordinate values.

Constructor.

Parameters:

name (str) -- The name of the coordinate subset.
size (int) -- The size of the coordinate subset.

Methods

`add`	Add the coordinates of another state to the coordinates of this state.
`ballistic_coefficient`	Get the ballistic coefficient coordinate subset.
`drag_coefficient`	Get the drag coefficient coordinate subset.
`get_id`	Get the identifier of the coordinate subset.
`get_name`	Get the name of the coordinate subset.
`get_size`	Get the size of the coordinate subset.
`in_frame`	Convert the coordinates of this state from one frame to another.
`mass`	Get the mass coordinate subset.
`mass_flow_rate`	Get the mass flow rate coordinate subset.
`subtract`	Subtract the coordinates of another state from the coordinates of this state.
`surface_area`	Get the surface area coordinate subset.

add( self: ostk.astrodynamics.trajectory.state.CoordinateSubset, instant: ostk.physics.time.Instant, coordinates: numpy.ndarray[numpy.float64[m, 1]], another_coordinates: numpy.ndarray[numpy.float64[m, 1]], frame: ostk.physics.coordinate.Frame, coordinate_broker: ostk.astrodynamics.trajectory.state.CoordinateBroker, ) → numpy.ndarray[numpy.float64[m, 1]]¶

Add the coordinates of another state to the coordinates of this state.

Parameters:

instant (Instant) -- The instant of the state.
coordinates (numpy.ndarray) -- The coordinates of this state.
another_coordinates (numpy.ndarray) -- The coordinates of the other state.
frame (Frame) -- The reference frame of the coordinates.
coordinate_broker (CoordinateBroker) -- The coordinate broker.

Returns:

The sum of the coordinates.

Return type:

numpy.ndarray

static ballistic_coefficient() → ostk.astrodynamics.trajectory.state.CoordinateSubset¶

Get the ballistic coefficient coordinate subset.

Returns:: The ballistic coefficient coordinate subset.
Return type:: CoordinateSubset

static drag_coefficient() → ostk.astrodynamics.trajectory.state.CoordinateSubset¶

Get the drag coefficient coordinate subset.

Returns:: The drag coefficient coordinate subset.
Return type:: CoordinateSubset

get_id( self: ostk.astrodynamics.trajectory.state.CoordinateSubset, ) → ostk.core.type.String¶

Get the identifier of the coordinate subset.

Returns:: The identifier of the coordinate subset.
Return type:: str

get_name( self: ostk.astrodynamics.trajectory.state.CoordinateSubset, ) → ostk.core.type.String¶

Get the name of the coordinate subset.

Returns:: The name of the coordinate subset.
Return type:: str

get_size( self: ostk.astrodynamics.trajectory.state.CoordinateSubset, ) → int¶

Get the size of the coordinate subset.

Returns:: The size of the coordinate subset.
Return type:: int

in_frame( self: ostk.astrodynamics.trajectory.state.CoordinateSubset, instant: ostk.physics.time.Instant, coordinates: numpy.ndarray[numpy.float64[m, 1]], from_frame: ostk.physics.coordinate.Frame, to_frame: ostk.physics.coordinate.Frame, coordinate_broker: ostk.astrodynamics.trajectory.state.CoordinateBroker, ) → numpy.ndarray[numpy.float64[m, 1]]¶

Convert the coordinates of this state from one frame to another.

Parameters:

instant (Instant) -- The instant of the state.
coordinates (numpy.ndarray) -- The coordinates of this state.
from_frame (Frame) -- The reference frame of the input coordinates.
to_frame (Frame) -- The reference frame of the output coordinates.
coordinate_broker (CoordinateBroker) -- The coordinate broker.

Returns:

The coordinates in the output frame.

Return type:

numpy.ndarray

static mass() → ostk.astrodynamics.trajectory.state.CoordinateSubset¶

Get the mass coordinate subset.

Returns:: The mass coordinate subset.
Return type:: CoordinateSubset

static mass_flow_rate() → ostk.astrodynamics.trajectory.state.CoordinateSubset¶

Get the mass flow rate coordinate subset.

Returns:: The mass flow rate coordinate subset.
Return type:: CoordinateSubset

subtract( self: ostk.astrodynamics.trajectory.state.CoordinateSubset, instant: ostk.physics.time.Instant, coordinates: numpy.ndarray[numpy.float64[m, 1]], another_coordinates: numpy.ndarray[numpy.float64[m, 1]], frame: ostk.physics.coordinate.Frame, coordinate_broker: ostk.astrodynamics.trajectory.state.CoordinateBroker, ) → numpy.ndarray[numpy.float64[m, 1]]¶

Subtract the coordinates of another state from the coordinates of this state.

Parameters:

instant (Instant) -- The instant of the state.
coordinates (numpy.ndarray) -- The coordinates of this state.
another_coordinates (numpy.ndarray) -- The coordinates of the other state.
frame (Frame) -- The reference frame of the coordinates.
coordinate_broker (CoordinateBroker) -- The coordinate broker.

Returns:

The difference of the coordinates.

Return type:

numpy.ndarray

static surface_area() → ostk.astrodynamics.trajectory.state.CoordinateSubset¶

Get the surface area coordinate subset.

Returns:: The surface area coordinate subset.
Return type:: CoordinateSubset