Description

Provides access to the properties and methods defining an Antenna object.

Object Model

Public Methods

IsRefractionTypeSupported	Gets a value indicating whether the specified type can be used
SetModel	Sets the current antenna model by name.

Public Properties

Graphics	Get the 2D Graphics properties for the antenna.
Model	Gets the current antenna model.
Orientation	Gets the antenna orientation.
Refraction	Refraction method, a member of the AgESnRefractionType enumeration.
RefractionModel	Gets a refraction model
RefractionSupportedTypes	Returns an array of valid choices
SupportedModels	Gets an array of supported model names.
UseRefractionInAccess	Flag controls whether refraction is applied when computing relative position in Access
VO	Get the 3D Graphics properties for the antenna.

Example

Compute a link budget for a Transmtiter and Receiver pair, using complex models

[C#] Copy Code

IAgStkObject xmtrAsStkObject = geoTransmitter as IAgStkObject; 

IAgStkObject rcvrAsStkObject = facilityReceiver as IAgStkObject; 

 

//Enable the rain loss computation on the scenario RF environment 

scenarioRFEnv.PropagationChannel.EnableRainLoss = true; 

 

//Set the transmitter to the complex model 

geoTransmitter.SetModel("Complex Transmitter Model"); 

IAgTransmitterModelComplex complexTrans = geoTransmitter.Model as IAgTransmitterModelComplex; 

 

//Set the complex transmitter model's frequency to 3.2 GHz 

complexTrans.Frequency = 3.2; 

 

//Set the complex transmitter model's Power to 50 dBW 

complexTrans.Power = 50.0; 

 

//Set the complex transmitter's embedded antenna model to helix 

complexTrans.AntennaControl.SetEmbeddedModel("Helix"); 

 

//Set the beamwidth of the parablic antenna to 2 degrees 

IAgAntennaModelHelix helix = complexTrans.AntennaControl.EmbeddedModel as IAgAntennaModelHelix; 

helix.NumberOfTurns = 30.0; 

 

//Orient the complex transmitter embedded antenna's boresight to point directly at the receiver's location 

complexTrans.AntennaControl.EmbeddedModelOrientation.AssignAzEl(287.2, 83.4, AgEAzElAboutBoresight.eAzElAboutBoresightRotate); 

 

//Set the receiver to the complex model 

facilityReceiver.SetModel("Complex Receiver Model"); 

IAgReceiverModelComplex complexRcvr = facilityReceiver.Model as IAgReceiverModelComplex; 

 

//Configure the complex receiver to use the antenna object on the same parent facility, by linking 

complexRcvr.AntennaControl.ReferenceType = AgEAntennaControlRefType.eAntennaControlRefTypeLink; 

complexRcvr.AntennaControl.LinkedAntennaObject = "Antenna/FacilityDish"; 

 

//Enable rain loss computation on the receiver 

complexRcvr.UseRain = true; 

complexRcvr.RainOutagePercent = 0.001; 

 

//Enable the receiver system noise temperature computation. 

complexRcvr.SystemNoiseTemperature.ComputeType = AgENoiseTempComputeType.eNoiseTempComputeTypeCalculate; 

 

//Enable the antenna noise temperature computation 

complexRcvr.SystemNoiseTemperature.AntennaNoiseTemperature.ComputeType = AgENoiseTempComputeType.eNoiseTempComputeTypeCalculate; 

complexRcvr.SystemNoiseTemperature.AntennaNoiseTemperature.UseRain = true; 

 

//Orient the antenna object's boresight to point directly at the transmitter's location 

facilityDish.Orientation.AssignAzEl(202.6, 41.2, AgEAzElAboutBoresight.eAzElAboutBoresightRotate); 

 

//Set the antenna object's model to parabolic 

facilityDish.SetModel("Parabolic"); 

 

//Set the antenan object's design frequency to match the transmitter's 3.2 GHz 

facilityDish.Model.DesignFrequency = 3.2; 

 

//Set the antenna object's parabolic model diameter to 5 m. 

IAgAntennaModelParabolic parabolic = facilityDish.Model as IAgAntennaModelParabolic; 

parabolic.InputType = AgEAntennaModelInputType.eAntennaModelInputTypeDiameter; 

parabolic.Diameter = 5.0; 

 

//Create an access object for the access between the transmitter and recevier objects 

IAgStkAccess linkAccess = xmtrAsStkObject.GetAccessToObject(rcvrAsStkObject); 

 

//Compute access 

linkAccess.ComputeAccess(); 

 

// Get the access intervals 

IAgIntervalCollection accessIntervals = linkAccess.ComputedAccessIntervalTimes; 

 

// Extract the access intervals and the range information for each access interval 

Array dataPrvElements = new object[] { "Time", "Xmtr Gain", "Rcvr Gain", "Eb/No", "BER" }; 

 

IAgDataPrvTimeVar dp = linkAccess.DataProviders["Link Information"] as IAgDataPrvTimeVar; 

 

for (int index0 = 0; index0 < accessIntervals.Count; ++index0) 

{ 

    object startTime = null, stopTime = null; 

 

    accessIntervals.GetInterval(index0, out startTime, out stopTime); 

 

    IAgDrResult result = dp.ExecElements(startTime, stopTime, 60, ref dataPrvElements); 

 

    Array timeValues = result.DataSets[0].GetValues(); 

    Array xmtrGain = result.DataSets[1].GetValues(); 

    Array rcvrGain = result.DataSets[2].GetValues(); 

    Array ebno = result.DataSets[3].GetValues(); 

    Array ber = result.DataSets[4].GetValues(); 

 

    for (int index1 = 0; index1 < timeValues.GetLength(0); ++index1) 

    { 

        string time = (string)timeValues.GetValue(index1); 

        double xmtrGainVal = (double)xmtrGain.GetValue(index1); 

        double rcvrGainVal = (double)rcvrGain.GetValue(index1); 

        double ebnoVal = (double)ebno.GetValue(index1); 

        double berVal = (double)ber.GetValue(index1); 

        Console.WriteLine("{0}: Xmtr Gain = {1} Rcvr Gain = {2} Eb/No={3} BER={4}", time, xmtrGainVal, rcvrGainVal, ebnoVal, berVal); 

    } 

 

    Console.WriteLine(); 

}

Compute a link budget for a Transmtiter and Receiver pair, using complex models

[Visual Basic .NET] Copy Code

Dim xmtrAsStkObject As IAgStkObject = TryCast(geoTransmitter, IAgStkObject)
Dim rcvrAsStkObject As IAgStkObject = TryCast(facilityReceiver, IAgStkObject)

'Enable the rain loss computation on the scenario RF environment
 scenarioRFEnv.PropagationChannel.EnableRainLoss = True

'Set the transmitter to the complex model
 geoTransmitter.SetModel("Complex Transmitter Model")
Dim complexTrans As IAgTransmitterModelComplex = TryCast(geoTransmitter.Model, IAgTransmitterModelComplex)

'Set the complex transmitter model's frequency to 3.2 GHz
 complexTrans.Frequency = 3.2

'Set the complex transmitter model's Power to 50 dBW
 complexTrans.Power = 50

'Set the complex transmitter's embedded antenna model to helix
 complexTrans.AntennaControl.SetEmbeddedModel("Helix")

'Set the beamwidth of the parablic antenna to 2 degrees
Dim helix As IAgAntennaModelHelix = TryCast(complexTrans.AntennaControl.EmbeddedModel, IAgAntennaModelHelix)
 helix.NumberOfTurns = 30

'Orient the complex transmitter embedded antenna's boresight to point directly at the receiver's location
 complexTrans.AntennaControl.EmbeddedModelOrientation.AssignAzEl(287.2, 83.4, AgEAzElAboutBoresight.eAzElAboutBoresightRotate)

'Set the receiver to the complex model
 facilityReceiver.SetModel("Complex Receiver Model")
Dim complexRcvr As IAgReceiverModelComplex = TryCast(facilityReceiver.Model, IAgReceiverModelComplex)

'Configure the complex receiver to use the antenna object on the same parent facility, by linking
 complexRcvr.AntennaControl.ReferenceType = AgEAntennaControlRefType.eAntennaControlRefTypeLink
 complexRcvr.AntennaControl.LinkedAntennaObject = "Antenna/FacilityDish"

'Enable rain loss computation on the receiver
 complexRcvr.UseRain = True
 complexRcvr.RainOutagePercent = 0.001

'Enable the receiver system noise temperature computation.
 complexRcvr.SystemNoiseTemperature.ComputeType = AgENoiseTempComputeType.eNoiseTempComputeTypeCalculate

'Enable the antenna noise temperature computation
 complexRcvr.SystemNoiseTemperature.AntennaNoiseTemperature.ComputeType = AgENoiseTempComputeType.eNoiseTempComputeTypeCalculate
 complexRcvr.SystemNoiseTemperature.AntennaNoiseTemperature.UseRain = True

'Orient the antenna object's boresight to point directly at the transmitter's location
 facilityDish.Orientation.AssignAzEl(202.6, 41.2, AgEAzElAboutBoresight.eAzElAboutBoresightRotate)

'Set the antenna object's model to parabolic
 facilityDish.SetModel("Parabolic")

'Set the antenan object's design frequency to match the transmitter's 3.2 GHz
 facilityDish.Model.DesignFrequency = 3.2

'Set the antenna object's parabolic model diameter to 5 m.
Dim parabolic As IAgAntennaModelParabolic = TryCast(facilityDish.Model, IAgAntennaModelParabolic)
 parabolic.InputType = AgEAntennaModelInputType.eAntennaModelInputTypeDiameter
 parabolic.Diameter = 5

'Create an access object for the access between the transmitter and recevier objects
Dim linkAccess As IAgStkAccess = xmtrAsStkObject.GetAccessToObject(rcvrAsStkObject)

'Compute access
 linkAccess.ComputeAccess()

' Get the access intervals
Dim accessIntervals As IAgIntervalCollection = linkAccess.ComputedAccessIntervalTimes

' Extract the access intervals and the range information for each access interval
Dim dataPrvElements As Array = New Object() {"Time", "Xmtr Gain", "Rcvr Gain", "Eb/No", "BER"}

Dim dp As IAgDataPrvTimeVar = TryCast(linkAccess.DataProviders("Link Information"), IAgDataPrvTimeVar)

Dim index0 As Integer = 0
While index0 <>
     Dim startTime As Object = Nothing, stopTime As Object = Nothing

     accessIntervals.GetInterval(index0, startTime, stopTime)

     Dim result As IAgDrResult = dp.ExecElements(startTime, stopTime, 60, dataPrvElements)

     Dim timeValues As Array = result.DataSets(0).GetValues()
     Dim xmtrGain As Array = result.DataSets(1).GetValues()
     Dim rcvrGain As Array = result.DataSets(2).GetValues()
     Dim ebno As Array = result.DataSets(3).GetValues()
     Dim ber As Array = result.DataSets(4).GetValues()

     Dim index1 As Integer = 0
     While index1 <>
         Dim time As String = DirectCast(timeValues.GetValue(index1), String)
         Dim xmtrGainVal As Double = DirectCast(xmtrGain.GetValue(index1), Double)
         Dim rcvrGainVal As Double = DirectCast(rcvrGain.GetValue(index1), Double)
         Dim ebnoVal As Double = DirectCast(ebno.GetValue(index1), Double)
         Dim berVal As Double = DirectCast(ber.GetValue(index1), Double)
         Console.WriteLine("{0}: Xmtr Gain = {1} Rcvr Gain = {2} Eb/No={3} BER={4}", time, xmtrGainVal, rcvrGainVal, ebnoVal, berVal)
         System.Threading.Interlocked.Increment(index1)
     End While

     Console.WriteLine()
     System.Threading.Interlocked.Increment(index0)
End While

Create a New Antenna Object

[MATLAB] Copy Code

% IAgSTKObject satellite: STK object 
antenna = satellite.Children.New('eAntenna', 'MyAntenna');

Modify Antenna Model Type

[MATLAB] Copy Code

% IAgAntenna antenna: Antenna object 
antenna.SetModel('Dipole'); 
antennaModel = antenna.Model; 
antennaModel.DesignFrequency = 15; %GHz 
antennaModel.Length = 1.5; %m 
antennaModel.LengthToWavelengthRatio = 45; 
antennaModel.Efficiency = 85; %Percent

Modify Antenna Refraction

[MATLAB] Copy Code

% IAgAntenna antenna: Antenna object 
antenna.UseRefractionInAccess = true; 
antenna.Refraction = 'eITU_R_P834_4'; 
refraction = antenna.RefractionModel; 
refraction.Ceiling = 5000; %m 
refraction.AtmosAltitude = 10000; %m 
refraction.KneeBendFactor = 0.2;

Modify Antenna Orientation and Position

[MATLAB] Copy Code

% IAgAntenna antenna: Antenna object 
antOrientation = antenna.Orientation; 
antOrientation.AssignAzEl(0,-90,1) % 1 represents Rotate About Boresight 
antOrientation.PositionOffset.X = 0.0; %m 
antOrientation.PositionOffset.Y = 1; %m 
antOrientation.PositionOffset.Z = 0.25; %m

Modify Antenna Graphics

[MATLAB] Copy Code

% IAgAntenna antenna: Antenna object 
contours = antenna.Graphics.ContourGraphics; 
contours.SetContourType('eAntennaContourTypeGain'); 
contours.Show = true; 
for i = -30:5:30 
    contours.Contour.Levels.Add(i); 
end 
antenna.VO.ShowContours = true; 
antenna.VO.VolumeGraphics.Show = true; 
antenna.VO.VolumeGraphics.GainOffset = 15; %db 
antenna.VO.VolumeGraphics.GainScale = 0.005; %km

Create a New Antenna Object

[Python] Copy Code

# IAgSTKObject satellite: STK object 
antenna = satellite.Children.New(31, 'MyAntenna') # eAntenna

Modify Antenna Model Type

[Python] Copy Code

# IAgAntenna antenna: Antenna object 
antenna.SetModel('Dipole') 
antennaModel = antenna.Model 
antennaModel.DesignFrequency = 15 # GHz 
antennaModel.Length = 1.5 # m 
antennaModel.LengthToWavelengthRatio = 45 
antennaModel.Efficiency = 85 # Percent

Modify Antenna Refraction

[Python] Copy Code

# IAgAntenna antenna: Antenna object 
antenna.UseRefractionInAccess = True 
antenna.Refraction = 3 # eITU_R_P834_4 
refraction = antenna.RefractionModel 
refraction.Ceiling = 5000 # m 
refraction.AtmosAltitude = 10000 # m 
refraction.KneeBendFactor = 0.2

Modify Antenna Orientation and Position

[Python] Copy Code

# IAgAntenna antenna: Antenna object 
antOrientation = antenna.Orientation 
antOrientation.AssignAzEl(0,-90,1) # 1 represents Rotate About Boresight 
antOrientation.PositionOffset.X = 0.0 # m 
antOrientation.PositionOffset.Y = 1 # m 
antOrientation.PositionOffset.Z = 0.25 # m

Modify Antenna Graphics

[Python] Copy Code

# IAgAntenna antenna: Antenna object 
contours = antenna.Graphics.ContourGraphics 
contours.SetContourType(0) # eAntennaContourTypeGain 
contours.Show = True 
for i in range(-30,30,5): 
    contours.Contour.Levels.Add(i) 
antenna.VO.ShowContours = True 
antenna.VO.VolumeGraphics.Show = True

CoClasses that Implement IAgAntenna

Name
AgAntenna

AGI STK Objects 11	Send comments on this topic.
IAgAntenna Interface