Package com.luciad.lucy.addons.tea.hypsometry

Class TLcyHypsometryBackEnd

java.lang.Object

com.luciad.lucy.addons.tea.ALcyTEABackEnd

com.luciad.lucy.addons.tea.hypsometry.TLcyHypsometryBackEnd

public class TLcyHypsometryBackEnd
extends ALcyTEABackEnd

Provides back-end functionality for a TEA hypsometry add-on. Its main purpose is to create hypsometric value providers. It can also create snapshots of the combined visible elevation layers in a view. These snapshots can be used as input for hypsometric operations.

See Also:

• ALcyTEABackEnd

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AZIMUTH_KEY	Property name for the azimuth that the hypsometric value provider will use.
static final String	GEOTIFF_MODEL_DISPLAY_NAME_KEY	Property name for the model display name to use for newly created elevation snapshots.
static final String	HYPSOMETRIC_FOOT_PRINT_KEY	Property name for the footprint that the hypsometric value provider will use.
static final String	HYPSOMETRIC_NORMAL_PROVIDER_KEY	Property name for the hypsometric normal provider that the hypsometric value provider should use.
static final String	HYPSOMETRIC_VALUE_PROVIDER_KEY	The property name for a line-of-sight coverage's propagation function.
static final String	HYPSOMETRIC_VALUE_PROVIDER_ORIENTATION_ANGLE_ID	Constant denoting a hypsometric value provider for slope orientations.
static final String	HYPSOMETRIC_VALUE_PROVIDER_ORIENTATION_ID	Constant denoting a hypsometric value provider for slope orientations.
static final String	HYPSOMETRIC_VALUE_PROVIDER_RIDGE_AND_VALLEY_ID	Constant denoting the hypsometric value provider for ridges and valleys.
static final String	HYPSOMETRIC_VALUE_PROVIDER_RIDGE_ID	Constant denoting the hypsometric value provider for ridges.
static final String	HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ANGLE_ID	Constant denoting a hypsometric value provider for slope angles.
static final String	HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ID	Constant denoting a hypsometric value provider for slope angles.
static final String	HYPSOMETRIC_VALUE_PROVIDER_VALLEY_ID	Constant denoting the hypsometric value provider for valleys.
static final String	INCLINATION_KEY	Property name for the inclination that the hypsometric value provider will use.

Fields inherited from class com.luciad.lucy.addons.tea.ALcyTEABackEnd

ALTITUDE_PROVIDER_KEY, DISPLAY_NAME_KEY, MODEL_DISPLAY_NAME_KEY, MODEL_REFERENCE_KEY, QUALITY_KEY, SHAPE_KEY, SHAPE_REFERENCE_KEY, SOURCE_NAME_KEY, TARGET_REFERENCE_KEY, VIEW_KEY

Constructor Summary

Constructors

Constructor	Description
TLcyHypsometryBackEnd(ILcyLucyEnv aLucyEnv)	Default constructor for the hypsometry back-end.

Method Summary

Modifier and Type	Method	Description
ILcdModel	createHypsometricGeoTIFFModel(ALcyProperties aProperties)	Creates a new model containing a raster snapshot of the visible elevation layers in a view.
ILcdHypsometricValueProvider	createHypsometricValueProvider(ALcyProperties aProperties)	Creates and returns a hypsometric value provider based on the given properties.
ILcdModelDescriptor	createModelDescriptor(ALcyProperties aProperties)	Returns a model descriptor suitable for the add-on's used models.
String	retrieveHypsometricValueProviderLabel(String aHypsometricValueProviderKey)	Returns a displayable label for the given hypsometric value provider.

Methods inherited from class com.luciad.lucy.addons.tea.ALcyTEABackEnd

createAltitudeDescriptor, createAltitudeMatrixViewFactory, createAltitudeProvider, getLucyEnv

Methods inherited from class java.lang.Object

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

Field Details

GEOTIFF_MODEL_DISPLAY_NAME_KEY

public static final String GEOTIFF_MODEL_DISPLAY_NAME_KEY

Property name for the model display name to use for newly created elevation snapshots. The associated property value is of type String.

See Also:

• createHypsometricGeoTIFFModel(com.luciad.lucy.util.properties.ALcyProperties)
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ID

public static final String HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ID

Constant denoting a hypsometric value provider for slope angles.

See Also:

• createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdHypsometricSlope
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ANGLE_ID

public static final String HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ANGLE_ID

Constant denoting a hypsometric value provider for slope angles.

See Also:

• createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdHypsometricSlopeAngle
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_ORIENTATION_ID

public static final String HYPSOMETRIC_VALUE_PROVIDER_ORIENTATION_ID

Constant denoting a hypsometric value provider for slope orientations.

See Also:

• createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdHypsometricOrientation
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_ORIENTATION_ANGLE_ID

public static final String HYPSOMETRIC_VALUE_PROVIDER_ORIENTATION_ANGLE_ID

Constant denoting a hypsometric value provider for slope orientations.

See Also:

• createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdHypsometricOrientationAngle
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_RIDGE_ID

