com.luciad.tea.hypsometry

Terrain Analysis EngineClass TLcdHypsometricOrientation

java.lang.Object

com.luciad.tea.hypsometry.TLcdHypsometricOrientation

All Implemented Interfaces:

ILcdHypsometricValueProvider

public class TLcdHypsometricOrientation
extends Object
implements ILcdHypsometricValueProvider

This ILcdHypsometricValueProvider computes the cosine of the angle between a given reference direction in the xy plane and the direction of steepest descent. The values lie in the range [-1, 1].

Constructor Summary

Constructors

Constructor and Description
TLcdHypsometricOrientation() Creates a new TLcdHypsometricOrientation for the reference direction (0, 1).
TLcdHypsometricOrientation(double aReferenceDirectionX, double aReferenceDirectionY) Creates a new TLcdHypsometricOrientation for the given reference direction.
TLcdHypsometricOrientation(double aReferenceDirectionX, double aReferenceDirectionY, ILcdHypsometricNormalProvider aHypsometricNormalProvider) Creates a new TLcdHypsometricOrientation for the given reference direction and normal provider.

Method Summary

Modifier and Type	Method and Description
double	computeValue(ILcdMatrixView aMatrixView, int aX, int aY, double aElevationScale) Computes the hypsometric value at the given point.
Rectangle	getFootPrint() Returns the foot print of this provider.
ILcdHypsometricNormalProvider	getHypsometricNormalProvider() Returns the normal provider.
double	getMaximumValue() Returns the maximum hypsometric value that this provider may return.
double	getMinimumValue() Returns the minimum hypsometric value that this provider may return.
double	getReferenceDirectionX() Returns the x component of the reference direction.
double	getReferenceDirectionY() Returns the y component of the reference direction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TLcdHypsometricOrientation

public TLcdHypsometricOrientation()

Creates a new TLcdHypsometricOrientation for the reference direction (0, 1).

TLcdHypsometricOrientation

public TLcdHypsometricOrientation(double aReferenceDirectionX,
                                  double aReferenceDirectionY)

Creates a new TLcdHypsometricOrientation for the given reference direction. The direction does not have to be normalized. The normal provider is a default, which computes normals based on 2x2 samples.

Parameters:

aReferenceDirectionX - the x component of the reference direction.

aReferenceDirectionY - the y component of the reference direction.

TLcdHypsometricOrientation

public TLcdHypsometricOrientation(double aReferenceDirectionX,
                                  double aReferenceDirectionY,
                                  ILcdHypsometricNormalProvider aHypsometricNormalProvider)

Creates a new TLcdHypsometricOrientation for the given reference direction and normal provider. The direction does not have to be normalized.

Parameters:

aReferenceDirectionX - the x component of the reference direction.

aReferenceDirectionY - the y component of the reference direction.

aHypsometricNormalProvider - the normal provider.

Method Detail

getReferenceDirectionX

public double getReferenceDirectionX()

Returns the x component of the reference direction.

Returns:

the x component of the reference direction.

getReferenceDirectionY

public double getReferenceDirectionY()

Returns the y component of the reference direction.

Returns:

the y component of the reference direction.

getHypsometricNormalProvider

public ILcdHypsometricNormalProvider getHypsometricNormalProvider()

Returns the normal provider.

Returns:

the normal provider.

getFootPrint

public Rectangle getFootPrint()

Description copied from interface: ILcdHypsometricValueProvider

Returns the foot print of this provider. For instance, if the hypsometric value at each point is computed based on the surrounding 3x3 matrix values, the foot print is the rectangle (-1, -1, 3, 3).

Specified by:

getFootPrint in interface ILcdHypsometricValueProvider

Returns:

the foot print of this provider.

getMinimumValue

public double getMinimumValue()

Description copied from interface: ILcdHypsometricValueProvider

Returns the minimum hypsometric value that this provider may return.

Specified by:

getMinimumValue in interface ILcdHypsometricValueProvider

Returns:

the minimum hypsometric value.

getMaximumValue

public double getMaximumValue()

Description copied from interface: ILcdHypsometricValueProvider

Returns the maximum hypsometric value that this provider may return.

Specified by:

getMaximumValue in interface ILcdHypsometricValueProvider

Returns:

the maximum hypsometric value.

computeValue

public double computeValue(ILcdMatrixView aMatrixView,
                           int aX,
                           int aY,
                           double aElevationScale)

Description copied from interface: ILcdHypsometricValueProvider

Computes the hypsometric value at the given point.

Specified by:

computeValue in interface ILcdHypsometricValueProvider

Parameters:

aMatrixView - the matrix containing elevation values.

aX - the x ordinate in the matrix.

aY - the y ordinate in the matrix.

aElevationScale - the scale of the elevation values in the tiles, expressed in matrix units per tile elevation unit.

Returns:

the computed hypsometric value, or NaN if it is unknown, for instance if not all required elevations are known.