ostk.physics.coordinate.Velocity

class Velocity(self: ostk.physics.coordinate.Velocity, coordinates: numpy.ndarray[numpy.float64[3, 1]], unit: ostk::physics::coordinate::Velocity::Unit, frame: ostk::physics::coordinate::Frame)

Bases: pybind11_object

Velocity.

Constructs a velocity.

Parameters:

Methods

access_frame

Access the frame of reference.

get_coordinates

Get the coordinates.

get_unit

Get the unit.

in_frame

Convert to frame.

in_unit

Convert to unit.

is_defined

Check if the instance is defined.

meters_per_second

Create a velocity in meters per second.

string_from_unit

Create a string from unit.

to_string

Convert to string.

undefined

Get undefined velocity.

class Unit(self: ostk.physics.coordinate.Velocity.Unit, value: int)

Bases: pybind11_object

Velocity unit.

Members:

Undefined :

Undefined.

MeterPerSecond :

Meter per second.

property name
access_frame(
self: ostk.physics.coordinate.Velocity,
) ostk::physics::coordinate::Frame

Access the frame of reference.

Returns:

Frame of reference.

Return type:

Frame

get_coordinates(
self: ostk.physics.coordinate.Velocity,
) numpy.ndarray[numpy.float64[3, 1]]

Get the coordinates.

Returns:

Coordinates.

Return type:

numpy.ndarray

get_unit(
self: ostk.physics.coordinate.Velocity,
) ostk::physics::coordinate::Velocity::Unit

Get the unit.

Returns:

Unit.

Return type:

Unit

in_frame(
self: ostk.physics.coordinate.Velocity,
position: ostk.physics.coordinate.Position,
frame: ostk::physics::coordinate::Frame,
instant: ostk.physics.time.Instant,
) ostk.physics.coordinate.Velocity

Convert to frame.

Parameters:
Returns:

Velocity.

Return type:

Velocity

in_unit(
self: ostk.physics.coordinate.Velocity,
unit: ostk::physics::coordinate::Velocity::Unit,
) ostk.physics.coordinate.Velocity

Convert to unit.

Parameters:

unit (Unit) -- Unit.

Returns:

Velocity.

Return type:

Velocity

is_defined(self: ostk.physics.coordinate.Velocity) bool

Check if the instance is defined.

Returns:

True if the instance is defined.

Return type:

bool

static meters_per_second(coordinates: numpy.ndarray[numpy.float64[3, 1]], frame: ostk::physics::coordinate::Frame) ostk.physics.coordinate.Velocity

Create a velocity in meters per second.

Parameters:
Returns:

Velocity in meters per second.

Return type:

Velocity

static string_from_unit(
unit: ostk::physics::coordinate::Velocity::Unit,
) ostk.core.type.String

Create a string from unit.

Parameters:

unit (Unit) -- Unit.

Returns:

String.

Return type:

String

to_string(
self: ostk.physics.coordinate.Velocity,
precision: ostk.core.type.Integer = Integer.Undefined(),
) ostk.core.type.String

Convert to string.

Parameters:

precision (int) -- Precision.

Returns:

String.

Return type:

String

static undefined() ostk.physics.coordinate.Velocity

Get undefined velocity.

Returns:

Undefined velocity.

Return type:

Velocity