G I L M O P S T W

G

getBoundaryConstraints() - Method in class org.tinfour.svm.SvmBathymetryData

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

getBoundarySpecifications() - Method in class org.tinfour.svm.properties.SvmProperties

Get a list of the SVM file specifications for teh polygon bounding constraints of the body of water.

getBounds() - Method in class org.tinfour.svm.SvmBathymetryData

Get the overall bounds of the sounding and constraint data

getCapacityGraphDimensions() - Method in class org.tinfour.svm.properties.SvmProperties

Get the dimensions for the capacity graph image file.

getCapacityGraphFile() - Method in class org.tinfour.svm.properties.SvmProperties

Get the path to a file for writing a graph of the capacity as a function of water level.

getCapacityGraphTitle() - Method in class org.tinfour.svm.properties.SvmProperties

Gets the title for the capacity graph image

getContourGraphDimensions() - Method in class org.tinfour.svm.properties.SvmProperties

Get the dimensions for the contour graph image file.

getContourGraphFile() - Method in class org.tinfour.svm.properties.SvmProperties

Get the path to a file for writing an image file showing a contour plot of the reservoir data.

getContourGraphInterval() - Method in class org.tinfour.svm.properties.SvmProperties

Gets the contour graph interval

getContourGraphLegendText() - Method in class org.tinfour.svm.properties.SvmProperties

Gets the title for the capacity graph image

getField() - Method in class org.tinfour.svm.properties.SvmFileSpecification

Get the named data field String from the specification (if supplied)

getFile() - Method in class org.tinfour.svm.properties.SvmFileSpecification

Get the file reference from the specification

getGridCellSize() - Method in class org.tinfour.svm.properties.SvmProperties

Get the grid cell size, if provided.

getGridFile() - Method in class org.tinfour.svm.properties.SvmProperties

Get the path to a file for writing an output ASC file giving an interpolated grid of water bottom elevations.

getInputFolder() - Method in class org.tinfour.svm.properties.SvmProperties

Gets the input folder specification from the properties; if the properties do not contain a key/value for inputFolder, a null is returned.

getIslandConstraints() - Method in class org.tinfour.svm.SvmBathymetryData

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

getLabel() - Method in class org.tinfour.svm.properties.SvmUnitSpecification

Get the name of the unit

getLakeConstraints() - Method in class org.tinfour.svm.SvmBathymetryData

Gets a list of those constraints which enclose the data area

getMaxZ() - Method in class org.tinfour.svm.SvmBathymetryData

Get the maximum sounding value in the source data

getMeanZ() - Method in class org.tinfour.svm.SvmBathymetryData

Get the mean of the sounding values in the source data

getMinZ() - Method in class org.tinfour.svm.SvmBathymetryData

Get the minimum sounding value in the source data

getNominalPointSpacing() - Method in class org.tinfour.svm.SvmBathymetryData

Gets the nominal spacing for the data set.

getOutputFolder() - Method in class org.tinfour.svm.properties.SvmProperties

Gets the output folder specification from the properties; if the properties do not contain a key/value for outputFolder, a null is returned.

getReducedListOfSoundings(int) - Method in class org.tinfour.svm.SvmBathymetryData

Get a reduced list of the soundings.

getReportFile() - Method in class org.tinfour.svm.properties.SvmProperties

Get the path to a file for writing an output report giving a record of the computation parameters and results used for running the Simple Volumetric Model.

getSampleSpecifications() - Method in class org.tinfour.svm.properties.SvmProperties

Get a list of the SVM file specifications for input samples.

getScaleFactor() - Method in class org.tinfour.svm.properties.SvmUnitSpecification

Get a scaling factor for the unit of measure

getShorelineReferenceElevation() - Method in class org.tinfour.svm.properties.SvmProperties

Get the shoreline reference elevation, if provided.

getShoreReferenceElevation() - Method in class org.tinfour.svm.SvmBathymetryData

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

getSoundingBounds() - Method in class org.tinfour.svm.SvmBathymetryData

Get the bounds of the sounding data

getSoundings() - Method in class org.tinfour.svm.SvmBathymetryData

Get a list of the soundings.

getSoundingsAndSupplements() - Method in class org.tinfour.svm.SvmBathymetryData

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

getSupplements() - Method in class org.tinfour.svm.SvmBathymetryData

Gets a list of supplementary samples.

getSupplementSpecifications() - Method in class org.tinfour.svm.properties.SvmProperties

