Click or drag to resize

TerrainAlongLineComputeObstructionMetric Method (Cartesian, Cartesian, TerrainProvider, Double, Double, Boolean, Boolean)

Computes a metric value indicating the amount of obstruction from the line of sight between the target and observer positions and the direction to the point on terrain with the highest elevation angle. The metric value is determined from the perspective of the position closest to the Shape.

Namespace:  AGI.Foundation.Terrain
Assembly:  AGI.Foundation.TerrainAnalysis (in AGI.Foundation.TerrainAnalysis.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
Copy
public static double ComputeObstructionMetric(
	Cartesian observerPositionFixed,
	Cartesian targetPositionFixed,
	TerrainProvider terrainProvider,
	double minimumTerrainHeight,
	double maximumTerrainHeight,
	bool findWorstObstruction,
	bool findIndicatedExtremaPrecisely
)

Parameters

observerPositionFixed
Type: AGI.Foundation.CoordinatesCartesian
The position of the observer object, expressed in the reference frame fixed to the ellipsoid specified by the Shape property of the terrainProvider.
targetPositionFixed
Type: AGI.Foundation.CoordinatesCartesian
The position of the target object, expressed in the reference frame fixed to the ellipsoid specified by the Shape property of the terrainProvider.
terrainProvider
Type: AGI.Foundation.TerrainTerrainProvider
The terrain provider describing the terrain that is potentially obscuring the path between the two objects.
minimumTerrainHeight
Type: SystemDouble
The minimum height in meters that can be returned by the TerrainProvider's GetHeightRelativeToShape(Double, Double) method. Setting this value lower than necessary will not affect the results, but it will decrease performance. Setting it too high can cause incorrect results. For realistic Earth-based terrain data, DefaultMinimumTerrainHeight is a safe value to use for this parameter.
maximumTerrainHeight
Type: SystemDouble
The maximum height in meters that can be returned by the TerrainProvider's GetHeightRelativeToShape(Double, Double) method. Setting this value higher than necessary will not affect the results, but it will decrease performance. Setting it too low can cause incorrect results. For realistic Earth-based terrain data, DefaultMaximumTerrainHeight is a safe value to use for this parameter.
findWorstObstruction
Type: SystemBoolean
Indicates whether the metric value associated with the worst amount of obstruction is sought.
findIndicatedExtremaPrecisely
Type: SystemBoolean
Determines whether all extrema indicated from sampling should be found precisely.

Return Value

Type: Double
The metric value indicating obstruction from the line of sight between the target and observer positions and the direction to the point on terrain with the highest elevation angle. The metric value is determined from the perspective of the position closest to the Shape. Positive numbers indicate that the line of sight between the objects is not obscured by terrain. Negative numbers indicate that it is obscured.
Exceptions
ExceptionCondition
ArgumentNullExceptionThrown if terrainProvider is .
See Also