IGroundLocation

class ansys.stk.core.stkobjects.IGroundLocation

Interface containing properties common to ground location objects (i.e. Target, Place, and Facility).

Overview

Methods

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.
reset_az_el_mask	Reset the az-el mask.
set_az_el_mask	Set an az-el mask. A member of the AzElMaskType enumeration.

Properties

access_constraints	Get the constraints imposed on the ground location.
altitude_reference	Get or set the altitude reference of the object.
chain_analysis_options	Get the ground location’s chain analysis options.
ground_location_graphics	Get the 2D Graphics properties of the ground location.
ground_location_graphics_3d	Get the 3D Graphics properties of the ground location.
height_above_ground	Height of ground location above its model of the ground. Height is measured along the normal to surface defined by reference ellipsoid of the central body. Models the ground as an ellipsoid passing through the ground position. Uses Distance Dimension.
laser_environment	Get the laser environment.
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.
lighting_obstruction_model	Get or set the obstruction model used in lighting computations.
local_time_offset	The amount of the time offset from GMT, if this option is used. Uses Time Dimension.
max_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.
position	Get the position of the ground location.
radar_cross_section	Return the radar cross sectoin.
rf_environment	Get the RF environment.
save_terrain_mask_data_in_binary	Save terrain az-el mask data in binary.
terrain_norm	Set the normal to the local terrain.
terrain_norm_data	Data used in specifying terrain slope.
use_local_time_offset	Opt whether to use a local time offset from GMT.
use_terrain	Opt whether to set altitude automatically by using terrain data.

Import detail

from ansys.stk.core.stkobjects import IGroundLocation

Property detail

property IGroundLocation.access_constraints: AccessConstraintCollection

Get the constraints imposed on the ground location.

property IGroundLocation.altitude_reference: None

Get or set the altitude reference of the object.

property IGroundLocation.chain_analysis_options: ChainAnalysisOptions

Get the ground location’s chain analysis options.

property IGroundLocation.ground_location_graphics: IGroundLocationGraphics

Get the 2D Graphics properties of the ground location.

property IGroundLocation.ground_location_graphics_3d: IGroundLocationGraphics3D

Get the 3D Graphics properties of the ground location.

property IGroundLocation.height_above_ground: None

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

property IGroundLocation.laser_environment: PlatformLaserEnvironment

Get the laser environment.

property IGroundLocation.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 IGroundLocation.lighting_obstruction_model: LightingObstructionModelType

Get or set the obstruction model used in lighting computations.

property IGroundLocation.local_time_offset: float

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

property IGroundLocation.max_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.

property IGroundLocation.position: IPosition

Get the position of the ground location.

property IGroundLocation.radar_cross_section: RadarCrossSectionInheritable

Return the radar cross sectoin.

property IGroundLocation.rf_environment: PlatformRFEnvironment

Get the RF environment.

property IGroundLocation.save_terrain_mask_data_in_binary: bool

Save terrain az-el mask data in binary.

property IGroundLocation.terrain_norm: None

Set the normal to the local terrain.

property IGroundLocation.terrain_norm_data: ITerrainNormData

Data used in specifying terrain slope.

property IGroundLocation.use_local_time_offset: bool

Opt whether to use a local time offset from GMT.

property IGroundLocation.use_terrain: bool

Opt whether to set altitude automatically by using terrain data.

Method detail

IGroundLocation.get_az_el_mask(self) → AzElMaskType

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

Returns:

AzElMaskType

IGroundLocation.get_az_el_mask_data(self) → Any

Get az-el mask data.

Returns:

Any

IGroundLocation.reset_az_el_mask(self) → None

Reset the az-el mask.

Returns:

None

IGroundLocation.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