Package hec.map.raster

Class RasterMap

java.lang.Object

hec.map.MapObject

hec.map.raster.RasterMap

All Implemented Interfaces:

ElevationMap, GridMap, MapObjectInterface, Serializable

public class RasterMap
extends MapObject
implements Serializable, MapObjectInterface, ElevationMap, GridMap

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BYTES_IN_FLOAT
static final int	BYTES_IN_STRING
static final int	CATEGORY_DATA
static final int	CONTINUOUS_DATA
static final String	EXTENSION
static final String[]	IMPORT_EXTENSIONS
static final float	RESAMPLE_TO_UNDEFINED_RATIO
static final String	VERSION
static final String	VERSION_CONTINUOUS_ONLY

Fields inherited from class hec.map.MapObject

_debug, _extent, _fileOpener, _loaded, _mapId, mCoordinateReferencySystem

Constructor Summary

Constructors

Constructor	Description
RasterMap()
RasterMap(MapIdentifier id)
RasterMap(String fileName)

Method Summary

Modifier and Type	Method	Description
protected SegmentData	buildSegment()
Resolution	getBaseResolution()
int	getColumnsInASegment()
float[]	getElevation(double[] northing, double[] easting)	Retruns an array of elevations for an array of northin/easting points.
float	getElevation(WorldPt pt)	Returns the elevation at the given World point.
long	getEndOfHeader()
WorldRect	getGridCellSize()
SegmentInfo	getLowerLeft()
WorldPt	getLowerLeftCorner()
SegmentInfo	getLowerRight()
double	getMaximumElevation()
float	getMaxValue()
double	getMinimumElevation()
float	getMinValue()
double	getNoDataValue()	Returns the value that represents an UNDEFINED elevation in the map.
Resolution	getResolution()
List	getResolutions()
int	getRowsInASegment()
RasterSegmentIterator	getSegmentIterator()
SegmentInfo	getUpperLeft()
SegmentInfo	getUpperRight()
float	getValue(WorldPt pt)
static RasterMap	importMap(RasterImportProgressIndicator progress, FileOpener fileOpener, int typeOfData, AiDemBaseMap map)
static RasterMap	importMap(RasterImportProgressIndicator progress, Identifier smrmpId, String mapName, int dataType, String[] params, String[] units, AiDemBaseMap[] maps)
void	load()	Split the load between binary and ASCII
ArrayList	loadArea(WorldRect area, Observer observer)
protected void	readHeader(HecFile file)
protected void	returnSegment(SegmentData sd)
protected void	returnSegment(SegmentInfo si)
boolean	supportsNoDataValue()
void	unload()	Method to tell the Map Object to unload, because the map is done
protected void	writeHeader(HecFile file)
protected void	writeHeader(DataOutputStream out)

Methods inherited from class hec.map.MapObject

equals, getCoordinateInfo, getCoordinateReferenceSystem, getExtent, getFilenames, getFileOpener, getMapIdentifier, getName, mapIdentifierEquals, newFile, newThenOpenFile, openFile, readProjection, setExtent, setFileOpener, setMapIdentifier, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface hec.map.ElevationMap

getName

Methods inherited from interface hec.map.MapObjectInterface

getCoordinateReferenceSystem, getExtent, getMapIdentifier, setExtent, setMapIdentifier

Field Details

EXTENSION

public static final String EXTENSION

See Also:

• Constant Field Values

BYTES_IN_STRING

public static final int BYTES_IN_STRING

See Also:

• Constant Field Values

BYTES_IN_FLOAT

public static final int BYTES_IN_FLOAT

See Also:

• Constant Field Values

VERSION_CONTINUOUS_ONLY

public static final String VERSION_CONTINUOUS_ONLY

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

RESAMPLE_TO_UNDEFINED_RATIO

public static final float RESAMPLE_TO_UNDEFINED_RATIO

See Also:

• Constant Field Values

CONTINUOUS_DATA

public static final int CONTINUOUS_DATA

See Also:

• Constant Field Values

