Place#

class ansys.stk.core.stkobjects.Place#

Bases: ISTKObject, ILifetimeInformation, IDisplayTime

Class defining the Place object.

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 place.
`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.
`graphics`	Get the 2D Graphics properties of the place.
`graphics_3d`	Get the 3D Graphics properties of the place.
`height_above_ground`	Height of place above its model of the ground. Height is measured along the normal to surface defined by reference ellipsoid of the central body. Place 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.
`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.
`position`	Get the position of the place.
`radar_clutter_map`	Return the radar clutter map.
`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_normal`	Set the normal to the local terrain.
`terrain_normal_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 Place

Property detail#

property Place.access_constraints: AccessConstraintCollection#: Get the constraints imposed on the place.

property Place.altitude_reference: None#: Get or set the altitude reference of the object.

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

property Place.graphics: PlaceGraphics#: Get the 2D Graphics properties of the place.

property Place.graphics_3d: PlaceGraphics3D#: Get the 3D Graphics properties of the place.

property Place.height_above_ground: None#: Height of place above its model of the ground. Height is measured along the normal to surface defined by reference ellipsoid of the central body. Place models the ground as an ellipsoid passing through the ground position. Uses Distance Dimension.

property Place.laser_environment: PlatformLaserEnvironment#: Get the laser environment.

property Place.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 Place.lighting_obstruction_model: LightingObstructionModelType#: Get or set the obstruction model used in lighting computations.

property Place.local_time_offset: float#: The amount of the time offset from GMT, if this option is used. Uses Time Dimension.

property Place.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.

property Place.position: IPosition#: Get the position of the place.

property Place.radar_clutter_map: IRadarClutterMapInheritable#: Return the radar clutter map.

property Place.radar_cross_section: RadarCrossSectionInheritable#: Return the radar cross sectoin.

property Place.rf_environment: IPlatformRFEnvironment#: Get the RF environment.

property Place.save_terrain_mask_data_in_binary: bool#: Save terrain az-el mask data in binary.

property Place.terrain_normal: None#: Set the normal to the local terrain.

property Place.terrain_normal_data: ITerrainNormData#: Data used in specifying terrain slope.

property Place.use_local_time_offset: bool#: Opt whether to use a local time offset from GMT.

property Place.use_terrain: bool#: Opt whether to set altitude automatically by using terrain data.

Method detail#

Place.get_az_el_mask(self) → AzElMaskType#

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

Returns:: AzElMaskType

Place.get_az_el_mask_data(self) → Any#

Get az-el mask data.

Returns:: Any

Place.reset_az_el_mask(self) → None#

Reset the az-el mask.

Returns:: None

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