IOrientation

class ansys.stk.core.stkutil.IOrientation

Interface to set and retrieve the orientation method.

Overview

Methods

convert_to	Change the orientation method to the type specified.
assign	Assign a new orientation method.
assign_az_el	Set orientation using the AzEl representation.
assign_euler_angles	Set orientation using the Euler angles representation.
assign_quaternion	Set orientation using the Quaternion representation.
assign_ypr_angles	Set orientation using the YPR angles representation.
query_az_el	Get orientation using the AzEl representation.
query_euler_angles	Get orientation using the Euler angles representation.
query_quaternion	Get orientation using the Quaternion representation.
query_ypr_angles	Get orientation using the YPR angles representation.
query_az_el_array	Return the AzEl elements as an array.
query_euler_angles_array	Return the Euler elements as an array.
query_quaternion_array	Return the Quaternion elements as an array.
query_ypr_angles_array	Return the YPR Angles elements as an array.

Properties

orientation_type

Return the orientation method currently being used.

Import detail

from ansys.stk.core.stkutil import IOrientation

Property detail

property IOrientation.orientation_type: OrientationType

Return the orientation method currently being used.

Method detail

IOrientation.convert_to(self, type: OrientationType) → IOrientation

Change the orientation method to the type specified.

Parameters:

type : OrientationType

Returns:

IOrientation

IOrientation.assign(self, orientation: IOrientation) → None

Assign a new orientation method.

Parameters:

orientation : IOrientation

Returns:

None

IOrientation.assign_az_el(self, azimuth: Any, elevation: Any, about_boresight: AzElAboutBoresight) → None

Set orientation using the AzEl representation.

Parameters:

azimuth : Any

elevation : Any

about_boresight : AzElAboutBoresight

Returns:

None

IOrientation.assign_euler_angles(self, sequence: EulerOrientationSequenceType, a: Any, b: Any, c: Any) → None

Set orientation using the Euler angles representation.

Parameters:

sequence : EulerOrientationSequenceType

a : Any

b : Any

c : Any

Returns:

None

IOrientation.assign_quaternion(self, qx: float, qy: float, qz: float, qs: float) → None

Set orientation using the Quaternion representation.

Parameters:

qx : float

qy : float

qz : float

qs : float

Returns:

None

IOrientation.assign_ypr_angles(self, sequence: YPRAnglesSequence, yaw: Any, pitch: Any, roll: Any) → None

Set orientation using the YPR angles representation.

Parameters:

sequence : YPRAnglesSequence

yaw : Any

pitch : Any

roll : Any

Returns:

None

IOrientation.query_az_el(self) → Tuple[Any, Any, AzElAboutBoresight]

Get orientation using the AzEl representation.

Returns:

Any, AzElAboutBoresight]

IOrientation.query_euler_angles(self, sequence: EulerOrientationSequenceType) → Tuple[Any, Any, Any]

Get orientation using the Euler angles representation.

Parameters:

sequence : EulerOrientationSequenceType

Returns:

Any]

IOrientation.query_quaternion(self) → Tuple[float, float, float, float]

Get orientation using the Quaternion representation.

Returns:

Tuple[float, float, float, float]

IOrientation.query_ypr_angles(self, sequence: YPRAnglesSequence) → Tuple[Any, Any, Any]

Get orientation using the YPR angles representation.

Parameters:

sequence : YPRAnglesSequence

Returns:

Any]

IOrientation.query_az_el_array(self) → list

Return the AzEl elements as an array.

Returns:

list

IOrientation.query_euler_angles_array(self, sequence: EulerOrientationSequenceType) → list

Return the Euler elements as an array.

Parameters:

sequence : EulerOrientationSequenceType

Returns:

list

IOrientation.query_quaternion_array(self) → list

Return the Quaternion elements as an array.

Returns:

list

IOrientation.query_ypr_angles_array(self, sequence: YPRAnglesSequence) → list

Return the YPR Angles elements as an array.

Parameters:

sequence : YPRAnglesSequence

Returns:

list