Transmitter

class ansys.stk.core.stkobjects.Transmitter

Bases: ISTKObject, ILifetimeInformation, IDisplayTime

Class defining the transmitter object.

Overview

Methods

is_refraction_type_supported

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

Properties

chain_analysis_options	Get the transmitter’s chain analysis options.
graphics	Get the 2D Graphics properties for the transmitter.
graphics_3d	Get the 3D Graphics properties for the transmitter.
laser_environment	Get the object laser environment settings.
model_component_linking	Get the link/embed controller for managing the transmitter model component.
refraction	Refraction method, a member of the SensorRefractionType enumeration.
refraction_model	Get a refraction model.
refraction_supported_types	Return an array of valid choices.
rf_environment	Get the object RF environment settings.
use_refraction_in_access	Flag controls whether refraction is applied when computing relative position in Access.

Examples

Transmitter additional Gain

# Transmitter transmitter: Transmitter object
txModel = transmitter.model_component_linking.component
gain = txModel.post_transmit_gains_losses.add(-5)  # dB
gain.identifier = "Example Loss"

Modify a Transmitter Filter

# Transmitter transmitter: Transmitter object
txModel = transmitter.model_component_linking.component
txModel.enable_filter = True
txModel.filter_component_linking.set_component("Butterworth")
recFilter = txModel.filter_component_linking.component
recFilter.lower_bandwidth_limit = -20
recFilter.upper_bandwidth_limit = 20
recFilter.cut_off_frequency = 10

Modify a Transmitter’s Modulator Properties

# Transmitter transmitter: Transmitter object
txModel = transmitter.model_component_linking.component
txModel.set_modulator("BPSK")
txModel.modulator.scale_bandwidth_automatically = True

Modify a Transmitter’s Orientation and Position

# Transmitter transmitter: Transmitter object
transmitter.model_component_linking.set_component("Complex Transmitter Model")
txModel = transmitter.model_component_linking.component
antennaControl = txModel.antenna_control
antOrientation = antennaControl.embedded_model_orientation
antOrientation.assign_az_el(0, 90, 1)  # 1 represents Rotate About Boresight
antOrientation.position_offset.x = 0.0  # m
antOrientation.position_offset.y = 1  # m
antOrientation.position_offset.z = 0.25  # m

Modify a Transmitter’s Polarization Properties

# Transmitter transmitter: Transmitter object
transmitter.model_component_linking.set_component("Complex Transmitter Model")
txModel = transmitter.model_component_linking.component
txModel.enable_polarization = True
txModel.set_polarization_type(PolarizationType.LINEAR)
polarization = txModel.polarization
polarization.reference_axis = PolarizationReferenceAxis.Y
polarization.tilt_angle = 15  # deg

Modify a Transmitter’s Embedded Antenna

# Transmitter transmitter: Transmitter object
transmitter.model_component_linking.set_component("Complex Transmitter Model")
txModel = transmitter.model_component_linking.component
antennaControl = txModel.antenna_control
antennaControl.embedded_model_component_linking.set_component("Isotropic")
antennaControl.embedded_model_component_linking.component.efficiency = 85  # Percent

Modify a Transmitter’s Model Type

# Transmitter transmitter: Transmitter object
transmitter.model_component_linking.set_component("Complex Transmitter Model")
txModel = transmitter.model_component_linking.component
txModel.frequency = 14  # GHz
txModel.power = 25  # dBW
txModel.data_rate = 15  # Mb/sec

Create a New Transmitter Object

# ISTKObject satellite: STK object
transmitter = satellite.children.new(STKObjectType.TRANSMITTER, "MyTransmitter")

Import detail

from ansys.stk.core.stkobjects import Transmitter

Property detail

property Transmitter.chain_analysis_options: ChainAnalysisOptions

Get the transmitter’s chain analysis options.

property Transmitter.graphics: TransmitterGraphics

Get the 2D Graphics properties for the transmitter.

property Transmitter.graphics_3d: TransmitterGraphics3D

Get the 3D Graphics properties for the transmitter.

property Transmitter.laser_environment: ObjectLaserEnvironment

Get the object laser environment settings.

property Transmitter.model_component_linking: IComponentLinkEmbedControl

Get the link/embed controller for managing the transmitter model component.

property Transmitter.refraction: SensorRefractionType

Refraction method, a member of the SensorRefractionType enumeration.

property Transmitter.refraction_model: IRefractionModelBase

Get a refraction model.

property Transmitter.refraction_supported_types: list

Return an array of valid choices.

property Transmitter.rf_environment: ObjectRFEnvironment

Get the object RF environment settings.

property Transmitter.use_refraction_in_access: bool

Flag controls whether refraction is applied when computing relative position in Access.

Method detail

Transmitter.is_refraction_type_supported(self, model: SensorRefractionType) → bool

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

Parameters:

model : SensorRefractionType

Returns:

bool