ostk.physics.unit.Angle

class Angle(*args, **kwargs)

Bases: pybind11_object

Angle.

Reference:

https://en.wikipedia.org/wiki/Angle

Overloaded function.

1. __init__(self: ostk.physics.unit.Angle, value: ostk.core.type.Real, unit: ostk::physics::unit::Angle::Unit) -> None

   Constructor.

   Args:

   value (Real): A value. unit (Unit): An angle unit.

2. __init__(self: ostk.physics.unit.Angle, angle: ostk.mathematics.geometry.Angle) -> None

   Constructor.

   Args:

   angle (Angle): An angle.

Methods

arcminutes	Create an angle in arcminutes.
arcseconds	Create an angle in arcseconds.
between	Overloaded function.
degrees	Create an angle in degrees.
get_unit	Get the unit of the angle.
half_pi	Create a half pi angle.
in_arcminutes	Overloaded function.
in_arcseconds	Overloaded function.
in_degrees	Overloaded function.
in_radians	Overloaded function.
in_revolutions	Get the angle in revolutions.
in_unit	Get the angle in the specified unit.
is_defined	Check if the angle is defined.
is_zero	Check if the angle is zero.
parse	Parse an angle from a string.
pi	Create a pi angle.
radians	Create an angle in radians.
revolutions	Create an angle in revolutions.
string_from_unit	Get the string representation of an angle unit.
symbol_from_unit	Get the symbol representation of an angle unit.
to_string	Get the string representation of the angle.
two_pi	Create a two pi angle.
undefined	Create an undefined angle.
zero	Create a zero angle.

class Unit(self: ostk.physics.unit.Angle.Unit, value: int)

Bases: pybind11_object

Members:

Undefined :

Undefined unit.

Radian :

Radian unit.

Degree :

Degree unit.

Arcminute :

Arcminute unit.

Arcsecond :

Arcsecond unit.

Revolution :

Revolution unit.

property name

__add__(

self: ostk.physics.unit.Angle,

arg0: ostk.physics.unit.Angle,

) → ostk.physics.unit.Angle

__mul__(

self: ostk.physics.unit.Angle,

arg0: ostk.core.type.Real,

) → ostk.physics.unit.Angle

static arcminutes(value: ostk.core.type.Real) → ostk.physics.unit.Angle

Create an angle in arcminutes.

Parameters:

value (Real) -- A value.

Returns:

An angle in arcminutes.

Return type:

Angle

static arcseconds(value: ostk.core.type.Real) → ostk.physics.unit.Angle

Create an angle in arcseconds.

Parameters:

value (Real) -- A value.

Returns:

An angle in arcseconds.

Return type:

Angle

static between(*args, **kwargs)

Overloaded function.

1. between(first_vector: numpy.ndarray[numpy.float64[2, 1]], second_vector: numpy.ndarray[numpy.float64[2, 1]]) -> ostk.physics.unit.Angle

   Create an angle between two vectors.

   Args:

   first_vector (Vector2d): A first vector. second_vector (Vector2d): A second vector.

   Returns:

   Angle: An angle between two vectors.

2. between(first_vector: numpy.ndarray[numpy.float64[3, 1]], second_vector: numpy.ndarray[numpy.float64[3, 1]]) -> ostk.physics.unit.Angle

   Create an angle between two vectors.

   Args:

   first_vector (numpy.ndarray): A first vector. second_vector (numpy.ndarray): A second vector.

   Returns:

   Angle: An angle between two vectors.

static degrees(value: ostk.core.type.Real) → ostk.physics.unit.Angle

Create an angle in degrees.

Parameters:

value (Real) -- A value.

Returns:

An angle in degrees.

Return type:

Angle

get_unit(self: ostk.physics.unit.Angle) → ostk::physics::unit::Angle::Unit

Get the unit of the angle.

Returns:

The unit of the angle.

Return type:

Unit

static half_pi() → ostk.physics.unit.Angle

Create a half pi angle.

Returns:

A half pi angle.

Return type:

Angle

in_arcminutes(*args, **kwargs)

Overloaded function.

1. in_arcminutes(self: ostk.physics.unit.Angle) -> ostk.core.type.Real

   Get the angle in arcminutes.

   Returns:

   float: The angle in arcminutes.

2. in_arcminutes(self: ostk.physics.unit.Angle, lower_bound: ostk.core.type.Real, upper_bound: ostk.core.type.Real) -> ostk.core.type.Real

   Get the angle in arcminutes.

   Args:

   lower_bound (Real): A lower bound. upper_bound (Real): An upper bound.

   Returns:

   float: The angle in arcminutes.

