AntennaVolumeGraphics#

class ansys.stk.core.stkobjects.AntennaVolumeGraphics#: Class defining 3D Volume Graphics properties of a Antenna.

Overview#

Methods

`set_resolution`	Set the azimuth/elevation ranges and resolution.
`set_number_of_points`	Set the azimuth/elevation ranges and number of points.

Properties

`show`	Opt whether to display volume graphics for the antenna.
`wireframe`	Enable the ability to view the volume as a wireframe.
`gain_offset`	Do not use this property, as it is deprecated. Use the MinimumDisplayedGain property instead. Gets or sets the gain offset value.
`gain_scale`	Get or set the gain scale value.
`azimuth_start`	Get the azimuth start value.
`azimuth_stop`	Get the azimuth stop value.
`azimuth_resolution`	Get the azimuth resolution.
`azimuth_number_of_points`	Get the number of azimuth points.
`elevation_start`	Get the elevation start value.
`elevation_stop`	Get the elevation stop value.
`elevation_resolution`	Get the elevation resolution.
`elevation_number_of_points`	Get the number of elevation points.
`color_method`	Color method for volume levels (color ramp or explicit).
`start_color`	Get or set the color ramp start color.
`stop_color`	Get or set the color ramp stop color.
`levels`	Get the collection of volume levels.
`relative_to_maximum`	Get or set the contours value represents the gain value relative to the maximum.
`coordinate_system`	Get or set the coordinate system for defining the resolution of the antenna graphics.
`minimum_displayed_gain`	Get or set the minimum displayed gain value.

Import detail#

from ansys.stk.core.stkobjects import AntennaVolumeGraphics

Property detail#

property AntennaVolumeGraphics.show: bool#: Opt whether to display volume graphics for the antenna.

property AntennaVolumeGraphics.wireframe: bool#: Enable the ability to view the volume as a wireframe.

property AntennaVolumeGraphics.gain_offset: float#: Do not use this property, as it is deprecated. Use the MinimumDisplayedGain property instead. Gets or sets the gain offset value.

property AntennaVolumeGraphics.gain_scale: float#: Get or set the gain scale value.

property AntennaVolumeGraphics.azimuth_start: float#: Get the azimuth start value.

property AntennaVolumeGraphics.azimuth_stop: float#: Get the azimuth stop value.

property AntennaVolumeGraphics.azimuth_resolution: float#: Get the azimuth resolution.

property AntennaVolumeGraphics.azimuth_number_of_points: int#: Get the number of azimuth points.

property AntennaVolumeGraphics.elevation_start: float#: Get the elevation start value.

property AntennaVolumeGraphics.elevation_stop: float#: Get the elevation stop value.

property AntennaVolumeGraphics.elevation_resolution: float#: Get the elevation resolution.

property AntennaVolumeGraphics.elevation_number_of_points: int#: Get the number of elevation points.

property AntennaVolumeGraphics.color_method: FigureOfMeritGraphics2DColorMethod#: Color method for volume levels (color ramp or explicit).

property AntennaVolumeGraphics.start_color: Color#: Get or set the color ramp start color.

property AntennaVolumeGraphics.stop_color: Color#: Get or set the color ramp stop color.

property AntennaVolumeGraphics.levels: AntennaVolumeLevelCollection#: Get the collection of volume levels.

property AntennaVolumeGraphics.relative_to_maximum: bool#: Get or set the contours value represents the gain value relative to the maximum.

property AntennaVolumeGraphics.coordinate_system: AntennaGraphicsCoordinateSystem#: Get or set the coordinate system for defining the resolution of the antenna graphics.

property AntennaVolumeGraphics.minimum_displayed_gain: float#: Get or set the minimum displayed gain value.

Method detail#

AntennaVolumeGraphics.set_resolution(self, azimuth_start: float, azimuth_stop: float, azimuth_resolution: float, elevation_start: float, elevation_stop: float, elevation_resolution: float) → None#

Set the azimuth/elevation ranges and resolution.

Parameters:

azimuth_start : float

azimuth_stop : float

azimuth_resolution : float

elevation_start : float

elevation_stop : float

elevation_resolution : float

Returns:

None

AntennaVolumeGraphics.set_number_of_points(self, azimuth_start: float, azimuth_stop: float, azimuth_num_points: int, elevation_start: float, elevation_stop: float, elevation_num_points: int) → None#

Set the azimuth/elevation ranges and number of points.