Index (Svm 2.1.8 API)

A B C D E F G I L M O P R S T V W
All Classes All Packages

A

accept(LasPoint) - Method in class org.tinfour.svm.SvmLasFilter
addSoundings(List<Vertex>) - Method in class org.tinfour.svm.SvmBathymetryData: Append additional soundings to the soundings collection.
areAllRecordsAccepted() - Method in class org.tinfour.svm.SvmLasFilter: Indicates that the filter will accept all records except those that are explicitly marked as withheld.

B

BATHYMETRY_SOURCE - Static variable in class org.tinfour.svm.SvmBathymetryData: Used to set an auxiliary value for a vertex indicating that it is original data from a bathymetry data source.

C

close() - Method in class org.tinfour.svm.SvmShapefileVertexReader

D

Depth - org.tinfour.svm.SvmBathymetryModel: Soundings are specified as depth given as either uniformly positive or uniformly negative numbers indicating depths below the surface.
doesLocaleUseCommaForDecimal() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the Locale uses the comma character for the decimal part of floating-point values.

E

Elevation - org.tinfour.svm.SvmBathymetryModel: Soundings are specified as elevations referenced to to the vertical datum used by the source data, usually Mean Sea Level (MSL).

F

FLAT_ADJUSTMENT - Static variable in class org.tinfour.svm.SvmBathymetryData: Used to set an auxiliary value for a vertex indicating that it is a modeled data point used to adjust flat areas.

G

getAnomalyTableFile() - Method in class org.tinfour.svm.properties.SvmProperties: Get the path to a file for writing a table reporting anomalies.
getBathymetryModel() - Method in class org.tinfour.svm.properties.SvmProperties: Gets the bathymetry model specified for the soundings.
getBathymetryModel() - Method in class org.tinfour.svm.SvmBathymetryData: Gets the bathymetry defined for the soundings in this instances.
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 the 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
getContourGraphSmoothingFactor(int) - Method in class org.tinfour.svm.properties.SvmProperties: Gets the smoothing factor for constructing contours.
getContourLineShapefile() - Method in class org.tinfour.svm.properties.SvmProperties: Get the path to a file for writing contour region Shapefile showing a contour plot of the reservoir data.
getContourRegionShapefile() - Method in class org.tinfour.svm.properties.SvmProperties: Get the path to a file for writing contour region Shapefile showing a contour plot of the reservoir data.
getCoordinateTransform() - Method in class org.tinfour.svm.SvmShapefileVertexReader
getDrawdownGraphDimensions() - Method in class org.tinfour.svm.properties.SvmProperties: Get the dimensions for the drawdown graph image file.
getDrawdownGraphFile() - Method in class org.tinfour.svm.properties.SvmProperties: Get the path to a file for writing a graph of the drawdown as a function of water level.
getDrawdownGraphTitle() - Method in class org.tinfour.svm.properties.SvmProperties: Gets the title for the drawdown graph image
getExperimentalFilterFile() - Method in class org.tinfour.svm.properties.SvmProperties: Get the path to a file for writing the output from an experimental filter.
getExperimentalFilterSlopeOfAnomaly(double) - Method in class org.tinfour.svm.properties.SvmProperties
getExperimentalFilterSlopeOfSupport(double) - Method in class org.tinfour.svm.properties.SvmProperties
getExplicitLocale() - Method in class org.tinfour.svm.properties.SvmProperties: Gets the explicit value for the locale, if it was set.
getField() - Method in class org.tinfour.svm.properties.SvmFileSpecification: Get the named data field String from the specification (if supplied) or the LAS/LAZ filter specification (if supplied).
getFile() - Method in class org.tinfour.svm.properties.SvmFileSpecification: Get the file reference from the specification
getGeoTiffFile() - Method in class org.tinfour.svm.properties.SvmProperties: Gets the path to a file for writing an output GeoTIFF file containing the interpolated grid of water bottom elevations.
getGeoTiffNoDataCode() - Method in class org.tinfour.svm.properties.SvmProperties: Gets a string to be used for the GDAL No-Data element.
getGeoTiffProjectionCode() - Method in class org.tinfour.svm.properties.SvmProperties: Gets the specified GeoTIFF projection code, if any.
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 data file giving an interpolated grid of water bottom elevations.
getGridFile(String) - Method in class org.tinfour.svm.properties.SvmProperties: Get the path to a file for writing an output file to be used for processing raster grid.
getGridImageFile() - Method in class org.tinfour.svm.properties.SvmProperties: Get the path to a file for writing an output image file giving an interpolated grid of water bottom elevations.
getHorizontalTransform() - Method in class org.tinfour.svm.properties.SvmProperties: Gets a horizontal coordinate scaling transform.
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
getLasFilter() - Method in class org.tinfour.svm.properties.SvmFileSpecification: Gets a data filter specification if provided for for LAS or LAZ files
getLinearConstraints() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the list of constraints that were collected during the most recent read operation.
getLinearUnits() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the linear units for the horizontal coordinate system from the shapefile.
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
getShapefilePrjContent() - Method in class org.tinfour.svm.SvmBathymetryData: Gets the content of the PRJ file associated with the input.
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.
getSupplementalConstraintsFile() - Method in class org.tinfour.svm.properties.SvmProperties: Get a reference to a supplemental shapefile providing constraints for SVM processing.
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.
getSurveyPerimeter() - Method in class org.tinfour.svm.SvmBathymetryData: Gets the survey perimeter.
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.
getTimeForLoad() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the total time to load a file (including the time required for pre-sort if enabled).
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)
getVertices() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the list of vertices that were collected during the most recent read operation.
getXMax() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the maximum x coordinate in the sample
getXMin() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the minimum x coordinate in the sample
getYMax() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the maximum y coordinate in the sample
getYMin() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the minimum y coordinate in the sample
getZMax() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the maximum z coordinate in the sample
getZMin() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Gets the minimum z coordinate in the sample

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.
isBathymetryModelSpecified() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the source data includes a bathymetry model specification.
isCapacityGraphEnabled() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the capacity graph function is enabled
isContourShapefileShorelineEnabled() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the optional shoreline append operation is enabled.
isDepth() - Method in enum org.tinfour.svm.SvmBathymetryModel: Indicates whether the model represents depth values (as opposed to elevation).
isDrawdownGraphEnabled() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the drawdown graph function is enabled
isExperimentalFilterEnabled() - Method in class org.tinfour.svm.properties.SvmProperties
isFlatFixerEnabled() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the near-shore, flat-triangle remediation is enabled.
isGeoTiffDataCompressionEnabled() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether data compression is enabled for GeoTIFF data.
isGeoTiffNoDataCodeSpecified() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the properties file specifies a no-data code.
isGeoTiffProjectionCodeSpecified() - Method in class org.tinfour.svm.properties.SvmProperties: Indicates whether the source properties includes a specification for the GeoTiff Projection code (usually an EPSG projection code).
isSourceInGeographicCoordinates() - Method in class org.tinfour.svm.SvmShapefileVertexReader: Indicates whether the source data was in geographic coordinates

