Set the antenna properties of a receiver or transmitter (Deprecated Command)
Comm <CommObjectPath> Antenna [MultiBeam <BeamID>] {AntennaType} <Parameters>
Note: This command was deprecated in STK 9, it should no longer be used. This command has been replaced by the Receiver and Transmitter commands.
The Comm Connect commands were enhanced in STK 9 to make use of attributes and to simplify the format required to use these commands. For more information on using the new format see Transitioning to the New Transmitter Format and Transitioning to the New Receiver Format.
In STK 9 a new Antenna object was also introduced. The Antenna command allows you set properties for the Antenna object.
The Communications module features several analytical antenna models for your use. The Comm Antenna command allows you to set the model and associated parameters needed to use any of these models.
Warning: This command can only be applied to transmitters and receivers with a Model Type of Complex or MultiBeam. If you try to apply the command to a transmitter or receiver that is defined as anything other than Complex or MultiBeam, the command will fail.
To set antenna properties for a specific beam of a multibeam antenna, include the MultiBeam keyword immediately followed by the <BeamID> before you specify the antenna options to be set.
Note: <BeamID> is case-sensitive.
Available options for {AntennaType} and associated <Parameters> are:
| {AntennaType} | <Parameters> | Description |
|---|---|---|
| Gaussian | <Efficiency> <Value1> [{ComputeOption}] [<BackLobeGain>] | <Efficiency> should be between
0.001 and 1.0.
{ComputeOption} can be Size, BeamWidth or MaxGain. If {ComputeOption} is Size or {ComputeOption} is not entered then <Value1> is the dimension entered in small distance units, and should be between 0.001 and 1000.0 meters. If {ComputeOption} is BeamWidth then <Value1> is the beam width entered in degrees, and should be between 0.001 and 90.0. If {ComputeOption} is MaxGain then <Value1> is the gain entered in dB, and should be between 0.0 and 1000.0. The user can also optionally enter a back lobe gain value, between -1000.0 and 1000.0 dB. If not entered then the default -30 dB is used. |
| Parabolic | ||
| SquareHorn | ||
| IntelSat | "<FilePath>" | Enter the full path and file name for the antenna pattern file. |
| External | ||
| Dipole | <Efficiency> <Length> | Where <Efficiency> is between 0.0 and 1.0; and <Length> is entered in Connect distance units, and should be between 0.001 and 1000000.0 meters. |
| Helix | <Efficiency> <Diameter> <TurnSpace> <NumTurns> [<BackLobeGain>] | <Efficiency> is between 0.0 and 1.0. <Diameter> is entered in SmallDistance units, and should be between 0.001 and 1000000.0 meters. <TurnSpace> is entered in Connect distance units, and should be between 0.001 and 1000.0 meters. <NumTurns> is between 1.0 and 1000. |
| ITU | {ITUType} <ITUParameters> | Valid values for {ITUType} and <ITUParameters> are described int he table below. |
| GIMROC | "<FilePath>" | Enter the full path and file name for the antenna pattern file. |
| Aperture | {ApertureType} <ApertureParameters> | Valid values for {ApertureType} and <ApertureParameters> are described int he table below. |
If {AntennaType} is ITU, {ITUType} and associated <ITUParameters> can be:
Note: Valid values for {UsePolAdvantage}, {NetworkCoordinatedPriorTo1993}, {UseAppendix8MainLobeModel} and {UseHalfBeamwidth} are Yes and No.
| {ITUType} | <ITUParameters> |
|---|---|
| B01213 | <Dimension> <MaxGain> <Efficiency> |
| B01213Pol | <Dimension> <MaxGain> <Efficiency> |
| F1245 | <Dimension> <MaxGain>
<Efficiency> [{UsePolAdvantage}]
The {UsePolAdvantage} value, if entered, will be ignored if the antenna's (Dimension/Wavelength) is greater than 100. |
| S465 | <Dimension> <MaxGain> <Efficiency> [<SideLobeMaskLevel> {NetworkCoordinatedPriorTo1993} {UseAppendix8MainLobeModel}] |
| S580 | <Dimension> <Efficiency> [<MaxGain> <SideLobeMaskLevel> {UseAppendix8MainLobeModel}] |
| S672 | <MajorDimension> <MaxGain>
<SideLobe> <Efficiency> [{UseHalfBeamwidth}
[<HalfBeamwidth>] <FarOutSideLobeLevel>
{UseAppendix8MainLobeModel} [<MinorDimension>]]
If {UseHalfBeamwidth} is set to No, then <HalfBeamwidth> must be omitted. If <MinorDimension> is supplied the antenna will be treated as a rectangular aperture. Otherwise, the antenna will be treated as a circular aperture. |
| S1528R12 | <Dimension> <MaxGain>
<SideLobe> <Efficiency> [{UseHalfBeamwidth}
[<HalfBeamwidth>] <FarOutSideLobeLevel>
{UseAppendix8MainLobeModel} [<MinorDimension>]]
If {UseHalfBeamwidth} is set to No, then <HalfBeamwidth> must be omitted. If <MinorDimension> is supplied the antenna will be treated as a rectangular aperture. Otherwise, the antenna will be treated as a circular aperture. |
| S731 | <Dimension> <Efficiency> [<MaxGain> <SideLobeMaskLevel> {UseAppendix8MainLobeModel}] |
| S1528R13 | <Dimension> <MaxGain>
<Efficiency> <FarOutSideLobeLevel>
<SideLobeMaskCrossPoint> {UseAppendix8MainLobeModel}
[<HalfBeamwidth>]
If the user does not specify a <HalfBeamwidth> value, it will be given a default value. |
<Dimension>, <MajorDimension> and <MinorDimension> are entered in Connect Small Distance units, and should be between 0.001 and 1000.0
<HalfBeamwidth> is entered in degrees and should be between 0.001 and 360.0
<MaxGain> is entered in dB and should be between 0.0 and 1000.0
<Efficiency> should be between 0.0 and 1.0
<SideLobeMaskLevel> is entered in dB and should be between 0.0 and 1000.0
<SideLobe> and <SideLobeMaskCrossPoint> are entered in dB and should be between -100.0 and 0.0
<FarOutSideLobeLevel> is entered in dB and should be between -1000.0 and 1000.0
If {AntennaType} is <Aperture>, {ApertureType} and associated <ApertureParameters> can be:
| {ApertureType} | <ApertureParameters> |
|---|---|
| Cosine | {Dimension | BeamWidth} <XValue> <YValue> <MainLobeGain> <Efficiency> [<BackLobeGain>] |
| CosSquare | {Dimension | BeamWidth} <XValue> <YValue> <MainLobeGain> <Efficiency> [<BackLobeGain>] |
| CosPedestal | {Dimension | BeamWidth} <XValue> <YValue> <MainLobeGain> <EdgePedestal> <Efficiency> [<BackLobeGain>] |
| CosSqrPedestal | {Dimension | BeamWidth} <XValue> <YValue> <MainLobeGain> <EdgePedestal> <Efficiency> [<BackLobeGain>] |
| SincPowerN | {Dimension | BeamWidth} <XValue> <YValue> <MainLobeGain> <Power> <Efficiency> [<BackLobeGain>] |
| SincPowerX | {Dimension | BeamWidth} <XValue> <YValue> <MainLobeGain> <Power> <Efficiency> [<BackLobeGain>] |
| UniformRectangular | {Dimension | BeamWidth} <XValue> <YValue> <MainLobeGain> <Efficiency> [<BackLobeGain>] |
| UniformCircular | {Dimension | BeamWidth} <XValue> <MainLobeGain> <EdgePedestal> <Power> <Efficiency> [<BackLobeGain>] |
| CircularBesselEnvelope | {Dimension | BeamWidth} <XValue> <MainLobeGain> <EdgePedestal> <Power> <Efficiency> [<BackLobeGain>] |
If Dimension is entered then <XValue> and <YValue> are entered in Connect distance units, and should be between 0.01 and 1000.0 meters.
If BeamWidth is entered then <XValue> and <YValue> are entered in degrees. <XValue> should be between 0.001 and 90.0. <YValue> should be between 0.0 and 90.0.
Note: To define a Circular Aperture set <YValue> to 0.0
<MaxLobeGain> is entered in dB and should be between 0.0 and 1000.0
<EdgePedestal> is entered in dB and should be between -300.0 and 0.0
<Efficiency> should be between 0.0 and 1.0
<Power> for SincPowerN and SincPowerX should be between 1.0 and 10.0
<Power> for UniformCircular and CircularBesselEnvelope should be between 0.0 and 3.0.
For SincPowerN, UniformCircular and CircularBesselEnvelope apertures the <Power> value entered will be rounded down to the nearest integer.
The user can optionally enter a <BackLobeGain> value. This value is entered in dB and should be between -1000.0 and 1000.0. If not entered then the default -30 dB is used.
To set the antenna type of the GndRcvr receiver to parabolic with an efficiency of .6 and a dimension of 1.5 m:
Comm */Facility/Customer/Receiver/GndRcvr Antenna Parabolic 0.6 1.5
To define the GndRcvr receiver as an ITU S731 antenna type with an efficiency of .5 and a dimension of 1.5:
Comm */Facility/Customer/Receiver/GndRcvr Antenna ITU S731 1.5 .5
To define beam 004 in the multibeam receiver to be a GIMROC antenna using the GIMROC.gxt file:
Comm */Satellite/GEO/Receiver/Uplink Antenna Multibeam Beam004 GIMROC "C:\stk\GIMROC\GIMROC.gxt"
To define a UniformCircular aperture antenna for Transmitter1:
Comm */Satellite/Satellite1/Transmitter/Transmitter1 Antenna Aperture UniformCircular Dimension 12 30 -100 2.45 .6 -15
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
9.0
STK Programming Interface 11.0.1