org.tinfour.demo.utils

Class TestOptions

java.lang.Object

org.tinfour.demo.utils.TestOptions

public class TestOptions
extends Object

Provides a convenience utility for extracting command-line arguments for running integration tests.

The intent of this class is to provide a uniform treatment of command-line arguments. It also provides a way of discovering command-line arguments that are not recognized by the application. This situation sometimes occurs when the operator makes a typographical error in the specification of arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestOptions.GeoCoordinateOption An enumeration giving options for how an input LAS file with a geographic coordinate system is to be treated.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	BUILT_IN_OPTIONS The options that are recognized and processed by the this class.

Constructor Summary

Constructors

Constructor and Description
TestOptions()

Method Summary

Modifier and Type	Method and Description
boolean[]	argumentScan(String[] args) Scan the argument list, extracting standard arguments.
void	checkForMandatoryOptions(String[] args, String[] options)
void	checkForUnrecognizedArgument(String[] args, boolean[] matched) Performs a check for any arguments that were not matched.
double[]	getClipBounds() Get the clip bounds specified as a sequence of 4 floating-point values giving minX, maxX, minY, maxY.
int	getColumnCount(int defaultCount) Gets the number of columns to be used in applications which process a grid of data values.
File	getConstraintsFile() Gets the constraints file (if specified).
char	getDelimiter() Gets the delimiter character specified in the options.
String	getFileExtension(File file) Gets the extension from the specified file
double[]	getFrame() Get the frame specified as a sequence of 4 floating-point values giving minX, maxX, minY, maxY.
TestOptions.GeoCoordinateOption	getGeoCoordinateOption() Gets the geographic coordinate conversion option, if specified.
File	getInputFile() Gets the input file.
String	getInputFileRootString() Gets the root string for the input file, removing the file-type suffix from the end of the string.
InterpolationMethod	getInterpolationMethod() Gets the interpolation method based on the specified options, default value is NaturalNeighbor;
org.tinfour.interpolation.IInterpolatorOverTin	getInterpolator(org.tinfour.common.IIncrementalTin tin) Constructs an interpolator based on the specified options, default value is NaturalNeighbor.
int	getLidarClass() Gets the target lidar classification for samples to be read from an LAS file.
double	getLidarThinningFactor() Gets a lidar thinning factor used for selecting random subsets of lidar samples from an LAS file.
long	getMaxVertices(long defaultMax) Gets a limit for the number of vertices that are read from a LAS file, intended for use in situations where available memory is limited.
org.tinfour.common.IIncrementalTin	getNewInstanceOfTestTin() Gets a new instance of the class specified via the command-line options by invoking its default constructor.
File	getOutputFile() Gets the output file.
TestPalette	getPalette() Get an instance of a palette for rendering.
long	getRandomSeed(long defaultSeed) Gets a value for a seed to be used for producing a sequence of values using a random-number generator.
int	getRowCount(int defaultCount) Gets the number of rows to be used in applications which process a grid of data values.
int	getTestCount(int defaultCount) Gets the number of tests to be performed by applications which feature repeated tests.
Class<?>	getTinClass() Gets the class specified for the test (default: IncrementalTin)
int	getVertexCount(int defaultCount) Gets the number of points to be used in applications which process a randomly generated list of vertices.
boolean	isClipSet() Indicates whether the clip bounds was specified.
boolean	isFrameSet() Indicates whether the frame was specified.
boolean	isPaletteSet() Indicates whether a palette was specified
boolean	isPreAllocateEnabled(boolean defaultEnabled) Indicates whether edge pre-allocation is enabled.
boolean	isPreSortEnabled(boolean defaultEnabled) Indicates whether the vertex list should be Hilbert sorted before insertion into the TIN.
boolean	isTinClassSet() Indicates whether the options specified a class for the Incremental TIN.
Boolean	scanBooleanOption(String[] args, String option, boolean[] matched, Boolean defaultValue) Scans the argument array to see if it included the specification of a boolean option in the form "-Option" or "-noOption".
double[]	scanBounds(String[] args, String option, boolean[] matched) Scan for an option giving ranges for a rectangular region in the order minX, maxX, minY, maxY.
Double	scanDoubleOption(String[] args, String option, boolean[] matched) Search the arguments for the specified option followed by a floating-point value, marking the matched array if it is found.
Integer	scanIntOption(String[] args, String option, boolean[] matched, Integer defaultValue) Search the arguments for the specified option followed by a integer value, marking the matched array if it is found.
Long	scanLongOption(String[] args, String option, boolean[] matched) Search the arguments for the specified option followed by a long integer value, marking the matched array if it is found.
String	scanStringOption(String[] args, String option, boolean[] matched) Search the arguments for the specified option followed by a string, marking the matched array if it is found.
void	setLidarClass(int classification) Set the default classification for lidar points to be accepted when reading a LAS file.

