Transmitter#

class ansys.stk.core.stkobjects.Transmitter#

Bases: ISTKObject, ILifetimeInformation, IDisplayTime

Class defining the transmitter object.

Overview#

Methods

`set_model`	Do not use this method, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Sets the current transmitter 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 Transmitter instead. Gets an array of supported model names.
`model`	Do not use this property, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Gets the current transmitter 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 transmitter.
`graphics`	Get the 2D Graphics properties for the transmitter.
`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 transmitter model component.

Examples#

Transmitter additional Gain

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

Modify a Transmitter Filter

# Transmitter transmitter: Transmitter object
txModel = transmitter.model
txModel.enable_filter = True
txModel.set_filter("Butterworth")
recFilter = txModel.filter
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
txModel.set_modulator("BPSK")
txModel.modulator.scale_bandwidth_automatically = True

Modify a Transmitter’s Orientation and Position

# Transmitter transmitter: Transmitter object
transmitter.set_model("Complex Transmitter Model")
txModel = transmitter.model
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.set_model("Complex Transmitter Model")
txModel = transmitter.model
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.set_model("Complex Transmitter Model")
txModel = transmitter.model
antennaControl = txModel.antenna_control
antennaControl.set_embedded_model("Isotropic")
antennaControl.embedded_model.efficiency = 85  # Percent

Modify a Transmitter’s Model Type

# Transmitter transmitter: Transmitter object
transmitter.set_model("Complex Transmitter Model")
txModel = transmitter.model
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.supported_models: list#: Do not use this property, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Gets an array of supported model names.

property Transmitter.model: ITransmitterModel#: Do not use this property, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Gets the current transmitter model.

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

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

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

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

property Transmitter.graphics_3d: TransmitterGraphics3D#: Get the 3D Graphics properties for the transmitter.

property Transmitter.graphics: TransmitterGraphics#: Get the 2D Graphics properties for the transmitter.

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

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.

Method detail#

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

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

Parameters:: model_name : str
Returns:: None

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