BasicAzElMask

class ansys.stk.core.stkobjects.BasicAzElMask

The Azimuth-Elevation Mask class.

Overview

Properties

display_mask_over_altitude_range	Display the terrain mask at a specified number of steps from the minimum to the maximum altitude above the central body.
number_of_altitude_steps	The relative intervals at which the terrain mask is displayed, e.g. if this value is 3 steps, and the minimum and maximum altitudes are 500 and 1500 km, respectively, then the terrain mask is displayed at altitudes of 500, 1000 and 1500 km.
show_mask_over_range	Display the terrain mask at the specified number of steps from the minimum to the maximum range from the facility, place or target.
number_of_range_steps	The relative intervals at which the terrain mask is displayed, e.g. if this value is 3 steps, and the minimum and maximum ranges are 500 and 1500 km, respectively, then the terrain mask is displayed at ranges of 500, 1000 and 1500 km.
display_range_minimum	The shortest range at which the terrain mask is displayed. Uses Distance Dimension.
display_range_maximum	The longest range at which the terrain mask is displayed. Uses Distance Dimension.
display_altitude_minimum	The lowest altitude at which the terrain mask is displayed. The minimum altitude must be at least equal to the altitude of the facility, place or target, including the height above ground, if specified. Uses Distance Dimension.
display_altitude_maximum	The highest altitude above the central body at which the terrain mask is displayed. Uses Distance Dimension.
display_color_at_altitude	Display the color at altitude.
altitude_color	Get or set the altitude color.
show_color_at_range	Display the color at range.
range_color	Get or set the range color.

Examples

Display the AzEl Mask in 2D/3D

# Facility facility: Facility Object
azelMask = facility.graphics.az_el_mask
azelMask.show_mask_over_range = True
azelMask.number_of_range_steps = 10
azelMask.display_range_minimum = 0  # km
azelMask.display_range_maximum = 100  # km
azelMask.show_color_at_range = True
azelMask.range_color = Colors.Cyan

Import detail

from ansys.stk.core.stkobjects import BasicAzElMask

Property detail

property BasicAzElMask.display_mask_over_altitude_range: bool

Display the terrain mask at a specified number of steps from the minimum to the maximum altitude above the central body.

property BasicAzElMask.number_of_altitude_steps: int

The relative intervals at which the terrain mask is displayed, e.g. if this value is 3 steps, and the minimum and maximum altitudes are 500 and 1500 km, respectively, then the terrain mask is displayed at altitudes of 500, 1000 and 1500 km.

property BasicAzElMask.show_mask_over_range: bool

Display the terrain mask at the specified number of steps from the minimum to the maximum range from the facility, place or target.

property BasicAzElMask.number_of_range_steps: int

The relative intervals at which the terrain mask is displayed, e.g. if this value is 3 steps, and the minimum and maximum ranges are 500 and 1500 km, respectively, then the terrain mask is displayed at ranges of 500, 1000 and 1500 km.

property BasicAzElMask.display_range_minimum: float

The shortest range at which the terrain mask is displayed. Uses Distance Dimension.

property BasicAzElMask.display_range_maximum: float

The longest range at which the terrain mask is displayed. Uses Distance Dimension.

property BasicAzElMask.display_altitude_minimum: float

The lowest altitude at which the terrain mask is displayed. The minimum altitude must be at least equal to the altitude of the facility, place or target, including the height above ground, if specified. Uses Distance Dimension.

property BasicAzElMask.display_altitude_maximum: float

The highest altitude above the central body at which the terrain mask is displayed. Uses Distance Dimension.

property BasicAzElMask.display_color_at_altitude: bool

Display the color at altitude.

property BasicAzElMask.altitude_color: Color

Get or set the altitude color.

property BasicAzElMask.show_color_at_range: bool

Display the color at range.

property BasicAzElMask.range_color: Color

Get or set the range color.