CentralBodyTerrainCollectionElement#

class ansys.stk.core.stkobjects.CentralBodyTerrainCollectionElement#

Element of collection of terrain associated with central body.

Overview#

get_altitude

Return the altitude at the specified position relative to the input reference surface. If the specified position is outside terrain sources, the altitude of 0.0 relative to the default reference ellipsoid (WGS84 for Earth) is returned.

get_altitude_batch

Return the altitudes at the specified position array relative to the input reference surface. If a specified position is outside terrain sources, the altitude of 0.0 relative to the default reference ellipsoid (WGS84 for Earth) is used.

get_altitudes_between_points_at_resolution

Return the terrain profile at the specified resolution relative to the input reference surface. If a position along the profile is outside terrain sources, the altitude of 0.0 relative to the default reference ellipsoid (WGS84 for Earth) is used.

get_extent_maximum_resolution

Return the highest resolution for any terrain that overlaps the specified rectangle.

central_body

Name of central body.

terrain_collection

Terrain collection.

Import detail#

from ansys.stk.core.stkobjects import CentralBodyTerrainCollectionElement

Property detail#

property CentralBodyTerrainCollectionElement.central_body: str#

Name of central body.

property CentralBodyTerrainCollectionElement.terrain_collection: TerrainCollection#

Terrain collection.

Method detail#

CentralBodyTerrainCollectionElement.get_altitude(self, lat: Any, lon: Any, alt_ref: AltitudeReferenceType) float#

Return the altitude at the specified position relative to the input reference surface. If the specified position is outside terrain sources, the altitude of 0.0 relative to the default reference ellipsoid (WGS84 for Earth) is returned.

Parameters:

lat : Any

lon : Any

alt_ref : AltitudeReferenceType

Returns:

float

CentralBodyTerrainCollectionElement.get_altitude_batch(self, lat_lons: list, alt_ref: AltitudeReferenceType) list#

Return the altitudes at the specified position array relative to the input reference surface. If a specified position is outside terrain sources, the altitude of 0.0 relative to the default reference ellipsoid (WGS84 for Earth) is used.

Parameters:

lat_lons : list

alt_ref : AltitudeReferenceType

Returns:

list

CentralBodyTerrainCollectionElement.get_altitudes_between_points_at_resolution(self, southwest_latitude: Any, southwest_longitude: Any, northeast_latitude: Any, northeast_longitude: Any, step_size: Any, distance_type: DistanceOnSphere, alt_ref: AltitudeReferenceType) list#

Return the terrain profile at the specified resolution relative to the input reference surface. If a position along the profile is outside terrain sources, the altitude of 0.0 relative to the default reference ellipsoid (WGS84 for Earth) is used.

Parameters:

southwest_latitude : Any

southwest_longitude : Any

northeast_latitude : Any

northeast_longitude : Any

step_size : Any

distance_type : DistanceOnSphere

alt_ref : AltitudeReferenceType

Returns:

list

CentralBodyTerrainCollectionElement.get_extent_maximum_resolution(self, southwest_latitude: Any, southwest_longitude: Any, northeast_latitude: Any, northeast_longitude: Any) float#

Return the highest resolution for any terrain that overlaps the specified rectangle.

Parameters:

southwest_latitude : Any

southwest_longitude : Any

northeast_latitude : Any

northeast_longitude : Any

Returns:

float