Facility

class ansys.stk.core.stkobjects.Facility

Bases: ISTKObject, ILifetimeInformation, IDisplayTime

Class defining the Facility object.

Overview

Methods

set_az_el_mask	Set an az-el mask. A member of the AzElMaskType enumeration.
reset_az_el_mask	Reset the az-el mask.
get_az_el_mask	Get the az-el mask. A member of the AzElMaskType enumeration.
get_az_el_mask_data	Get az-el mask data.

Properties

use_local_time_offset	Opt whether to use a local time offset from GMT.
local_time_offset	The amount of the time offset from GMT, if this option is used. Uses Time Dimension.
use_terrain	Opt whether to set altitude automatically by using terrain data.
graphics	Get the 2D Graphics properties of the facility.
position	Get the position of the facility.
terrain_normal	Set the normal to the local terrain.
terrain_normal_data	Data used in specifying terrain slope.
graphics_3d	Get the 3D Graphics properties of the facility.
access_constraints	Get the constraints imposed on the facility.
height_above_ground	Height of facility above its model of the ground. Height is measured along the normal to surface defined by reference ellipsoid of the central body. Facility models the ground as an ellipsoid passing through the ground position. Uses Distance Dimension.
altitude_reference	Get or set the altitude reference of the object.
atmosphere	Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
radar_clutter_map	Return the radar clutter map.
radar_cross_section	Return the radar cross sectoin.
save_terrain_mask_data_in_binary	Save terrain az-el mask data in binary.
lighting_obstruction_model	Get or set the obstruction model used in lighting computations.
lighting_maximum_step	Get or set the maximum step size to use when computing lighting. Only applies (and only can be set) when LightingObstructionModel is eLightingObstructionAzElMask or eLightingObstructionTerrain. Uses Time Dimension.
laser_environment	Get the laser environment.
rf_environment	Get the RF environment.
maximum_range_when_computing_az_el_mask	Get or set the maximum range to use when computing the az el mask using terrain data. Zero indicates to use algorithm default. Only applies when GetAzElMask returns eTerrainData (cannot be set if eMaskFile). Uses Distance Dimension.

Examples

Add an AzEl Mask to a Facility

# Facility facility: Facility Object
facility.set_az_el_mask(AzElMaskType.TERRAIN_DATA, 0)

Get the cartesian position of a facility

# Facility facility: Facility Object
(x, y, z) = facility.position.query_cartesian()

Set the geodetic position of a facility

# Facility facility: Facility Object
facility.position.assign_geodetic(41.9849, 21.4039, 0)  # Latitude, Longitude, Altitude

# Set altitude to height of terrain
facility.use_terrain = True

# Set altitude to a distance above the ground
facility.height_above_ground = 0.05  # km

Create a facility and set its height relative to ground level

# STKObjectRoot root: STK Object Model Root
from ansys.stk.core.stkobjects import Facility, STKObjectType

facility = Facility(root.current_scenario.children.new(STKObjectType.FACILITY, "facility1"))
facility.height_above_ground = 123.4

Create a facility (on the current scenario central body)

# STKObjectRoot root: STK Object Model Root
facility = root.current_scenario.children.new(STKObjectType.FACILITY, "MyFacility")

Import detail

from ansys.stk.core.stkobjects import Facility

Property detail

property Facility.use_local_time_offset: bool

Opt whether to use a local time offset from GMT.

property Facility.local_time_offset: float

The amount of the time offset from GMT, if this option is used. Uses Time Dimension.

property Facility.use_terrain: bool

Opt whether to set altitude automatically by using terrain data.

property Facility.graphics: FacilityGraphics

Get the 2D Graphics properties of the facility.

property Facility.position: IPosition

Get the position of the facility.

property Facility.terrain_normal: None

Set the normal to the local terrain.

property Facility.terrain_normal_data: ITerrainNormData

Data used in specifying terrain slope.

property Facility.graphics_3d: FacilityGraphics3D

Get the 3D Graphics properties of the facility.

property Facility.access_constraints: AccessConstraintCollection

Get the constraints imposed on the facility.

property Facility.height_above_ground: None

Height of facility above its model of the ground. Height is measured along the normal to surface defined by reference ellipsoid of the central body. Facility models the ground as an ellipsoid passing through the ground position. Uses Distance Dimension.

property Facility.altitude_reference: None

Get or set the altitude reference of the object.

property Facility.atmosphere: Atmosphere

Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.

property Facility.radar_clutter_map: IRadarClutterMapInheritable

Return the radar clutter map.

property Facility.radar_cross_section: RadarCrossSectionInheritable

Return the radar cross sectoin.

property Facility.save_terrain_mask_data_in_binary: bool

Save terrain az-el mask data in binary.

property Facility.lighting_obstruction_model: LightingObstructionModelType

Get or set the obstruction model used in lighting computations.

property Facility.lighting_maximum_step: float

Get or set the maximum step size to use when computing lighting. Only applies (and only can be set) when LightingObstructionModel is eLightingObstructionAzElMask or eLightingObstructionTerrain. Uses Time Dimension.

property Facility.laser_environment: PlatformLaserEnvironment

Get the laser environment.

property Facility.rf_environment: IPlatformRFEnvironment

Get the RF environment.

property Facility.maximum_range_when_computing_az_el_mask: float

Get or set the maximum range to use when computing the az el mask using terrain data. Zero indicates to use algorithm default. Only applies when GetAzElMask returns eTerrainData (cannot be set if eMaskFile). Uses Distance Dimension.

Method detail

Facility.set_az_el_mask(self, type: AzElMaskType, data: Any) → None

Set an az-el mask. A member of the AzElMaskType enumeration.

Parameters:

type : AzElMaskType

data : Any

Returns:

None

Facility.reset_az_el_mask(self) → None

Reset the az-el mask.

Returns:

None

Facility.get_az_el_mask(self) → AzElMaskType

Get the az-el mask. A member of the AzElMaskType enumeration.

Returns:

AzElMaskType

Facility.get_az_el_mask_data(self) → Any

Get az-el mask data.

Returns:

Any