org.tinfour.demo.examples.lake

Class BathymetryData

java.lang.Object

org.tinfour.demo.examples.lake.BathymetryData

public class BathymetryData
extends Object

A class for loading bathymetry and shoreline data to be used for estimating lake volume.

Constructor Summary

Constructors

Constructor and Description
BathymetryData(File inputSoundingsFile, File inputShorelineFile, File inputIslandFile, String dbfBathymetryField) Load the test data from the specified files

Method Summary

Modifier and Type	Method and Description
Rectangle2D	getBounds() Get the overall bounds of the sounding and constraint data
List<PolygonConstraint>	getIslandConstraints() Get the island constraints
List<PolygonConstraint>	getLakeConstraints() Get the shoreline constraints
double	getMaxZ() Get the maximum sounding value in the source data
double	getMeanZ() Get the mean of the sounding values in the source data
double	getMinZ() Get the minimum sounding value in the source data
double	getNominalPointSpacing() Gets the nominal spacing for the data set.
List<Vertex>	getReducedListOfSoundings(int nTarget) Get a reduced list of the soundings.
Rectangle2D	getSoundingBounds() Get the bounds of the sounding data
List<Vertex>	getSoundings() Get a list of the soundings.
long	getTimeToLoadData() Gets the time required to load the input data
void	printSummary(PrintStream ps) Print a summary of the input data.

Methods inherited from class java.lang.Object

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

Constructor Detail

BathymetryData

public BathymetryData(File inputSoundingsFile,
                      File inputShorelineFile,
                      File inputIslandFile,
                      String dbfBathymetryField)
               throws IOException

Load the test data from the specified files

The input soundings file may be a CSV file or a Shapefile. If the file is a Shapefile, there are two options for obtaining the depth coordinate. The depth coordinate may be taken from the z coordinates for each Shapefile point (if supplied) or they may be taken from a named field in the DBF file. If the dbfBathymetryField string is null, then the Z coordinate will be used. Otherwise, this class will use the named field.

Parameters:

inputSoundingsFile - a mandatory path for a CSV file giving soundings

inputShorelineFile - a mandatory path for a Shapefile file giving soundings

inputIslandFile - an optional path for a Shapefile file giving soundings

dbfBathymetryField - an option field used when the inputSoundingsFile is a Shapefile indicating DBF field of interest.

Throws:

IOException - in the event of an unrecoverable I/O condition

Method Detail

getMinZ

public double getMinZ()

Get the minimum sounding value in the source data

Returns:

the minimum sounding value

getMaxZ

public double getMaxZ()

Get the maximum sounding value in the source data

Returns:

the maximum sounding value

getMeanZ

public double getMeanZ()

Get the mean of the sounding values in the source data

Returns:

the mean sounding value

getNominalPointSpacing

public double getNominalPointSpacing()

Gets the nominal spacing for the data set.

Returns:

a positive floating point value

getSoundings

public List<Vertex> getSoundings()

Get a list of the soundings.

Returns:

the soundings

getReducedListOfSoundings

public List<Vertex> getReducedListOfSoundings(int nTarget)

Get a reduced list of the soundings.

Parameters:

nTarget - the target number of soundings for the list

Returns:

the soundings

getLakeConstraints

public List<PolygonConstraint> getLakeConstraints()

Get the shoreline constraints

Returns:

a valid, potentially empty, list.

getIslandConstraints

public List<PolygonConstraint> getIslandConstraints()

Get the island constraints

Returns:

a valid, potentially empty, list.

getSoundingBounds

public Rectangle2D getSoundingBounds()

Get the bounds of the sounding data

Returns:

a safe copy of a valid, non-empty rectangle.

getBounds

public Rectangle2D getBounds()

Get the overall bounds of the sounding and constraint data

Returns:

a safe copy of a valid, non-empty rectangle.

getTimeToLoadData

public long getTimeToLoadData()

Gets the time required to load the input data

Returns:

a valid time in nanoseconds\

printSummary

public void printSummary(PrintStream ps)

Print a summary of the input data.

Parameters:

ps - a valid print stream such as system output.