L

lenientValueOf(String) - Static method in enum org.tinfour.svm.SvmBathymetryModel: Return the value indicated by the string or a null if the string is empty of does not include a recognizable value.
load(File) - Method in class org.tinfour.svm.properties.SvmProperties: Loads a properties instance using values and paths specified in the indicated file.
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.
loadBoundaryConstraints(File, String, IVerticalCoordinateTransform, ICoordinateTransform) - Method in class org.tinfour.svm.SvmBathymetryData: Load main set of polygon constraints defining the boundary of the body of water.
loadSamples(File, String, IVerticalCoordinateTransform, ICoordinateTransform) - Method in class org.tinfour.svm.SvmBathymetryData: Load main set of soundings from a file.
loadSupplement(File, String, IVerticalCoordinateTransform, ICoordinateTransform) - 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.

R

read(IMonitorWithCancellation) - Method in class org.tinfour.svm.SvmShapefileVertexReader: Read the records from the shapefile and use them to populate vertices.

S

setCoordinateTransform(ICoordinateTransform) - Method in class org.tinfour.svm.SvmShapefileVertexReader
setDbfFieldForZ(String) - Method in class org.tinfour.svm.SvmShapefileVertexReader: Sets the name of the field in the DBF file to use as a source for Z coordinates for data.
setSurveyPerimeter(List<Vertex>) - Method in class org.tinfour.svm.SvmBathymetryData: Provides a means for the model to attach the perimeter of the triangulation (its convex hull) to the data collection.
setVerticalCoordinateTransform(IVerticalCoordinateTransform) - Method in class org.tinfour.svm.SvmShapefileVertexReader: Sets the vertical coordinate transform to be used when reading the file (if any).
SUPPLEMENTAL_SOURCE - Static variable in class org.tinfour.svm.SvmBathymetryData: Used to set an auxiliary value for a vertex indicating that it is data obtained from a supplemental source.
SvmBathymetryData - Class in org.tinfour.svm: A class for loading bathymetry and shoreline data to be used for estimating lake volume.
SvmBathymetryData(SvmBathymetryModel) - Constructor for class org.tinfour.svm.SvmBathymetryData: Constructs an instance to load and store bathymetry data.
SvmBathymetryModel - Enum in org.tinfour.svm: Indicates the form in which the bathymetry data was specified.
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
SvmLasFilter - Class in org.tinfour.svm: Implements logic for filtering sample points from LAS/LAZ files when they are used for the Simple Volumetric Model (SVM).
SvmLasFilter() - Constructor for class org.tinfour.svm.SvmLasFilter: Construct a filter that accepts all records except those that are explicitly marked as withheld.
SvmLasFilter(String) - Constructor for class org.tinfour.svm.SvmLasFilter: Construct a filter and optionally apply the rules specified in the input string.
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
SvmShapefileVertexReader - Class in org.tinfour.svm: A utility for loading vertices from a file for testing
SvmShapefileVertexReader(File) - Constructor for class org.tinfour.svm.SvmShapefileVertexReader: Construct an instance for the specified Shapefile
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

V

valueOf(String) - Static method in enum org.tinfour.svm.SvmBathymetryModel: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.tinfour.svm.SvmBathymetryModel: Returns an array containing the constants of this enum type, in the order they are declared.

W

writeSummary(PrintStream) - Method in class org.tinfour.svm.properties.SvmProperties: Writes summary data to the specified PrintStream instance.

A B C D E F G I L M O P R S T V W
All Classes All Packages