TerrainAlongLineComputeObstructionMetric Method (Cartesian, Cartesian, TerrainProvider, 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. The DefaultMinimumTerrainHeight and DefaultMaximumTerrainHeight are used for the computation.

Namespace: AGI.Foundation.Terrain
Assembly: AGI.Foundation.TerrainAnalysis (in AGI.Foundation.TerrainAnalysis.dll) Version: 24.1.418.0 (24.1.418.0)

Syntax

C++

Copy

public static double ComputeObstructionMetric(
	Cartesian observerPositionFixed,
	Cartesian targetPositionFixed,
	TerrainProvider terrainProvider,
	bool findWorstObstruction,
	bool findIndicatedExtremaPrecisely
)

Public Shared Function ComputeObstructionMetric ( 
	observerPositionFixed As Cartesian,
	targetPositionFixed As Cartesian,
	terrainProvider As TerrainProvider,
	findWorstObstruction As Boolean,
	findIndicatedExtremaPrecisely As Boolean
) As Double

public:
static double ComputeObstructionMetric(
	Cartesian observerPositionFixed, 
	Cartesian targetPositionFixed, 
	TerrainProvider^ terrainProvider, 
	bool findWorstObstruction, 
	bool findIndicatedExtremaPrecisely
)

static member ComputeObstructionMetric : 
        observerPositionFixed : Cartesian * 
        targetPositionFixed : Cartesian * 
        terrainProvider : TerrainProvider * 
        findWorstObstruction : bool * 
        findIndicatedExtremaPrecisely : bool -> float

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

Exception	Condition
ArgumentNullException	Thrown if terrainProvider is .

Reference

TerrainAlongLine Class

ComputeObstructionMetric Overload

AGI.Foundation.Terrain Namespace

TerrainAlongLineAddLanguageSpecificTextSet("LSTB1C89477_0?cpp=::|nu=.");ComputeObstructionMetric Method (Cartesian, Cartesian, TerrainProvider, Boolean, Boolean)

Parameters

Return Value

Reference

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