org.esa.snap.core.dataop.dem

Interface ElevationModelDescriptor

All Known Implementing Classes:

AbstractElevationModelDescriptor

public interface ElevationModelDescriptor

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

Method Summary

Modifier and Type	Method and Description
boolean	canBeDownloaded() Returns true if the DEM can be automatically downloaded
ElevationModel	createDem(Resampling resampling) Creates the elevation model instance.
File	getDemInstallDir() Returns the directory (if any) where the DEM files shall be located.
String	getName() The name of this elevation source, e.g.
float	getNoDataValue() Gets the no-data value for this elevation map.
int	getNumXTiles() Gets the number of tiles in x direction
int	getNumYTiles() Gets the number of tiles in y direction
int	getRasterHeight() Gets the (raster) height of this elevation map.
int	getRasterWidth() Gets the (raster) width of this elevation map.
int	getTileWidth() Gets the width of a tile in pixels.
int	getTileWidthInDegrees() Gets the width of a tile in degrees.

Method Detail

getName

String getName()

The name of this elevation source, e.g. "GTOPO30"

Returns:

a name

getNoDataValue

float getNoDataValue()

Gets the no-data value for this elevation map.

Returns:

the no-data value, e.g. -99999

getRasterWidth

int getRasterWidth()

Gets the (raster) width of this elevation map.

Returns:

the width value, e.g. 15000

getRasterHeight

int getRasterHeight()

Gets the (raster) height of this elevation map.

Returns:

the (raster) height value, e.g. 30000

getTileWidthInDegrees

int getTileWidthInDegrees()

Gets the width of a tile in degrees.

Returns:

the width of a tile in degrees, e.g. 15

getTileWidth

int getTileWidth()

Gets the width of a tile in pixels.

Returns:

the width of a tile in pixels, e.g. 1800

getNumXTiles

int getNumXTiles()

Gets the number of tiles in x direction

Returns:

number of rows

getNumYTiles

int getNumYTiles()

Gets the number of tiles in y direction

Returns:

number of columns

createDem

ElevationModel createDem(Resampling resampling)

Creates the elevation model instance.

Parameters:

resampling - The resampling method to be used.

Returns:

a DEM instance, can be null e.g. if related DEM files are not installed

Since:

BEAM 4.6

canBeDownloaded

boolean canBeDownloaded()

Returns true if the DEM can be automatically downloaded

Returns:

true if auto download

getDemInstallDir

File getDemInstallDir()

Returns the directory (if any) where the DEM files shall be located.

Returns:

the DEM file directory