CATEGORY_DATA

public static final int CATEGORY_DATA

See Also:

• Constant Field Values

IMPORT_EXTENSIONS

public static final String[] IMPORT_EXTENSIONS

Constructor Details

RasterMap

public RasterMap(String fileName)

RasterMap

public RasterMap(MapIdentifier id)

RasterMap

public RasterMap()

Method Details

getGridCellSize

public WorldRect getGridCellSize()

Specified by:

getGridCellSize in interface GridMap

getBaseResolution

public Resolution getBaseResolution()

getResolution

public Resolution getResolution()

getLowerLeft

public SegmentInfo getLowerLeft()

getLowerRight

public SegmentInfo getLowerRight()

getUpperLeft

public SegmentInfo getUpperLeft()

getUpperRight

public SegmentInfo getUpperRight()

getRowsInASegment

public int getRowsInASegment()

getColumnsInASegment

public int getColumnsInASegment()

getValue

public float getValue(WorldPt pt)

supportsNoDataValue

public boolean supportsNoDataValue()

Specified by:

supportsNoDataValue in interface GridMap

getNoDataValue

public double getNoDataValue()

Description copied from interface: ElevationMap

Returns the value that represents an UNDEFINED elevation in the map.

Specified by:

getNoDataValue in interface ElevationMap

Specified by:

getNoDataValue in interface GridMap

getMaximumElevation

public double getMaximumElevation()

Specified by:

getMaximumElevation in interface ElevationMap

getMaxValue

public float getMaxValue()

getMinimumElevation

public double getMinimumElevation()

Specified by:

getMinimumElevation in interface ElevationMap

getMinValue

public float getMinValue()

getSegmentIterator

public RasterSegmentIterator getSegmentIterator()

getElevation

public float[] getElevation(double[] northing,
 double[] easting)

Description copied from interface: ElevationMap

Retruns an array of elevations for an array of northin/easting points. Northing/Easting array values are paired northing[0],easting[0], etc to make one point. Throws an invalid value exception if the northing/easting arrays are not the same size.

Specified by:

getElevation in interface ElevationMap

Returns:

array of elevation points. The elevation value elevation[n] was derived using the point (easting[n],northing[n]).

getElevation

public float getElevation(WorldPt pt)

Description copied from interface: ElevationMap

Returns the elevation at the given World point. If there is no elvation defined, the the "No Data Value" is returned.

Specified by:

getElevation in interface ElevationMap

buildSegment

protected SegmentData buildSegment()

returnSegment

protected void returnSegment(SegmentData sd)

returnSegment

protected void returnSegment(SegmentInfo si)

loadArea

public ArrayList loadArea(WorldRect area,
 Observer observer)

getEndOfHeader

public long getEndOfHeader()

getResolutions

public List getResolutions()

unload

public void unload()

Description copied from interface: MapObjectInterface

Method to tell the Map Object to unload, because the map is done

Specified by:

unload in interface MapObjectInterface

Specified by:

unload in class MapObject

load

public void load()
          throws IOException

Split the load between binary and ASCII

Specified by:

load in interface MapObjectInterface

Specified by:

load in class MapObject

Throws:

IOException - Description of Exception

readHeader

protected void readHeader(HecFile file)
                   throws IOException

Throws:

IOException

writeHeader

protected void writeHeader(HecFile file)
                    throws IOException

Throws:

IOException

writeHeader

protected void writeHeader(DataOutputStream out)
                    throws IOException

Throws:

IOException

importMap

public static RasterMap importMap(RasterImportProgressIndicator progress,
 FileOpener fileOpener,
 int typeOfData,
 AiDemBaseMap map)
                           throws IOException

Throws:

IOException

importMap

public static RasterMap importMap(RasterImportProgressIndicator progress,
 Identifier smrmpId,
 String mapName,
 int dataType,
 String[] params,
 String[] units,
 AiDemBaseMap[] maps)
                           throws IOException

Throws:

IOException

getLowerLeftCorner

public WorldPt getLowerLeftCorner()

Returns: