STK ObjectsSend comments on this topic.
IAgReceiver Interface

Description

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

Public Methods

Public Method IsRefractionTypeSupportedGets a value indicating whether the specified type can be used.

Public Properties

Public Property ChainAnalysisOptionsGet the receiver's chain analysis options.
Public Property GraphicsGet the 2D Graphics properties for the receiver.
Public Property LaserEnvironmentGets the object laser environment settings.
Public Property ModelComponentLinkingGets the link/embed controller for managing the receiver model component.
Public Property RefractionRefraction method, a member of the AgESnRefractionType enumeration.
Public Property RefractionModelGets a refraction model.
Public Property RefractionSupportedTypesReturns an array of valid choices.
Public Property RFEnvironmentGets the object RF environment settings.
Public Property UseRefractionInAccessFlag controls whether refraction is applied when computing relative position in Access.
Public Property VOGet the 3D Graphics properties for the receiver.

Interfaces

CoClasses that Implement IAgReceiver

Example

Compute a link budget for a Transmtiter and Receiver pair, using simple models
[C#]
IAgStkObject xmtrAsStkObject = geoTransmitter as IAgStkObject;
IAgStkObject rcvrAsStkObject = facilityReceiver as IAgStkObject;

//Set the transmitter to the simple model
geoTransmitter.ModelComponentLinking.SetComponent("Simple Transmitter Model");
IAgTransmitterModelSimple simpleTrans = geoTransmitter.ModelComponentLinking.Component as IAgTransmitterModelSimple;

//Set the simple transmitter model's frequency to 3.2 GHz
simpleTrans.Frequency = 3.2;

//Set the simple transmitter model's EIRP to 60 dBW
simpleTrans.Eirp = 60.0;

//Set the receiver to the simple model
facilityReceiver.ModelComponentLinking.SetComponent("Simple Receiver Model");
IAgReceiverModelSimple simpleRcvr = facilityReceiver.ModelComponentLinking.Component as IAgReceiverModelSimple;

//Set the simple receiver model's G/T to 60 dB/K
simpleRcvr.GOverT = 60.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", "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 ebno = result.DataSets[1].GetValues();
    Array ber = result.DataSets[2].GetValues();

    for (int index1 = 0; index1 < timeValues.GetLength(0); ++index1)
    {
        string time = (string)timeValues.GetValue(index1);
        double ebnoVal = (double)ebno.GetValue(index1);
        double berVal = (double)ber.GetValue(index1);
        Console.WriteLine("{0}: Eb/No={1} BER={2}", time, ebnoVal, berVal);
    }

    Console.WriteLine();
}
Compute a link budget for a Transmtiter and Receiver pair, using complex models
[C#]
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.ModelComponentLinking.SetComponent("Complex Transmitter Model");
IAgTransmitterModelComplex complexTrans = geoTransmitter.ModelComponentLinking.Component 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.EmbeddedModelComponentLinking.SetComponent("Helix");

//Set the beamwidth of the parablic antenna to 2 degrees
IAgAntennaModelHelix helix = complexTrans.AntennaControl.EmbeddedModelComponentLinking.Component 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.ModelComponentLinking.SetComponent("Complex Receiver Model");
IAgReceiverModelComplex complexRcvr = facilityReceiver.ModelComponentLinking.Component 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.ModelComponentLinking.SetComponent("Parabolic");

//Set the antenan object's design frequency to match the transmitter's 3.2 GHz
((IAgAntennaModel)facilityDish.ModelComponentLinking.Component).DesignFrequency = 3.2;

//Set the antenna object's parabolic model diameter to 5 m.
IAgAntennaModelParabolic parabolic = facilityDish.ModelComponentLinking.Component 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 simple models
[Visual Basic .NET]
Dim xmtrAsStkObject As IAgStkObject = TryCast(geoTransmitter, IAgStkObject)
Dim rcvrAsStkObject As IAgStkObject = TryCast(facilityReceiver, IAgStkObject)

'Set the transmitter to the simple model
geoTransmitter.ModelComponentLinking.SetComponent("Simple Transmitter Model")
Dim simpleTrans As IAgTransmitterModelSimple = TryCast(geoTransmitter.ModelComponentLinking.Component, IAgTransmitterModelSimple)

'Set the simple transmitter model's frequency to 3.2 GHz
simpleTrans.Frequency = 3.2

'Set the simple transmitter model's EIRP to 60 dBW
simpleTrans.Eirp = 60

'Set the receiver to the simple model
facilityReceiver.ModelComponentLinking.SetComponent("Simple Receiver Model")
Dim simpleRcvr As IAgReceiverModelSimple = TryCast(facilityReceiver.ModelComponentLinking.Component, IAgReceiverModelSimple)

'Set the simple receiver model's G/T to 60 dB/K
simpleRcvr.GOverT = 60

'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", "Eb/No", "BER"}

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

Dim index0 As Integer = 0
While index0 < accessIntervals.Count
	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 ebno As Array = result.DataSets(1).GetValues()
	Dim ber As Array = result.DataSets(2).GetValues()

	Dim index1 As Integer = 0
	While index1 < timeValues.GetLength(0)
		Dim time As String = DirectCast(timeValues.GetValue(index1), String)
		Dim ebnoVal As Double = DirectCast(ebno.GetValue(index1), Double)
		Dim berVal As Double = DirectCast(ber.GetValue(index1), Double)
		Console.WriteLine("{0}: Eb/No={1} BER={2}", time, ebnoVal, berVal)
		System.Threading.Interlocked.Increment(index1)
	End While

	Console.WriteLine()
	System.Threading.Interlocked.Increment(index0)
End While
Compute a link budget for a Transmtiter and Receiver pair, using complex models
[Visual Basic .NET]
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.ModelComponentLinking.SetComponent("Complex Transmitter Model")
Dim complexTrans As IAgTransmitterModelComplex = TryCast(geoTransmitter.ModelComponentLinking.Component, 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.EmbeddedModelComponentLinking.SetComponent("Helix")

'Set the beamwidth of the parablic antenna to 2 degrees
Dim helix As IAgAntennaModelHelix = TryCast(complexTrans.AntennaControl.EmbeddedModelComponentLinking.Component, 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.ModelComponentLinking.SetComponent("Complex Receiver Model")
Dim complexRcvr As IAgReceiverModelComplex = TryCast(facilityReceiver.ModelComponentLinking.Component, 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.ModelComponentLinking.SetComponent("Parabolic")

'Set the antenan object's design frequency to match the transmitter's 3.2 GHz
DirectCast(facilityDish.ModelComponentLinking.Component, IAgAntennaModel).DesignFrequency = 3.2

'Set the antenna object's parabolic model diameter to 5 m.
Dim parabolic As IAgAntennaModelParabolic = TryCast(facilityDish.ModelComponentLinking.Component, 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 < accessIntervals.Count
	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 < timeValues.GetLength(0)
		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 Receiver Object
[Python - STK API]
# IAgStkObject satellite: STK object
receiver = satellite.Children.New(AgESTKObjectType.eReceiver, 'MyReceiver')
Modify Receiver Model Type
[Python - STK API]
# IAgReceiver receiver: Receiver object
receiver.SetModel('Complex Receiver Model')
recModel = receiver.Model
recModel.AutoTrackFrequency = False
recModel.Frequency = 11.81
Modify Receiver Embedded Antenna
[Python - STK API]
# IAgReceiver receiver: Receiver object
receiver.SetModel("Complex Receiver Model")
recModel = receiver.Model
antennaControl = recModel.AntennaControl
antennaControl.SetEmbeddedModel('Hemispherical')
antennaControl.EmbeddedModel.Efficiency = 85  # Percent
Modify Receiver Polarization Properties
[Python - STK API]
# IAgReceiver receiver: Receiver object
recModel = receiver.Model
recModel.EnablePolarization = True
recModel.SetPolarizationType(AgEPolarizationType.ePolarizationTypeLinear)
polarization = recModel.Polarization
polarization.ReferenceAxis = AgEPolarizationReferenceAxis.ePolarizationReferenceAxisZ
polarization.CrossPolLeakage = -60  # dB
Modify Orientation of the Receiver Antenna
[Python - STK API]
# Complex receivers Only
# IAgReceiver receiver: Receiver object
receiver.SetModel("Complex Receiver Model")
recModel = receiver.Model
antennaControl = recModel.AntennaControl
antOrientation = antennaControl.EmbeddedModelOrientation
antOrientation.AssignAzEl(45, 85, AgEAzElAboutBoresight.eAzElAboutBoresightRotate)
antOrientation.PositionOffset.X = 0.5  # m
antOrientation.PositionOffset.Y = 0.75  # m
antOrientation.PositionOffset.Z = 1  # m
Modify Receiver System Noise Temperature
[Python - STK API]
# IAgReceiver receiver: Receiver object
receiver.SetModel("Complex Receiver Model")
recModel = receiver.Model
recModel.SystemNoiseTemperature.ConstantNoiseTemperature = 280  # K
Modify Receiver Demodulator Properties
[Python - STK API]
# IAgReceiver receiver: Receiver object
recModel = receiver.Model
recModel.AutoSelectDemodulator = False
recModel.SetDemodulator('16PSK')
Modify Receiver Filter Properties
[Python - STK API]
# IAgReceiver receiver: Receiver object
recModel = receiver.Model
recModel.EnableFilter = True
recModel.SetFilter('Bessel')
recFilter = recModel.Filter
recFilter.LowerBandwidthLimit = -20
recFilter.UpperBandwidthLimit = 20
recFilter.CutoffFrequency = 10
Receiver additional Gain
[Python - STK API]
# IAgReceiver receiver: Receiver object
recModel = receiver.Model
gain = recModel.PreReceiveGainsLosses.Add(5)  # dB
gain.Identifier = 'Example Gain'
Create a New Receiver Object
[MATLAB]
% IAgStkObject satellite: STK object
receiver = satellite.Children.New('eReceiver', 'MyReceiver');
Modify Receiver Model Type
[MATLAB]
% IAgReceiver receiver: Receiver object
receiver.SetModel('Complex Receiver Model');
recModel = receiver.Model;
recModel.AutoTrackFrequency = false;
recModel.Frequency = 11.81;
Modify Receiver Embedded Antenna
[MATLAB]
% IAgReceiver receiver: Receiver object
receiver.SetModel('Complex Receiver Model');
recModel = receiver.Model;
antennaControl = recModel.AntennaControl;
antennaControl.SetEmbeddedModel('Hemispherical');
antennaControl.EmbeddedModel.Efficiency = 85; % Percent
Modify Receiver Polarization Properties
[MATLAB]
% IAgReceiver receiver: Receiver object
recModel = receiver.Model;
recModel.EnablePolarization = true;
recModel.SetPolarizationType('ePolarizationTypeLinear');
polarization = recModel.Polarization;
polarization.ReferenceAxis = 'ePolarizationReferenceAxisZ';
polarization.CrossPolLeakage = -60; % dB
Modify Orientation of the Receiver Antenna
[MATLAB]
% IAgReceiver receiver: Receiver object
receiver.SetModel('Complex Receiver Model');
recModel = receiver.Model;
antennaControl = recModel.AntennaControl;
antOrientation = antennaControl.EmbeddedModelOrientation;
antOrientation.AssignAzEl(45, 85, 1); % 1 represents Rotate About Boresight
antOrientation.PositionOffset.X = 0.5; % m
antOrientation.PositionOffset.Y = 0.75; % m
antOrientation.PositionOffset.Z = 1; % m
Modify Receiver System Noise Temperature
[MATLAB]
% IAgReceiver receiver: Receiver object
receiver.SetModel('Complex Receiver Model');
recModel = receiver.Model;
recModel.SystemNoiseTemperature.ConstantNoiseTemperature = 280; % K
Modify Receiver Demodulator Properties
[MATLAB]
% IAgReceiver receiver: Receiver object
recModel = receiver.Model;
recModel.AutoSelectDemodulator = false;
recModel.SetDemodulator('16PSK');
Modify Receiver Filter Properties
[MATLAB]
% IAgReceiver receiver: Receiver object
recModel = receiver.Model;
recModel.EnableFilter = true;
recModel.SetFilter('Bessel');
recFilter = recModel.Filter;
recFilter.LowerBandwidthLimit = -20;
recFilter.UpperBandwidthLimit = 20;
recFilter.CutoffFrequency = 10;
Receiver additional Gain
[MATLAB]
% IAgReceiver receiver: Receiver object
recModel = receiver.Model;
gain = recModel.PreReceiveGainsLosses.Add(5); % dB
gain.Identifier = 'Example Gain';
© 2025 Analytical Graphics, Inc. All Rights Reserved.