SensorCommonTasks

class ansys.stk.core.stkobjects.SensorCommonTasks

Class defining the Sensor Common class.

Overview

Methods

set_pattern_simple_conic	Define the sensor using a simple conic pattern.
set_pattern_complex_conic	Define the sensor using a complex conic pattern.
set_pattern_eoir	Define the sensor using a EOIR pattern.
set_pattern_half_power	Define the sensor using a half power pattern.
set_pattern_rectangular	Define the sensor using a rectangular pattern.
set_pattern_custom	Define the sensor using a custom pattern.
set_pattern_sar	Define the sensor using a SAR pattern.
set_pointing_fixed_az_el	Set the pointing method to Fixed with an AzEl orientation.
set_pointing_fixed_euler	Set the pointing method to Fixed with a Euler Angles orientation.
set_pointing_fixed_quaternion	Set the pointing method to Fixed with a Quaternion orientation.
set_pointing_fixed_ypr	Set the pointing method to Fixed with a YPR Angles orientation.
set_pointing_fixed_axes_az_el	Set the pointing method to FixedAxes with an AzEl orientation.
set_pointing_fixed_axes_euler	Set the pointing method to FixedAxes with a Euler Angles orientation.
set_pointing_fixed_axes_quaternion	Set the pointing method to FixedAxes with a Quaternion orientation.
set_pointing_fixed_axes_ypr	Set the pointing method to FixedAxes with a YPR Angles orientation.
set_pointing_3d_model	Set the pointing method to 3DModel.
set_pointing_grazing_altitude	Set the pointing method to GrazingAlt.
set_pointing_spinning	Set the pointing method to Spinning.
set_pointing_targeted_tracking	Set the pointing method to Targeted with Tracking.
set_pointing_along_vector	Set the pointing method to Along Vector.

Examples

Define sensor pointing fixed axes YPR

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_ypr("CentralBody/Sun J2000 Axes", YPRAnglesSequence.RYP, 11, 22, 33)

Define sensor pointing fixed YPR

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_ypr(YPRAnglesSequence.RPY, 12, 24, 36)

Define sensor pointing fixed axes Quaternion

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_quaternion("CentralBody/Sun J2000 Axes", 0.1, 0.2, 0.3, 0.4)

Define sensor pointing fixed Quaternion

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_quaternion(0.1, 0.2, 0.3, 0.4)

Define sensor pointing fixed axes Euler

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_euler(
    "CentralBody/Sun J2000 Axes", EulerOrientationSequenceType.SEQUENCE_132, 30, 40, 50
)

Define sensor pointing fixed Euler

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_euler(EulerOrientationSequenceType.SEQUENCE_132, 30, 40, 50)

Define sensor pointing fixed axes AzEl

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_az_el("CentralBody/Sun J2000 Axes", 11, 22, AzElAboutBoresight.HOLD)

Define sensor pointing fixed AzEl

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_az_el(4.5, -45.0, AzElAboutBoresight.ROTATE)

Import detail

from ansys.stk.core.stkobjects import SensorCommonTasks

Method detail

SensorCommonTasks.set_pattern_simple_conic(self, cone_angle: Any, angular_resolution: Any) → SensorSimpleConicPattern

Define the sensor using a simple conic pattern.

Parameters:

cone_angle : Any

angular_resolution : Any

Returns:

SensorSimpleConicPattern

SensorCommonTasks.set_pattern_complex_conic(self, inner_cone_half_angle: Any, outer_cone_half_angle: Any, minimum_clock_angle: Any, maximum_clock_angle: Any) → SensorComplexConicPattern

Define the sensor using a complex conic pattern.

Parameters:

inner_cone_half_angle : Any

outer_cone_half_angle : Any

minimum_clock_angle : Any

maximum_clock_angle : Any

Returns:

SensorComplexConicPattern

SensorCommonTasks.set_pattern_eoir(self, line_of_site_jitter: float, processing_level: SensorEOIRProcessingLevelType) → SensorEOIRPattern