in_arcseconds(*args, **kwargs)

Overloaded function.

1. in_arcseconds(self: ostk.physics.unit.Angle) -> ostk.core.type.Real

   Get the angle in arcseconds.

   Returns:

   float: The angle in arcseconds.

2. in_arcseconds(self: ostk.physics.unit.Angle, lower_bound: ostk.core.type.Real, upper_bound: ostk.core.type.Real) -> ostk.core.type.Real

   Get the angle in arcseconds.

   Args:

   lower_bound (Real): A lower bound. upper_bound (Real): An upper bound.

   Returns:

   float: The angle in arcseconds.

in_degrees(*args, **kwargs)

Overloaded function.

1. in_degrees(self: ostk.physics.unit.Angle) -> ostk.core.type.Real

   Get the angle in degrees.

   Returns:

   float: The angle in degrees.

2. in_degrees(self: ostk.physics.unit.Angle, lower_bound: ostk.core.type.Real, upper_bound: ostk.core.type.Real) -> ostk.core.type.Real

   Get the angle in degrees.

   Args:

   lower_bound (Real): A lower bound. upper_bound (Real): An upper bound.

   Returns:

   float: The angle in degrees.

in_radians(*args, **kwargs)

Overloaded function.

1. in_radians(self: ostk.physics.unit.Angle) -> ostk.core.type.Real

   Get the angle in radians.

   Returns:

   float: The angle in radians.

2. in_radians(self: ostk.physics.unit.Angle, lower_bound: ostk.core.type.Real, upper_bound: ostk.core.type.Real) -> ostk.core.type.Real

   Get the angle in radians.

   Args:

   lower_bound (Real): A lower bound. upper_bound (Real): An upper bound.

   Returns:

   float: The angle in radians.

in_revolutions(self: ostk.physics.unit.Angle) → ostk.core.type.Real

Get the angle in revolutions.

Returns:

The angle in revolutions.

Return type:

float

in_unit(

self: ostk.physics.unit.Angle,

unit: ostk::physics::unit::Angle::Unit,

) → ostk.core.type.Real

Get the angle in the specified unit.

Parameters:

unit (Unit) -- An angle unit.

Returns:

The angle in the specified unit.

Return type:

float

is_defined(self: ostk.physics.unit.Angle) → bool

Check if the angle is defined.

Returns:

True if defined.

Return type:

bool

is_zero(self: ostk.physics.unit.Angle) → bool

Check if the angle is zero.

Returns:

True if zero.

Return type:

bool

static parse(string: ostk.core.type.String) → ostk.physics.unit.Angle

Parse an angle from a string.

Parameters:

string (str) -- A string.

Returns:

An angle.

Return type:

Angle

static pi() → ostk.physics.unit.Angle

Create a pi angle.

Returns:

A pi angle.

Return type:

Angle

static radians(value: ostk.core.type.Real) → ostk.physics.unit.Angle

Create an angle in radians.

Parameters:

value (Real) -- A value.

Returns:

An angle in radians.

Return type:

Angle

static revolutions(value: ostk.core.type.Real) → ostk.physics.unit.Angle

Create an angle in revolutions.

Parameters:

value (Real) -- A value.

Returns:

An angle in revolutions.

Return type:

Angle

static string_from_unit(unit: ostk::physics::unit::Angle::Unit) → ostk.core.type.String

Get the string representation of an angle unit.

Parameters:

unit (Unit) -- An angle unit.

Returns:

The string representation of an angle unit.

Return type:

str

static symbol_from_unit(unit: ostk::physics::unit::Angle::Unit) → ostk.core.type.String

Get the symbol representation of an angle unit.

Parameters:

unit (Unit) -- An angle unit.

Returns:

The symbol representation of an angle unit.

Return type:

str

to_string(

self: ostk.physics.unit.Angle,

precision: ostk.core.type.Integer = Integer.undefined(),

) → ostk.core.type.String

Get the string representation of the angle.

Parameters:

precision (int) -- A precision.

Returns:

The string representation of the angle.

Return type:

str

static two_pi() → ostk.physics.unit.Angle

Create a two pi angle.

Returns:

A two pi angle.

Return type:

Angle

static undefined() → ostk.physics.unit.Angle

Create an undefined angle.

Returns:

An undefined angle.

Return type:

Angle

static zero() → ostk.physics.unit.Angle

Create a zero angle.

Returns:

A zero angle.

Return type:

Angle