Get a list of the SVM file specifications for supplemental samples.

getTableFile() - Method in class org.tinfour.svm.properties.SvmProperties

Get the path to a file for writing an output table giving volume and elevation at fixed intervals (specified by getTableInterval()).

getTableInterval() - Method in class org.tinfour.svm.properties.SvmProperties

Get the interval for computing a series of surface elevation values to be used for modeling.

getTimeToLoadData() - Method in class org.tinfour.svm.SvmBathymetryData

Gets the time required to load the input data

getUnitOfArea() - Method in class org.tinfour.svm.properties.SvmProperties

Get the a description and potential conversion factor unit to be used for specifying surface area.

getUnitOfDistance() - Method in class org.tinfour.svm.properties.SvmProperties

Get the a description and potential conversion factor unit to be used for specifying horizontal and vertical distances.

getUnitOfVolume() - Method in class org.tinfour.svm.properties.SvmProperties

Get the a description and potential conversion factor unit to be used for specifying volume.

getVerticalTransform() - Method in class org.tinfour.svm.properties.SvmFileSpecification

Get the vertical coordinate transform from the specification (if supplied)

I

indexArg(String[], String, boolean) - Static method in class org.tinfour.svm.properties.SvmProperties

Checks to see if an argument list includes the specified target and returns its index within the argument array.

isFlatFixerEnabled() - Method in class org.tinfour.svm.properties.SvmProperties

Indicates whether the near-shore, flat-triangle remediation is enabled.

isSoundingSpacingEnabled() - Method in class org.tinfour.svm.properties.SvmProperties

Indicates whether the computation of sounding spacing is enabled.

L

load(String[]) - Static method in class org.tinfour.svm.properties.SvmProperties

Loads a properties instance using values and paths specified through the command-line arguments.

load(File) - Method in class org.tinfour.svm.properties.SvmProperties

Loads a properties instance using values and paths specified in the indicated file.

loadBoundaryConstraints(File, String, IVerticalCoordinateTransform) - Method in class org.tinfour.svm.SvmBathymetryData

Load main set of polygon contraints defining the boundary of the body of water.

loadSamples(File, String, IVerticalCoordinateTransform) - Method in class org.tinfour.svm.SvmBathymetryData

Load main set of soundings from a file.

loadSupplement(File, String, IVerticalCoordinateTransform) - Method in class org.tinfour.svm.SvmBathymetryData

Load supplemental soundings from a file.

M

main(String[]) - Static method in class org.tinfour.svm.SvmMain

The main method for running the Simple Volumetric Model (SVM).

O

org.tinfour.svm - package org.tinfour.svm

Provides classes, interfaces, and resources for the Tinfour Simple Volumetric Model (SVM) for estimating reservoir water volume and surface area.

org.tinfour.svm.properties - package org.tinfour.svm.properties

Provides classes in support of the problem specification for an SVM Analysis.

P

printSummary(PrintStream) - Method in class org.tinfour.svm.SvmBathymetryData

Print a summary of the input data.

processVolume(PrintStream, SvmProperties, SvmBathymetryData) - Method in class org.tinfour.svm.SvmComputation

Performs the main process, printing the results to the specified print stream.

S

SvmBathymetryData - Class in org.tinfour.svm

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

SvmBathymetryData() - Constructor for class org.tinfour.svm.SvmBathymetryData

Standard constructor

SvmComputation - Class in org.tinfour.svm

Provide logic and elements for performing a volume computation for the specified input data.

SvmComputation() - Constructor for class org.tinfour.svm.SvmComputation

SvmFileSpecification - Class in org.tinfour.svm.properties

SvmMain - Class in org.tinfour.svm

Provides the main method for running the Simple Volumetric Model (SVM).

SvmProperties - Class in org.tinfour.svm.properties

Provides parameter and resource specifications for a SVM analysis run.

SvmProperties() - Constructor for class org.tinfour.svm.properties.SvmProperties

Standard constructor

SvmUnitSpecification - Class in org.tinfour.svm.properties

Specifies a unit of measure and associated scaling factor

T

toString() - Method in class org.tinfour.svm.properties.SvmFileSpecification

toString() - Method in class org.tinfour.svm.properties.SvmUnitSpecification

W

writeSummary(PrintStream) - Method in class org.tinfour.svm.properties.SvmProperties

Writes summary data to the specified PrintStream instance.

G I L M O P S T W