ostk.astrodynamics.trajectory.state.CoordinateBroker

class CoordinateBroker(*args, **kwargs)

Bases: pybind11_object

Class to manage the coordinate subsets of a state.

Overloaded function.

1. __init__(self: ostk.astrodynamics.trajectory.state.CoordinateBroker) -> None

   Default constructor.

2. __init__(self: ostk.astrodynamics.trajectory.state.CoordinateBroker, coordinate_subsets: list[ostk::astrodynamics::trajectory::state::CoordinateSubset]) -> None

   Create a broker for ther provided coordinate subsets.

   Args:

   list[CoordinateSubset]: The list of coordinate subsets.

Methods

access_subsets	Access the list of coordinate subsets.
add_subset	Add a coordinate subset.
extract_coordinate	Extract the coordinates of a subset from a full coordinates vector.
extract_coordinates	Extract the coordinates of multiple subsets from a full coordinates vector.
get_number_of_coordinates	Get the total number of coordinates.
get_number_of_subsets	Get the number of coordinate subsets.
get_subsets	Get the list of coordinate subsets.
has_subset	Check if the coordinate broker has a given coordinate subset.

access_subsets(

self: ostk.astrodynamics.trajectory.state.CoordinateBroker,

) → list[ostk::astrodynamics::trajectory::state::CoordinateSubset]

Access the list of coordinate subsets.

Returns:

The list of coordinate subsets.

Return type:

list[CoordinateSubset]

add_subset(

self: ostk.astrodynamics.trajectory.state.CoordinateBroker,

coordinate_subset: ostk::astrodynamics::trajectory::state::CoordinateSubset,

) → int

Add a coordinate subset.

Parameters:

coordinate_subset (CoordinateSubset) -- The coordinate subset to add.

extract_coordinate(self: ostk.astrodynamics.trajectory.state.CoordinateBroker, coordinates: numpy.ndarray[numpy.float64[m, 1]], coordinate_subset: ostk::astrodynamics::trajectory::state::CoordinateSubset) → numpy.ndarray[numpy.float64[m, 1]]

Extract the coordinates of a subset from a full coordinates vector.

Parameters:

• coordinates (numpy.ndarray) -- The full coordinates vector.

• coordinate_subset (CoordinateSubset) -- The coordinate subset.

Returns:

The coordinates of the subset.

Return type:

numpy.ndarray

extract_coordinates(self: ostk.astrodynamics.trajectory.state.CoordinateBroker, coordinates: numpy.ndarray[numpy.float64[m, 1]], coordinate_subsets: list[ostk::astrodynamics::trajectory::state::CoordinateSubset]) → numpy.ndarray[numpy.float64[m, 1]]

Extract the coordinates of multiple subsets from a full coordinates vector.

Parameters:

• coordinates (numpy.ndarray) -- The full coordinates vector.

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

Returns:

The coordinates of the subsets.

Return type:

numpy.ndarray

get_number_of_coordinates(

self: ostk.astrodynamics.trajectory.state.CoordinateBroker,

) → int

Get the total number of coordinates.

Returns:

The total number of coordinates.

Return type:

int

get_number_of_subsets(

self: ostk.astrodynamics.trajectory.state.CoordinateBroker,

) → int

Get the number of coordinate subsets.

Returns:

The number of coordinate subsets.

Return type:

int

get_subsets(

self: ostk.astrodynamics.trajectory.state.CoordinateBroker,

) → list[ostk::astrodynamics::trajectory::state::CoordinateSubset]

Get the list of coordinate subsets.

Returns:

The list of coordinate subsets.

Return type:

list[CoordinateSubset]

has_subset(

self: ostk.astrodynamics.trajectory.state.CoordinateBroker,

coordinate_subset: ostk::astrodynamics::trajectory::state::CoordinateSubset,

) → bool

Check if the coordinate broker has a given coordinate subset.

Parameters:

coordinate_subset (CoordinateSubset) -- The coordinate subset to check.

Returns:

True if the coordinate broker has the coordinate subset, False otherwise.

Return type:

bool