Methods inherited from class java.lang.Object

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

Field Detail

BUILT_IN_OPTIONS

public static final String[] BUILT_IN_OPTIONS

The options that are recognized and processed by the this class.

Constructor Detail

TestOptions

public TestOptions()

Method Detail

scanIntOption

public Integer scanIntOption(String[] args,
                             String option,
                             boolean[] matched,
                             Integer defaultValue)
                      throws IllegalArgumentException

Search the arguments for the specified option followed by a integer value, marking the matched array if it is found.

Parameters:

args - a valid array of arguments.

option - the target command-line argument (introduced by a dash)

matched - an array parallel to args used to indicate which arguments were identified by the scan operation.

defaultValue - a default value to be returned if the option is not found, or a null if none is supplied.

Returns:

if found, a valid instance of Integer; otherwise, a null.

Throws:

IllegalArgumentException

scanLongOption

public Long scanLongOption(String[] args,
                           String option,
                           boolean[] matched)
                    throws IllegalArgumentException

Search the arguments for the specified option followed by a long integer value, marking the matched array if it is found.

Parameters:

args - a valid array of arguments.

option - the target command-line argument (introduced by a dash)

matched - an array parallel to args used to indicate which arguments were identified by the scan operation.

Returns:

if found, a valid instance of Long; otherwise, a null.

Throws:

IllegalArgumentException

scanDoubleOption

public Double scanDoubleOption(String[] args,
                               String option,
                               boolean[] matched)
                        throws IllegalArgumentException

Search the arguments for the specified option followed by a floating-point value, marking the matched array if it is found.

Parameters:

args - a valid array of arguments.

option - the target command-line argument (introduced by a dash)

matched - an array parallel to args used to indicate which arguments were identified by the scan operation.

Returns:

if found, a valid instance of Double; otherwise, a null.

Throws:

IllegalArgumentException

scanBooleanOption

public Boolean scanBooleanOption(String[] args,
                                 String option,
                                 boolean[] matched,
                                 Boolean defaultValue)

Scans the argument array to see if it included the specification of a boolean option in the form "-Option" or "-noOption". Note that boolean arguments are single strings and do not take a companion argument (such as "true" or "false").

Parameters:

args - a valid array of command-line arguments

option - the target option

matched - an array paralleling args to indicate whether the args matched a search option.

defaultValue - a default value to be returned if the option is not found, or a null if none is supplied.

Returns:

if found, a valid instance of Boolean; otherwise, a null.

scanStringOption

public String scanStringOption(String[] args,
                               String option,
                               boolean[] matched)
                        throws IllegalArgumentException

Search the arguments for the specified option followed by a string, marking the matched array if it is found.

Parameters:

args - a valid array of arguments.

option - the target command-line argument (introduced by a dash)

matched - an array parallel to args used to indicate which arguments were identified by the scan operation.

Returns:

if found, a valid string; otherwise, a null.

Throws:

IllegalArgumentException

scanBounds

