SvmProperties (Svm 2.1.2 API)

java.lang.Object
- org.tinfour.svm.properties.SvmProperties

```
public class SvmProperties
extends Object
```
Provides parameter and resource specifications for a SVM analysis run.

Constructor Summary

Constructors
Constructor and Description

SvmProperties()
Standard constructor

Constructors
Constructor and Description
`SvmProperties()` Standard constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<SvmFileSpecification>`	`getBoundarySpecifications()` Get a list of the SVM file specifications for teh polygon bounding constraints of the body of water.
`Dimension`	`getCapacityGraphDimensions()` Get the dimensions for the capacity graph image file.
`File`	`getCapacityGraphFile()` Get the path to a file for writing a graph of the capacity as a function of water level.
`String`	`getCapacityGraphTitle()` Gets the title for the capacity graph image
`Dimension`	`getContourGraphDimensions()` Get the dimensions for the contour graph image file.
`File`	`getContourGraphFile()` Get the path to a file for writing an image file showing a contour plot of the reservoir data.
`String`	`getContourGraphLegendText()` Gets the title for the capacity graph image
`double`	`getGridCellSize()` Get the grid cell size, if provided.
`File`	`getGridFile()` Get the path to a file for writing an output ASC file giving an interpolated grid of water bottom elevations.
`File`	`getInputFolder()` Gets the input folder specification from the properties; if the properties do not contain a key/value for inputFolder, a null is returned.
`File`	`getOutputFolder()` Gets the output folder specification from the properties; if the properties do not contain a key/value for outputFolder, a null is returned.
`File`	`getReportFile()` 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.
`List<SvmFileSpecification>`	`getSampleSpecifications()` Get a list of the SVM file specifications for input samples.
`double`	`getShorelineReferenceElevation()` Get the shoreline reference elevation, if provided.
`List<SvmFileSpecification>`	`getSupplementSpecifications()` Get a list of the SVM file specifications for supplemental samples.
`File`	`getTableFile()` Get the path to a file for writing an output table giving volume and elevation at fixed intervals (specified by getTableInterval()).
`double`	`getTableInterval()` Get the interval for computing a series of surface elevation values to be used for modeling.
`SvmUnitSpecification`	`getUnitOfArea()` Get the a description and potential conversion factor unit to be used for specifying surface area.
`SvmUnitSpecification`	`getUnitOfDistance()` Get the a description and potential conversion factor unit to be used for specifying horizontal and vertical distances.
`SvmUnitSpecification`	`getUnitOfVolume()` Get the a description and potential conversion factor unit to be used for specifying volume.
`static int`	`indexArg(String[] args, String target, boolean valueRequired)` Checks to see if an argument list includes the specified target and returns its index within the argument array.
`boolean`	`isFlatFixerEnabled()` Indicates whether the near-shore, flat-triangle remediation is enabled.
`boolean`	`isSoundingSpacingEnabled()` Indicates whether the computation of sounding spacing is enabled.
`void`	`load(File file)` Loads a properties instance using values and paths specified in the indicated file.
`static SvmProperties`	`load(String[] args)` Loads a properties instance using values and paths specified through the command-line arguments.
`void`	`writeSummary(PrintStream ps)` Writes summary data to the specified PrintStream instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SvmProperties
```
public SvmProperties()
```
    Standard constructor
- Method Detail
  - indexArg
```
public static int indexArg(String[] args,
                           String target,
                           boolean valueRequired)
```
    Checks to see if an argument list includes the specified target and returns its index within the argument array.
    
    Parameters:
    
    args - a valid list of strings
    
    target - the desired target string
    
    valueRequired - indicates that the target argument requires a value specification.
    
    Returns:
    
    if found, a value of zero or greater; otherwise, -1.
  - load
```
public static SvmProperties load(String[] args)
                          throws IOException
```
    Loads a properties instance using values and paths specified through the command-line arguments.
    
    Parameters:
    
    args - a valid, potentially zero-length array of strings
    
    Returns:
    
    if successful, a populated instance
    
    Throws:
    
    IOException - in the event of a unrecoverable I/O condition.
  - load
```
public void load(File file)
          throws IOException
