org.tinfour.svm

Class SvmBathymetryData

java.lang.Object

org.tinfour.svm.SvmBathymetryData

public class SvmBathymetryData
extends Object

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

Constructor Summary

Constructors

Constructor and Description
SvmBathymetryData() Standard constructor

Method Summary

Modifier and Type	Method and Description
List<PolygonConstraint>	getBoundaryConstraints() Gets a list of constraints defining the boundary of the body of water to be analyzed.
Rectangle2D	getBounds() Get the overall bounds of the sounding and constraint data
List<PolygonConstraint>	getIslandConstraints() Gets a list of those constraints which enclose island areas (non data areas)
List<PolygonConstraint>	getLakeConstraints() Gets a list of those constraints which enclose the data area
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.
double	getShoreReferenceElevation() Get the reference elevation for the shoreline (conservation pool elevation)
Rectangle2D	getSoundingBounds() Get the bounds of the sounding data
List<Vertex>	getSoundings() Get a list of the soundings.
List<Vertex>	getSoundingsAndSupplements() Gets all bathymetry sounding data, including both the main soundings list and any supplemental data that was loaded.
List<Vertex>	getSupplements() Gets a list of supplementary samples.
long	getTimeToLoadData() Gets the time required to load the input data
void	loadBoundaryConstraints(File inputBoundaryFile, String dbfFieldForZ, IVerticalCoordinateTransform verticalTransform) Load main set of polygon contraints defining the boundary of the body of water.
void	loadSamples(File inputSoundingsFile, String dbfBathymetryField, IVerticalCoordinateTransform verticalTransform) Load main set of soundings from a file.
void	loadSupplement(File inputSupplementFile, String dbfBathymetryField, IVerticalCoordinateTransform verticalTransform) Load supplemental soundings from a file.
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

SvmBathymetryData

public SvmBathymetryData()

Standard constructor

Method Detail

loadSamples

public void loadSamples(File inputSoundingsFile,
                        String dbfBathymetryField,
                        IVerticalCoordinateTransform verticalTransform)
                 throws IOException

Load main set of soundings from a file. This process is incremental and any new soundings will be added to the list of those already loaded.

Parameters:

inputSoundingsFile - the input file giving soundings.

dbfBathymetryField - the optional string giving the name of the DBF field to be used to extracting data from the input file (used for Shapefiles).

verticalTransform - the optional\transform used to map vertical coordinates to a new value; or null if no transform is to be applied.

Throws:

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

loadSupplement

public void loadSupplement(File inputSupplementFile,
                           String dbfBathymetryField,
                           IVerticalCoordinateTransform verticalTransform)
                    throws IOException

Load supplemental soundings from a file. This process is incremental and any new soundings will be added to the list of those already loaded.

Parameters:

inputSupplementFile - the input file giving soundings.

dbfBathymetryField - the optional string giving the name of the DBF field to be used to extracting data.

verticalTransform - the optional\transform used to map vertical coordinates to a new value; or null if no transform is to be applied.

Throws:

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

loadBoundaryConstraints

public void loadBoundaryConstraints(File inputBoundaryFile,
                                    String dbfFieldForZ,
                                    IVerticalCoordinateTransform verticalTransform)
                             throws IOException

Load main set of polygon contraints defining the boundary of the body of water. This process is incremental and any new constraints will be added to the list of those already loaded.

Parameters:

inputBoundaryFile - the input file giving constraints.

dbfFieldForZ - the optional string giving the name of the DBF field to be used to extracting data from the input file (used for Shapefiles).

verticalTransform - the optional\transform used to map vertical coordinates to a new value; or null if no transform is to be applied.

Throws:

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

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. The result includes the main set of soundings, but does not include any supplementatal soundings that may have been loaded.

Returns:

the soundings

getSoundingsAndSupplements

public List<Vertex> getSoundingsAndSupplements()

Gets all bathymetry sounding data, including both the main soundings list and any supplemental data that was loaded.

Returns:

a valid list of vertices.

getReducedListOfSoundings

public List<Vertex> getReducedListOfSoundings(int nTarget)

Get a reduced list of the soundings. Intended for diagnostic and rendering purposes.

Parameters:

nTarget - the target number of soundings for the list

Returns:

the soundings

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.

getShoreReferenceElevation

public double getShoreReferenceElevation()

Get the reference elevation for the shoreline (conservation pool elevation)

Returns:

a valid floating point value greater than the vertical coordinate of the set of bathymetry samples to be used for analysis.

getBoundaryConstraints

public List<PolygonConstraint> getBoundaryConstraints()

Gets a list of constraints defining the boundary of the body of water to be analyzed.

Returns:

a valid, potentially empty list

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.

getLakeConstraints

public List<PolygonConstraint> getLakeConstraints()

Gets a list of those constraints which enclose the data area

Returns:

A valid, potentially empty list of polygon constraints oriented in anticlockwise order.

getIslandConstraints

public List<PolygonConstraint> getIslandConstraints()

Gets a list of those constraints which enclose island areas (non data areas)

Returns:

A valid, potentially empty list of polygon constraints oriented in clockwise order.

getSupplements

public List<Vertex> getSupplements()

Gets a list of supplementary samples.

Returns:

A valid, potentially list