public double[] scanBounds(String[] args,
                           String option,
                           boolean[] matched)

Scan for an option giving ranges for a rectangular region in the order minX, maxX, minY, maxY.

Parameters:

args - a valid array of arguments.

option - the target command-line argument (introduced by a dash)

matched - an array parallel to args used to indicate which arguments were identified by the scan operation.

Returns:

if found, a valid array of 4 floating-point values; otherwise, an empty array

getFileExtension

public String getFileExtension(File file)

Gets the extension from the specified file

Parameters:

file - a valid file reference

Returns:

if found, a valid string (period not included); otherwise, a null.

argumentScan

public boolean[] argumentScan(String[] args)

Scan the argument list, extracting standard arguments. A boolean array with a one-to-one correspondence to args[] is returned indicating which arguments were recognized.

Parameters:

args - a valid, potentially zero-length argument list.

Returns:

a boolean array indicating which arguments were recognized.

getInputFile

public File getInputFile()

Gets the input file.

Returns:

if specified, a valid input file; otherwise, a null

getOutputFile

public File getOutputFile()

Gets the output file.

Returns:

if specified, a valid input file; otherwise, a null.

getInputFileRootString

public String getInputFileRootString()

Gets the root string for the input file, removing the file-type suffix from the end of the string. This method is intended for use in applications where the output file has the same root name as the input file, but a different file-type suffix is appended.

Returns:

if the input file is specified, a valid string; otherwise, a null.

getRowCount

public int getRowCount(int defaultCount)

Gets the number of rows to be used in applications which process a grid of data values.

Parameters:

defaultCount - the default number of rows; supply an impossible value if no default is available.

Returns:

if specified, the value from the "-nRows" argument; otherwise, the default.

getColumnCount

public int getColumnCount(int defaultCount)

Gets the number of columns to be used in applications which process a grid of data values.

Parameters:

defaultCount - the default number of columns; supply an impossible value if no default is available.

Returns:

if specified, the value from the "-nColumns" argument; otherwise, the default.

getVertexCount

public int getVertexCount(int defaultCount)

Gets the number of points to be used in applications which process a randomly generated list of vertices.

Parameters:

defaultCount - the default number of vertices; supply an impossible value if no default is available.

Returns:

if specified, the value from the "-nVertices" argument; otherwise, the default.

getTestCount

public int getTestCount(int defaultCount)

Gets the number of tests to be performed by applications which feature repeated tests.

Parameters:

defaultCount - the default number of tests; supply an impossible value if no default is available.

Returns:

if specified, the value from the "-nTest" argument; otherwise, the default.

getMaxVertices

public long getMaxVertices(long defaultMax)

Gets a limit for the number of vertices that are read from a LAS file, intended for use in situations where available memory is limited.

Parameters:

defaultMax - the default maximum value, use Long.MAX_VALUE if there is no limit.

Returns:

if specified, the value from the "-maxVertices" argumnet; otherwise, the default.

getRandomSeed

public long getRandomSeed(long defaultSeed)

Gets a value for a seed to be used for producing a sequence of values using a random-number generator. While the Java Random class is often used for this purpose, applications are free to use whether means or alternatives that are appropriate.

Parameters:

defaultSeed - a default value .

Returns:

if specified, the value from the "-seed" argument; otherwise, the default.

isPreSortEnabled

public boolean isPreSortEnabled(boolean defaultEnabled)

Indicates whether the vertex list should be Hilbert sorted before insertion into the TIN.

Parameters:

defaultEnabled - a default value supplied by the applicat

Returns:

true if pre-sort is enabled; otherwise, false

isPreAllocateEnabled

public boolean isPreAllocateEnabled(boolean defaultEnabled)

Indicates whether edge pre-allocation is enabled.

Parameters:

defaultEnabled - a default value supplied by the application

Returns:

true if pre-allocation is enabled; otherwise, false.

checkForUnrecognizedArgument