public static final String HYPSOMETRIC_VALUE_PROVIDER_RIDGE_ID

Constant denoting the hypsometric value provider for ridges.

See Also:

• createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdHypsometricCrease
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_VALLEY_ID

public static final String HYPSOMETRIC_VALUE_PROVIDER_VALLEY_ID

Constant denoting the hypsometric value provider for valleys.

See Also:

• createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdHypsometricCrease
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_RIDGE_AND_VALLEY_ID

public static final String HYPSOMETRIC_VALUE_PROVIDER_RIDGE_AND_VALLEY_ID

Constant denoting the hypsometric value provider for ridges and valleys.

See Also:

• createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdHypsometricCrease
• Constant Field Values

HYPSOMETRIC_VALUE_PROVIDER_KEY

public static final String HYPSOMETRIC_VALUE_PROVIDER_KEY

The property name for a line-of-sight coverage's propagation function. The associated property value is one of PROPAGATION_FUNCTION_VALUE_FIXED_HEIGHT, PROPAGATION_FUNCTION_VALUE_NORMAL and PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND.

See Also:

• Constant Field Values

HYPSOMETRIC_NORMAL_PROVIDER_KEY

public static final String HYPSOMETRIC_NORMAL_PROVIDER_KEY

Property name for the hypsometric normal provider that the hypsometric value provider should use. The associated property value is of type ILcdHypsometricNormalProvider

See Also:

• Constant Field Values

AZIMUTH_KEY

public static final String AZIMUTH_KEY

Property name for the azimuth that the hypsometric value provider will use. The associated property should be of type double, expressed in degrees.

See Also:

• Constant Field Values

INCLINATION_KEY

public static final String INCLINATION_KEY

Property name for the inclination that the hypsometric value provider will use. The associated property should be of type double, expressed in degrees.

See Also:

• Constant Field Values

HYPSOMETRIC_FOOT_PRINT_KEY

public static final String HYPSOMETRIC_FOOT_PRINT_KEY

Property name for the footprint that the hypsometric value provider will use. The associated property should be of type Rectangle.

See Also:

• Constant Field Values

Constructor Details

TLcyHypsometryBackEnd

public TLcyHypsometryBackEnd(ILcyLucyEnv aLucyEnv)

Default constructor for the hypsometry back-end.

Parameters:

aLucyEnv - the Lucy environment for which the back-end will be used

Method Details

createModelDescriptor

public ILcdModelDescriptor createModelDescriptor(ALcyProperties aProperties)

Returns a model descriptor suitable for the add-on's used models. This implementation does not support this method and will throw an UnsupportedOperationException.

Specified by:

createModelDescriptor in class ALcyTEABackEnd

Parameters:

aProperties -

Returns:

the created ILcdModelDescriptor.

Throws:

UnsupportedOperationException

createHypsometricValueProvider

public ILcdHypsometricValueProvider createHypsometricValueProvider(ALcyProperties aProperties)

Creates and returns a hypsometric value provider based on the given properties.

Parameters:

aProperties - the properties containing the method's parameters.

• TLcyHypsometryAddon.SELECTED_VALUE_PROVIDER_KEY determines what value provider to create
• For HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ID and HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ANGLE_ID:
  • HYPSOMETRIC_NORMAL_PROVIDER_KEY the normal provider that the value provider should use
  • AZIMUTH_KEY the reference direction's azimuth
  • INCLINATION_KEY the reference inclination's inclination
• For HYPSOMETRIC_VALUE_PROVIDER_ORIENTATION_ID and HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ANGLE_ID:
  • HYPSOMETRIC_NORMAL_PROVIDER_KEY the normal provider that the value provider should use
  • AZIMUTH_KEY the reference direction's azimuth
• For HYPSOMETRIC_VALUE_PROVIDER_RIDGE_ID, HYPSOMETRIC_VALUE_PROVIDER_VALLEY_ID and HYPSOMETRIC_VALUE_PROVIDER_RIDGE_AND_VALLEY_ID
  • HYPSOMETRIC_FOOT_PRINT_KEY the value provider's footprint

Returns:

a hypsometric value provider configured according to the given properties

retrieveHypsometricValueProviderLabel

public String retrieveHypsometricValueProviderLabel(String aHypsometricValueProviderKey)

Returns a displayable label for the given hypsometric value provider.

Parameters:

aHypsometricValueProviderKey - the hypsometric value provider key to return the label for

Returns:

a displayable label

createHypsometricGeoTIFFModel

public ILcdModel createHypsometricGeoTIFFModel(ALcyProperties aProperties)

Creates a new model containing a raster snapshot of the visible elevation layers in a view.

Parameters:

aProperties - the properties containing the method's parameters.

• ALcyTEABackEnd.VIEW_KEY the view to take the snapshot of
• ALcyTEABackEnd.SHAPE_KEY the shape to constrain to
• ALcyTEABackEnd.SHAPE_REFERENCE_KEY the model reference of the shape to constrain to

Returns:

a model containing a single raster