AntennaVolumeGraphics ===================== .. py:class:: ansys.stk.core.stkobjects.AntennaVolumeGraphics Class defining 3D Volume Graphics properties of a Antenna. .. py:currentmodule:: AntennaVolumeGraphics Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.set_resolution` - Set the azimuth/elevation ranges and resolution. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.set_number_of_points` - Set the azimuth/elevation ranges and number of points. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.show` - Opt whether to display volume graphics for the antenna. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.wireframe` - Enable the ability to view the volume as a wireframe. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_offset` - Do not use this property, as it is deprecated. Use the MinimumDisplayedGain property instead. Gets or sets the gain offset value. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_scale` - Get or set the gain scale value. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_start` - Get the azimuth start value. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_stop` - Get the azimuth stop value. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_resolution` - Get the azimuth resolution. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_number_of_points` - Get the number of azimuth points. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_start` - Get the elevation start value. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_stop` - Get the elevation stop value. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_resolution` - Get the elevation resolution. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_number_of_points` - Get the number of elevation points. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.color_method` - Color method for volume levels (color ramp or explicit). * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.start_color` - Get or set the color ramp start color. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.stop_color` - Get or set the color ramp stop color. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.levels` - Get the collection of volume levels. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.relative_to_maximum` - Get or set the contours value represents the gain value relative to the maximum. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.coordinate_system` - Get or set the coordinate system for defining the resolution of the antenna graphics. * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.minimum_displayed_gain` - Get or set the minimum displayed gain value. Import detail ------------- .. code-block:: python from ansys.stk.core.stkobjects import AntennaVolumeGraphics Property detail --------------- .. py:property:: show :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.show :type: bool Opt whether to display volume graphics for the antenna. .. py:property:: wireframe :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.wireframe :type: bool Enable the ability to view the volume as a wireframe. .. py:property:: gain_offset :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_offset :type: float Do not use this property, as it is deprecated. Use the MinimumDisplayedGain property instead. Gets or sets the gain offset value. .. py:property:: gain_scale :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_scale :type: float Get or set the gain scale value. .. py:property:: azimuth_start :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_start :type: float Get the azimuth start value. .. py:property:: azimuth_stop :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_stop :type: float Get the azimuth stop value. .. py:property:: azimuth_resolution :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_resolution :type: float Get the azimuth resolution. .. py:property:: azimuth_number_of_points :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.azimuth_number_of_points :type: int Get the number of azimuth points. .. py:property:: elevation_start :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_start :type: float Get the elevation start value. .. py:property:: elevation_stop :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_stop :type: float Get the elevation stop value. .. py:property:: elevation_resolution :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_resolution :type: float Get the elevation resolution. .. py:property:: elevation_number_of_points :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_number_of_points :type: int Get the number of elevation points. .. py:property:: color_method :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.color_method :type: FigureOfMeritGraphics2DColorMethod Color method for volume levels (color ramp or explicit). .. py:property:: start_color :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.start_color :type: Color Get or set the color ramp start color. .. py:property:: stop_color :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.stop_color :type: Color Get or set the color ramp stop color. .. py:property:: levels :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.levels :type: AntennaVolumeLevelCollection Get the collection of volume levels. .. py:property:: relative_to_maximum :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.relative_to_maximum :type: bool Get or set the contours value represents the gain value relative to the maximum. .. py:property:: coordinate_system :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.coordinate_system :type: AntennaGraphicsCoordinateSystem Get or set the coordinate system for defining the resolution of the antenna graphics. .. py:property:: minimum_displayed_gain :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.minimum_displayed_gain :type: float Get or set the minimum displayed gain value. Method detail ------------- .. py:method:: set_resolution(self, azimuth_start: float, azimuth_stop: float, azimuth_resolution: float, elevation_start: float, elevation_stop: float, elevation_resolution: float) -> None :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.set_resolution Set the azimuth/elevation ranges and resolution. :Parameters: **azimuth_start** : :obj:`~float` **azimuth_stop** : :obj:`~float` **azimuth_resolution** : :obj:`~float` **elevation_start** : :obj:`~float` **elevation_stop** : :obj:`~float` **elevation_resolution** : :obj:`~float` :Returns: :obj:`~None` .. py:method:: 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 :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.set_number_of_points Set the azimuth/elevation ranges and number of points. :Parameters: **azimuth_start** : :obj:`~float` **azimuth_stop** : :obj:`~float` **azimuth_num_points** : :obj:`~int` **elevation_start** : :obj:`~float` **elevation_stop** : :obj:`~float` **elevation_num_points** : :obj:`~int` :Returns: :obj:`~None`