public void checkForUnrecognizedArgument(String[] args,
                                         boolean[] matched)

Performs a check for any arguments that were not matched.

Parameters:

args - a valid array of arguments

matched - a parallel array to args, used to track which arguments were matched to supported options.

checkForMandatoryOptions

public void checkForMandatoryOptions(String[] args,
                                     String[] options)

getLidarClass

public int getLidarClass()

Gets the target lidar classification for samples to be read from an LAS file. This setting is sometimes combined with the lidar thinning setting.

Returns:

a value in the range 0 to 255, or -1 for all classes.

setLidarClass

public void setLidarClass(int classification)

Set the default classification for lidar points to be accepted when reading a LAS file. Use 2 for ground points and -1 to accept all.

Parameters:

classification - an integer in the range 0 to 255, or -1 for all.

getLidarThinningFactor

public double getLidarThinningFactor()

Gets a lidar thinning factor used for selecting random subsets of lidar samples from an LAS file. If used, the number of points retrieved from the file will be reduced to a count approximately proportional to the thinning factor. For example, given a thinning factor of 0.5, approximately 1/2 of the sample points in the lidar file will be retrieved. This setting is often compiled with the lidar-class setting.

Returns:

a value greater than zero and less than or equal to 1.0, with 1.0 corresponding to 100 percent acceptance.

getClipBounds

public double[] getClipBounds()

Get the clip bounds specified as a sequence of 4 floating-point values giving minX, maxX, minY, maxY.

Returns:

if specified, a valid array of 4 values; otherwise a zero-length array

isClipSet

public boolean isClipSet()

Indicates whether the clip bounds was specified.

Returns:

true if the bounds are specified; otherwise, false

isFrameSet

public boolean isFrameSet()

Indicates whether the frame was specified.

Returns:

true if the frame was specified; otherwise, false

getFrame

public double[] getFrame()

Get the frame specified as a sequence of 4 floating-point values giving minX, maxX, minY, maxY.

Returns:

if specified, a valid array of 4 values; otherwise a zero-length array

isTinClassSet

public boolean isTinClassSet()

Indicates whether the options specified a class for the Incremental TIN.

Returns:

true if the options specified a class; otherwise, false.

getTinClass

public Class<?> getTinClass()

Gets the class specified for the test (default: IncrementalTin)

Returns:

a valid reference for a class that implements IIncrementalTin

getNewInstanceOfTestTin

public org.tinfour.common.IIncrementalTin getNewInstanceOfTestTin()

Gets a new instance of the class specified via the command-line options by invoking its default constructor.

Returns:

a valid instances of the specified class, or IncrementalTin if no class was specified.

isPaletteSet

public boolean isPaletteSet()

Indicates whether a palette was specified

Returns:

true if a palette was specified; otherwise false.

getPalette

public TestPalette getPalette()

Get an instance of a palette for rendering.

Returns:

a valid palette (uses default if none specified).

getGeoCoordinateOption

public TestOptions.GeoCoordinateOption getGeoCoordinateOption()

Gets the geographic coordinate conversion option, if specified.

Returns:

if specified, a valid member of the enumeration; otherwise, a null.

getDelimiter

public char getDelimiter()

Gets the delimiter character specified in the options.

Returns:

A valid character or a zero (null) if not specified.

getInterpolator

public org.tinfour.interpolation.IInterpolatorOverTin getInterpolator(org.tinfour.common.IIncrementalTin tin)

Constructs an interpolator based on the specified options, default value is NaturalNeighbor.

Parameters:

tin - a valid instance of an IIncrementalTin implementation.

Returns:

a valid interpolator.

getInterpolationMethod

public InterpolationMethod getInterpolationMethod()

Gets the interpolation method based on the specified options, default value is NaturalNeighbor;

Returns:

a valid enumeration value.

getConstraintsFile

public File getConstraintsFile()

Gets the constraints file (if specified).

Returns:

if specified, a valid file; otherwise, a null.