org.esa.beam.framework.dataop.dem
Interface ElevationModel

public interface ElevationModel

An ElevationModel is used to obtain an elevation above a specified geographical datum for a given geographical position.

Version:

$Revision$

Author:

Norman Fomferra

Method Summary

void	dispose() Releases all of the resources used by this object instance and all of its owned children.
ElevationModelDescriptor	getDescriptor() Gets the descriptor of this DEM.
float	getElevation(GeoPos geoPos) Gets the elevation at the geographical coordinate in meters.
Resampling	getResampling()

Method Detail

getDescriptor

ElevationModelDescriptor getDescriptor()

Gets the descriptor of this DEM.

Returns:

the descriptor which is never null

getElevation

float getElevation(GeoPos geoPos)
                   throws Exception

Gets the elevation at the geographical coordinate in meters.

Parameters:

geoPos - the geographical coordinate

Returns:

an elevation in meters, or the special value returned by ElevationModelDescriptor.getNoDataValue() if an elevation is not available

Throws:

Exception - if a non-runtime error occurs, e.g I/O error

getResampling

Resampling getResampling()

Returns:

The resampling method used.

Since:

BEAM 4.6

dispose

void dispose()

Releases all of the resources used by this object instance and all of its owned children. Its primary use is to allow the garbage collector to perform a vanilla job.

This method should be called only if it is for sure that this object instance will never be used again. The results of referencing an instance of this class after a call to dispose() are undefined.

Overrides of this method should always call super.dispose(); after disposing this instance.