```
    Loads a properties instance using values and paths specified in the indicated file.
    
    Parameters:
    
    file - a valid file instance
    
    Throws:
    
    IOException - in the event of an unrecoverable I/O condition.
  - getSampleSpecifications
```
public List<SvmFileSpecification> getSampleSpecifications()
```
    Get a list of the SVM file specifications for input samples. The SvmFileSpecification may include metadata such as DBF file field name and unit conversion values.
    
    Returns:
    
    a valid, potentially empty list
  - getSupplementSpecifications
```
public List<SvmFileSpecification> getSupplementSpecifications()
```
    Get a list of the SVM file specifications for supplemental samples. Typically these are samples derived for shallow-water areas. The SvmFileSpecification may include metadata such as DBF file field name and unit conversion values.
    
    Returns:
    
    a valid, potentially empty list
  - getBoundarySpecifications
```
public List<SvmFileSpecification> getBoundarySpecifications()
```
    Get a list of the SVM file specifications for teh polygon bounding constraints of the body of water. The SvmFileSpecification may include metadata such as DBF file field name and unit conversion values.
    
    Returns:
    
    a valid, potentially empty list
  - getUnitOfDistance
```
public SvmUnitSpecification getUnitOfDistance()
```
    Get the a description and potential conversion factor unit to be used for specifying horizontal and vertical distances. Note that the SVM model assumes uniform metrics in all directions.
    
    Returns:
    
    a valid unit of distance instance.
  - getInputFolder
```
public File getInputFolder()
```
    Gets the input folder specification from the properties; if the properties do not contain a key/value for inputFolder, a null is returned.
    
    Returns:
    
    a valid instance; or a null if a folder is not specified.
  - getOutputFolder
```
public File getOutputFolder()
```
    Gets the output folder specification from the properties; if the properties do not contain a key/value for outputFolder, a null is returned.
    
    Returns:
    
    a valid instance; or a null if a folder is not specified.
  - getReportFile
```
public File getReportFile()
```
    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. If not specified, a null value is returned and it is assumed that the report should be written to standard output.
    
    Returns:
    
    a valid File instance or a null if not specified.
  - getTableFile
```
public File getTableFile()
```
    Get the path to a file for writing an output table giving volume and elevation at fixed intervals (specified by getTableInterval()). If not specified, a null value is returned and it is assumed that the table should be written to standard output.
    
    Returns:
    
    a valid File instance or a null if not specified.
  - getTableInterval
```
public double getTableInterval()
```
    Get the interval for computing a series of surface elevation values to be used for modeling. By default, the value for this specification is 1 unit (1 foot, 1 meter, etc.), but fractional values are allowed.
    
    Returns:
    
    a floating point value greater than 0.
  - isFlatFixerEnabled
```
public boolean isFlatFixerEnabled()
```
    Indicates whether the near-shore, flat-triangle remediation is enabled.
    
    Returns:
    
    true if remediation is to be performed; otherwise, false.
  - isSoundingSpacingEnabled
```
public boolean isSoundingSpacingEnabled()
```
    Indicates whether the computation of sounding spacing is enabled.
    
    Returns:
    
    true if computation is to be performed; otherwise, false.
  - writeSummary
```
public void writeSummary(PrintStream ps)
```
    Writes summary data to the specified PrintStream instance. Note that the input to this method is often, but not always, System.out.
    
    Parameters:
    
    ps - a valid instance
  - getUnitOfArea
```
public SvmUnitSpecification getUnitOfArea()
```
    Get the a description and potential conversion factor unit to be used for specifying surface area.
    
    Returns:
    
    a valid unit specification instance.
  - getUnitOfVolume
```
public SvmUnitSpecification getUnitOfVolume()
```
    Get the a description and potential conversion factor unit to be used for specifying volume.
    
    Returns:
    
    a valid unit specification instance.
  - getShorelineReferenceElevation
```
public double getShorelineReferenceElevation()
```
    Get the shoreline reference elevation, if provided.
    
    Returns:
    
    a valid floating point number or a NaN if undefined
  - getGridCellSize
```
public double getGridCellSize()
```
    Get the grid cell size, if provided.
    
    Returns:
    
    a valid floating point number or a NaN if undefined
  - getGridFile
```
public File getGridFile()
```
    Get the path to a file for writing an output ASC file giving an interpolated grid of water bottom elevations.
    
    Returns:
    
    a valid File instance or a null if not specified.
  - getCapacityGraphFile
```
public File getCapacityGraphFile()
```
    Get the path to a file for writing a graph of the capacity as a function of water level. .
    
    Returns:
    
    a valid File instance or a null if not specified.
  - getCapacityGraphDimensions
```
public Dimension getCapacityGraphDimensions()
```
    Get the dimensions for the capacity graph image file.
    
    Returns:
    
    a valid instance of non-trivial size.
  - getCapacityGraphTitle
```
public String getCapacityGraphTitle()
```
    Gets the title for the capacity graph image
    
    Returns:
    
    if defined, a valid non-empty string instance; if undefined, a null.
  - getContourGraphFile
```
public File getContourGraphFile()
```
    Get the path to a file for writing an image file showing a contour plot of the reservoir data.
    
    Returns:
    
    a valid File instance or a null if not specified.
  - getContourGraphDimensions
```
public Dimension getContourGraphDimensions()
```
    Get the dimensions for the contour graph image file.
    
    Returns:
    
    a valid instance of non-trivial size.
  - getContourGraphLegendText
```
public String getContourGraphLegendText()
```
    Gets the title for the capacity graph image
    
    Returns:
    
    if defined, a valid non-empty string instance; if undefined, a null.

Class SvmProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SvmProperties

Method Detail

indexArg

load

load

getSampleSpecifications

getSupplementSpecifications

getBoundarySpecifications

getUnitOfDistance

getInputFolder

getOutputFolder

getReportFile

getTableFile

getTableInterval

isFlatFixerEnabled

isSoundingSpacingEnabled

writeSummary

getUnitOfArea

getUnitOfVolume

getShorelineReferenceElevation

getGridCellSize

getGridFile

getCapacityGraphFile

getCapacityGraphDimensions

getCapacityGraphTitle

getContourGraphFile

getContourGraphDimensions

getContourGraphLegendText