Antenna

class ansys.stk.core.stkobjects.Antenna

Bases: ISTKObject, ILifetimeInformation, IDisplayTime

Class defining the antenna object.

Overview

Methods

is_refraction_type_supported

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

Properties

chain_analysis_options	Get the antenna’s chain analysis options.
graphics	Get the 2D Graphics properties for the antenna.
graphics_3d	Get the 3D Graphics properties for the antenna.
laser_environment	Get the object laser environment settings.
model_component_linking	Get the link/embed controller for managing the antenna model component.
orientation	Get the antenna orientation.
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

Modify Antenna Graphics

# Antenna antenna: Antenna object
contours = antenna.graphics.contour_graphics
contours.set_contour_type(AntennaContourType.GAIN)
contours.show = True
for i in range(-30, 30, 5):
    contours.contour.levels.add(i)
antenna.graphics_3d.show_contours = True
antenna.graphics_3d.volume_graphics.show = True

Modify Antenna Orientation and Position

# Antenna antenna: Antenna object
antOrientation = antenna.orientation
antOrientation.assign_az_el(0, -90, AzElAboutBoresight.ROTATE)
antOrientation.position_offset.x = 0.0  # m
antOrientation.position_offset.y = 1  # m
antOrientation.position_offset.z = 0.25  # m

Modify Antenna Refraction

# Antenna antenna: Antenna object
antenna.use_refraction_in_access = True
antenna.refraction = SensorRefractionType.ITU_R_P834_4
refraction = antenna.refraction_model
refraction.ceiling = 5000  # m
refraction.atmosphere_altitude = 10000  # m
refraction.knee_bend_factor = 0.2

Modify Antenna Model Type

# Antenna antenna: Antenna object
antenna.model_component_linking.set_component("Dipole")
antennaModel = antenna.model_component_linking.component
antennaModel.design_frequency = 15  # GHz
antennaModel.length = 1.5  # m
antennaModel.length_to_wavelength_ratio = 45
antennaModel.efficiency = 85  # Percent

Create a New Antenna Object

# ISTKObject satellite: STK object
antenna = satellite.children.new(STKObjectType.ANTENNA, "MyAntenna")

Import detail

from ansys.stk.core.stkobjects import Antenna

Property detail

property Antenna.chain_analysis_options: ChainAnalysisOptions

Get the antenna’s chain analysis options.

property Antenna.graphics: AntennaGraphics

Get the 2D Graphics properties for the antenna.

property Antenna.graphics_3d: AntennaGraphics3D

Get the 3D Graphics properties for the antenna.

property Antenna.laser_environment: ObjectLaserEnvironment

Get the object laser environment settings.

property Antenna.model_component_linking: IComponentLinkEmbedControl

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

property Antenna.orientation: IOrientation

Get the antenna orientation.

property Antenna.refraction: SensorRefractionType

Refraction method, a member of the SensorRefractionType enumeration.

property Antenna.refraction_model: IRefractionModelBase

Get a refraction model.

property Antenna.refraction_supported_types: list

Return an array of valid choices.

property Antenna.rf_environment: ObjectRFEnvironment

Get the object RF environment settings.

property Antenna.use_refraction_in_access: bool

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

Method detail

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

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

Parameters:

model : SensorRefractionType

Returns:

bool