Description | Example | Return message | Group

VO Volumes

Display antenna patterns in the 3D Graphics window

Syntax

VO <ObjectPath> Volumes {VolumeOption} [<Parameter>]

Description

The VO Volumes command enables you to control the 3D display of antenna patterns. The colors in the 3D display of antenna beams run the spectrum from red (highest gain) to violet (lowest gain).

The volume graphics are based on the respective antenna's design frequency for Antenna, Receiver, and Transmitter objects, and on the radar's frequency for Radar objects.

This command is valid only for Antenna, Monostatic Radar, Complex, GPS, Laser or Multibeam Transmitter and Complex, Laser or Multibeam Receiver.

Valid values for {VolumeOption} are:

{VolumeOption}Description
OnDisplay the shape and gain levels of antenna beams in the 3D Graphics window.
OffTurn off the display of antenna beams.
"Antenna Beam"Set 3D display options for antenna beams. The <Parameter> are described in the next table. Only one <Parameter> can be included on each command line.

Valid <Parameter> for the "Antenna Beam" {VolumeOption} are:

<Parameter>Description
WireFrame {On | Off}Display the shape of the antenna beam in the 3D Graphics window, using wireframe graphics, with colors indicating the gain level.
GainScale <GainValue>Increase or decrease the size of the displayed antenna beam relative to its gain. <GainValue> is a value between 0.001 and 1.0e7 m, entered in Connect distance units.
Pattern <NumberOfPhiPoints> <MinPhi> <MaxPhi> <NumberOfThetaPoints> <MinTheta> <MaxTheta> Control the antenna pattern resolution for contouring.

Valid values for Phi and Theta are -180.0 degrees to 180.0 degrees.

Valid values for number of points are 2 to 1000.

GainOffset <OffsetValue>Set the gain offset. <OffsetValue> is a value between -100.0 and 200.0 entered in Scenario Ratio units.
Frequency <FrequencyValue>

This parameter is deprecated. If included in the command, it will be ignored. See description above for information on frequency.

Displays the frequency of a receiver, transmitter or radar (in Hertz) in the 3D Graphics window. <FrequencyValue> is a value between 1.0 and 100e9 Hertz.
ColorMethod {MinToMax | ExplicitLevels}Specify how colors will be added.

If MinToMax is entered, use the MinToMax command to specify the colors.

If ExplicitLevels is entered, use the AddColorLevel and DeleteColorLevel commands to specify the individual color levels.

MinToMax {MinColor} {MaxColor}Specify minimum and maximum color values.

For valid {MinColor} and {MaxColor} options see Common Options.

AddColorLevel <GainValue> {Color}Explicitly define the mapping of gain values to colors for 3D antenna beams.

<GainValue> is unitless. For valid {Color} options see Common Options.

DeleteColorLevel {All | <GainValue>}Delete mapping between a gain value and a color.

Enter All to delete all custom color mappings and apply the default STK color mappings.

Enter <GainValue>, which is unitless, to delete the color mappings for that gain value.

MinDisplayedGain <GainValue>Set the minimum gain value. <GainValue> is a value between -100.0 and 200.0.
RelativeToMaximum {On | Off}Turn on or off the relative to maximum value.

Examples

To display contours for Transmitter1 in the 3D Graphics window:

VO */Missile/Missile1/Transmitter/Transmitter1 Volumes On

To display the shape of the antenna beam for Transmitter1 in the 3D Graphics window, using wireframe graphics:

VO */Missile/Missile1/Transmitter/Transmitter1 Volumes "Antenna Beam" WireFrame On
VO */Missile/Missile1/Transmitter/Transmitter1 Volumes "Antenna Beam" Pattern 40 0.0 180.0 20 0.0 50.0

To set minimum displayed gain, and minimum and maximum color levels for Antenna1:

VO */Satellite/GEO/Antenna/Antenna1 Volumes "Antenna Beam" MinDisplayedGain -10
VO */Satellite/GEO/Antenna/Antenna1 Volumes "Antenna Beam" ColorMethod MinToMax
VO */Satellite/GEO/Antenna/Antenna1 Volumes "Antenna Beam" MinToMax green red

Return message

Group membership

This command belongs to the following group(s):

Comm

Radar

VO

VO Objects

Version

11.4