Define the sensor using a EOIR pattern.

Parameters:

line_of_site_jitter : float

processing_level : SensorEOIRProcessingLevelType

Returns:

SensorEOIRPattern

SensorCommonTasks.set_pattern_half_power(self, frequency: float, antenna_diameter: float, angular_resolution: Any) → SensorHalfPowerPattern

Define the sensor using a half power pattern.

Parameters:

frequency : float

antenna_diameter : float

angular_resolution : Any

Returns:

SensorHalfPowerPattern

SensorCommonTasks.set_pattern_rectangular(self, vertical_half_angle: Any, horizontal_half_angle: Any) → SensorRectangularPattern

Define the sensor using a rectangular pattern.

Parameters:

vertical_half_angle : Any

horizontal_half_angle : Any

Returns:

SensorRectangularPattern

SensorCommonTasks.set_pattern_custom(self, filename: str) → SensorCustomPattern

Define the sensor using a custom pattern.

Parameters:

filename : str

Returns:

SensorCustomPattern

SensorCommonTasks.set_pattern_sar(self, min_elevation_angle: Any, max_elevation_angle: Any, fore_exclusion_angle: Any, aft_exclusion_angle: Any, parent_altitude: float) → SensorSARPattern

Define the sensor using a SAR pattern.

Parameters:

min_elevation_angle : Any

max_elevation_angle : Any

fore_exclusion_angle : Any

aft_exclusion_angle : Any

parent_altitude : float

Returns:

SensorSARPattern

SensorCommonTasks.set_pointing_fixed_az_el(self, azimuth: Any, elevation: Any, about_boresight: AzElAboutBoresight) → SensorPointingFixed

Set the pointing method to Fixed with an AzEl orientation.

Parameters:

azimuth : Any

elevation : Any

about_boresight : AzElAboutBoresight

Returns:

SensorPointingFixed

Examples

Define sensor pointing fixed AzEl

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_az_el(4.5, -45.0, AzElAboutBoresight.ROTATE)

SensorCommonTasks.set_pointing_fixed_euler(self, sequence: EulerOrientationSequenceType, a: Any, b: Any, c: Any) → SensorPointingFixed

Set the pointing method to Fixed with a Euler Angles orientation.

Parameters:

sequence : EulerOrientationSequenceType

a : Any

b : Any

c : Any

Returns:

SensorPointingFixed

Examples

Define sensor pointing fixed Euler

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_euler(EulerOrientationSequenceType.SEQUENCE_132, 30, 40, 50)

SensorCommonTasks.set_pointing_fixed_quaternion(self, qx: float, qy: float, qz: float, qs: float) → SensorPointingFixed

Set the pointing method to Fixed with a Quaternion orientation.

Parameters:

qx : float

qy : float

qz : float

qs : float

Returns:

SensorPointingFixed

Examples

Define sensor pointing fixed Quaternion

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_quaternion(0.1, 0.2, 0.3, 0.4)

SensorCommonTasks.set_pointing_fixed_ypr(self, sequence: YPRAnglesSequence, yaw: Any, pitch: Any, roll: Any) → SensorPointingFixed

Set the pointing method to Fixed with a YPR Angles orientation.

Parameters:

sequence : YPRAnglesSequence

yaw : Any

pitch : Any

roll : Any

Returns:

SensorPointingFixed

Examples

Define sensor pointing fixed YPR

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_ypr(YPRAnglesSequence.RPY, 12, 24, 36)

SensorCommonTasks.set_pointing_fixed_axes_az_el(self, reference_axes: str, azimuth: Any, elevation: Any, about_boresight: AzElAboutBoresight) → SensorPointingFixedInAxes

Set the pointing method to FixedAxes with an AzEl orientation.

Parameters:

reference_axes : str

azimuth : Any

elevation : Any

about_boresight : AzElAboutBoresight

Returns:

SensorPointingFixedInAxes

Examples

