Receiver#

class ansys.stk.core.stkobjects.Receiver#

Bases: ISTKObject, ILifetimeInformation, IDisplayTime

Class defining the receiver object.

Overview#

Methods

`set_model`	Do not use this method, as it is deprecated. Use ModelComponentLinking on Receiver instead. Sets the current receiver model by name.
`is_refraction_type_supported`	Get a value indicating whether the specified type can be used.

Properties

`supported_models`	Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets an array of supported model names.
`model`	Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets the current receiver model.
`refraction`	Refraction method, a member of the SensorRefractionType enumeration.
`refraction_supported_types`	Return an array of valid choices.
`refraction_model`	Get a refraction model.
`use_refraction_in_access`	Flag controls whether refraction is applied when computing relative position in Access.
`graphics_3d`	Get the 3D Graphics properties for the receiver.
`graphics`	Get the 2D Graphics properties for the receiver.
`rf_environment`	Get the object RF environment settings.
`laser_environment`	Get the object laser environment settings.
`model_component_linking`	Get the link/embed controller for managing the receiver model component.

Examples#

Receiver additional Gain

# Receiver receiver: Receiver object
recModel = receiver.model
gain = recModel.pre_receive_gains_losses.add(5)  # dB
gain.identifier = "Example Gain"

Modify Receiver Filter Properties

# Receiver receiver: Receiver object
recModel = receiver.model
recModel.enable_filter = True
recModel.set_filter("Bessel")
recFilter = recModel.filter
recFilter.lower_bandwidth_limit = -20
recFilter.upper_bandwidth_limit = 20
recFilter.cut_off_frequency = 10

Modify Receiver Demodulator Properties

# Receiver receiver: Receiver object
recModel = receiver.model
recModel.select_demodulator_automatically = False
recModel.set_demodulator("16PSK")

Modify Receiver System Noise Temperature

# Receiver receiver: Receiver object
receiver.set_model("Complex Receiver Model")
recModel = receiver.model
recModel.system_noise_temperature.constant_noise_temperature = 280  # K

Modify Orientation of the Receiver Antenna

# Complex receivers Only
# Receiver receiver: Receiver object
receiver.set_model("Complex Receiver Model")
recModel = receiver.model
antennaControl = recModel.antenna_control
antOrientation = antennaControl.embedded_model_orientation
antOrientation.assign_az_el(45, 85, AzElAboutBoresight.ROTATE)
antOrientation.position_offset.x = 0.5  # m
antOrientation.position_offset.y = 0.75  # m
antOrientation.position_offset.z = 1  # m

Modify Receiver Polarization Properties

# Receiver receiver: Receiver object
recModel = receiver.model
recModel.enable_polarization = True
recModel.set_polarization_type(PolarizationType.LINEAR)
polarization = recModel.polarization
polarization.reference_axis = PolarizationReferenceAxis.Z
polarization.cross_polarization_leakage = -60  # dB

Modify Receiver Embedded Antenna

# Receiver receiver: Receiver object
receiver.set_model("Complex Receiver Model")
recModel = receiver.model
antennaControl = recModel.antenna_control
antennaControl.set_embedded_model("Hemispherical")
antennaControl.embedded_model.efficiency = 85  # Percent

Modify Receiver Model Type

# Receiver receiver: Receiver object
receiver.set_model("Complex Receiver Model")
recModel = receiver.model
recModel.track_frequency_automatically = False
recModel.frequency = 11.81

Create a New Receiver Object

# ISTKObject satellite: STK object
receiver = satellite.children.new(STKObjectType.RECEIVER, "MyReceiver")

Import detail#

from ansys.stk.core.stkobjects import Receiver

Property detail#

property Receiver.supported_models: list#: Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets an array of supported model names.

property Receiver.model: IReceiverModel#: Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets the current receiver model.

property Receiver.refraction: SensorRefractionType#: Refraction method, a member of the SensorRefractionType enumeration.

property Receiver.refraction_supported_types: list#: Return an array of valid choices.

property Receiver.refraction_model: IRefractionModelBase#: Get a refraction model.

property Receiver.use_refraction_in_access: bool#: Flag controls whether refraction is applied when computing relative position in Access.

property Receiver.graphics_3d: ReceiverGraphics3D#: Get the 3D Graphics properties for the receiver.

property Receiver.graphics: ReceiverGraphics#: Get the 2D Graphics properties for the receiver.

property Receiver.rf_environment: ObjectRFEnvironment#: Get the object RF environment settings.

property Receiver.laser_environment: ObjectLaserEnvironment#: Get the object laser environment settings.

property Receiver.model_component_linking: IComponentLinkEmbedControl#: Get the link/embed controller for managing the receiver model component.

Method detail#

Receiver.set_model(self, model_name: str) → None#

Do not use this method, as it is deprecated. Use ModelComponentLinking on Receiver instead. Sets the current receiver model by name.

Parameters:: model_name : str
Returns:: None

Receiver.is_refraction_type_supported(self, model: SensorRefractionType) → bool#

Get a value indicating whether the specified type can be used.

Parameters:: model : SensorRefractionType
Returns:: bool