com.luciad.tea.hypsometry

Terrain Analysis EngineClass TLcdHypsometricCrease

java.lang.Object

com.luciad.tea.hypsometry.TLcdHypsometricCrease

All Implemented Interfaces:

ILcdHypsometricValueProvider

public class TLcdHypsometricCrease
extends Object
implements ILcdHypsometricValueProvider

This ILcdHypsometricValueProvider computes the ridges and/or valleys of a terrain. The computed hypsometric value is a a measure for how strongly the terrain deviates from a locally fitted plane. When computing ridges and valleys, it can range from -pi/2 for sharp valleys to pi/2 for sharp ridges. When only computing either ridges or valleys, it can range from 0 for no ridges resp. valleys, to pi/2 for sharp ridges resp. valleys.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RIDGE
static int	RIDGE_AND_VALLEY
static int	VALLEY

Constructor Summary

Constructors

Constructor and Description
TLcdHypsometricCrease() Creates a new TLcdHypsometricRidge with a 3x3 foot print for computing ridges and valleys.
TLcdHypsometricCrease(Rectangle aFootPrint, int aType) Creates a new TLcdHypsometricRidge with the given foot print and type.

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.
double	getMaximumValue() Returns the maximum hypsometric value that this provider may return.
double	getMinimumValue() Returns the minimum hypsometric value that this provider may return.
int	getType() Returns the type of this provider.

Methods inherited from class java.lang.Object

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

Field Detail

RIDGE

public static final int RIDGE

See Also:

Constant Field Values

VALLEY

public static final int VALLEY

See Also:

Constant Field Values

RIDGE_AND_VALLEY

public static final int RIDGE_AND_VALLEY

See Also:

Constant Field Values

Constructor Detail

TLcdHypsometricCrease

public TLcdHypsometricCrease()

Creates a new TLcdHypsometricRidge with a 3x3 foot print for computing ridges and valleys.

TLcdHypsometricCrease

public TLcdHypsometricCrease(Rectangle aFootPrint,
                             int aType)

Creates a new TLcdHypsometricRidge with the given foot print and type.

Parameters:

aFootPrint - the foot print for the computations.

aType - one of RIDGE, VALLEY, or RIDGE_AND_VALLEY.

Method Detail

getType

public int getType()

Returns the type of this provider.

Returns:

one of RIDGE, VALLEY, or RIDGE_AND_VALLEY.

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.