Define sensor pointing fixed axes AzEl

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_az_el("CentralBody/Sun J2000 Axes", 11, 22, AzElAboutBoresight.HOLD)

SensorCommonTasks.set_pointing_fixed_axes_euler(self, reference_axes: str, sequence: EulerOrientationSequenceType, a: Any, b: Any, c: Any) → SensorPointingFixedInAxes

Set the pointing method to FixedAxes with a Euler Angles orientation.

Parameters:

reference_axes : str

sequence : EulerOrientationSequenceType

a : Any

b : Any

c : Any

Returns:

SensorPointingFixedInAxes

Examples

Define sensor pointing fixed axes Euler

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_euler(
    "CentralBody/Sun J2000 Axes", EulerOrientationSequenceType.SEQUENCE_132, 30, 40, 50
)

SensorCommonTasks.set_pointing_fixed_axes_quaternion(self, reference_axes: str, qx: float, qy: float, qz: float, qs: float) → SensorPointingFixedInAxes

Set the pointing method to FixedAxes with a Quaternion orientation.

Parameters:

reference_axes : str

qx : float

qy : float

qz : float

qs : float

Returns:

SensorPointingFixedInAxes

Examples

Define sensor pointing fixed axes Quaternion

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_quaternion("CentralBody/Sun J2000 Axes", 0.1, 0.2, 0.3, 0.4)

SensorCommonTasks.set_pointing_fixed_axes_ypr(self, reference_axes: str, sequence: YPRAnglesSequence, yaw: Any, pitch: Any, roll: Any) → SensorPointingFixedInAxes

Set the pointing method to FixedAxes with a YPR Angles orientation.

Parameters:

reference_axes : str

sequence : YPRAnglesSequence

yaw : Any

pitch : Any

roll : Any

Returns:

SensorPointingFixedInAxes

Examples

Define sensor pointing fixed axes YPR

# Sensor sensor: Sensor object
# Change pointing and set
sensor.common_tasks.set_pointing_fixed_axes_ypr("CentralBody/Sun J2000 Axes", YPRAnglesSequence.RYP, 11, 22, 33)

SensorCommonTasks.set_pointing_3d_model(self, attach_name: str) → SensorPointing3DModel

Set the pointing method to 3DModel.

Parameters:

attach_name : str

Returns:

SensorPointing3DModel

SensorCommonTasks.set_pointing_grazing_altitude(self, azimuth_offset: Any, grazing_alt: float) → SensorPointingGrazingAltitude

Set the pointing method to GrazingAlt.

Parameters:

azimuth_offset : Any

grazing_alt : float

Returns:

SensorPointingGrazingAltitude

SensorCommonTasks.set_pointing_spinning(self, spin_axis_azimuth: Any, spin_axis_elevation: Any, spin_axis_cone_angle: Any, scan_mode: SensorScanMode, spin_rate: float, offset_angle: Any, clock_angle_start: Any, clock_angle_stop: Any) → SensorPointingSpinning

Set the pointing method to Spinning.

Parameters:

spin_axis_azimuth : Any

spin_axis_elevation : Any

spin_axis_cone_angle : Any

scan_mode : SensorScanMode

spin_rate : float

offset_angle : Any

clock_angle_start : Any

clock_angle_stop : Any

Returns:

SensorPointingSpinning

SensorCommonTasks.set_pointing_targeted_tracking(self, track_mode_type: TrackMode, about_boresight_type: BoresightType, target_path: str) → SensorPointingTargeted

Set the pointing method to Targeted with Tracking.

Parameters:

track_mode_type : TrackMode

about_boresight_type : BoresightType

target_path : str

Returns:

SensorPointingTargeted

SensorCommonTasks.set_pointing_along_vector(self, alignment_vector: str, constraint_vector: str, clock_angle_offset: Any) → SensorPointingAlongVector

Set the pointing method to Along Vector.

Parameters:

alignment_vector : str

constraint_vector : str

clock_angle_offset : Any

Returns:

SensorPointingAlongVector