org.tinfour.demo.utils

Class VertexLoader

java.lang.Object

org.tinfour.demo.utils.VertexLoader

public class VertexLoader
extends Object

A utility for loading vertices from a file for testing

Constructor Summary

Constructors

Constructor and Description
VertexLoader()

Method Summary

Modifier and Type	Method and Description
org.tinfour.utils.loaders.ICoordinateTransform	getCoordinateTransform() Gets the coordinate transform, if any
org.tinfour.utils.LinearUnits	getLinearUnits() Gets the linear units for the coordinate system used by the data.
long	getNumberOfVerticesInFile() Gets the number of vertices in source file (including those that were marked as withheld.
double	getTimeForLoad() Gets the total time to load a file (including the time required for pre-sort if enabled).
double	getTimeForPreSort() Gets the time required for the spatial locality sort or zero if not performed
double	getXMax() Gets the maximum x coordinate in the sample
double	getXMin() Gets the minimum x coordinate in the sample
double	getYMax() Gets the maximum y coordinate in the sample
double	getYMin() Gets the minimum y coordinate in the sample
double	getZMax() Gets the maximum z coordinate in the sample
double	getZMin() Gets the minimum z coordinate in the sample
boolean	isSourceInGeographicCoordinates() Indicates whether the source data was in geographic coordinates
List<org.tinfour.common.Vertex>	readInputFile(TestOptions options) Read the LAS file as specified in the supplied options, applying any settings such as maxNumberOfVertices or setPreSortEnabled that are passed as part of the options object.
void	setClip(double xClipMin, double xClipMax, double yClipMin, double yClipMax) Sets the limits for accepting vertices
void	setMaximumNumberOfVertices(long maxN) Sets the maximum number of vertices that will be loaded from a source file.
void	setPreSortEnabed(boolean enabled) Set the loader to pre-sort the vertices to improve their spatial locality before processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexLoader

public VertexLoader()

Method Detail

setMaximumNumberOfVertices

public void setMaximumNumberOfVertices(long maxN)

Sets the maximum number of vertices that will be loaded from a source file. Useful in memory constrained environments

Parameters:

maxN - the maximum number of vertices.

setPreSortEnabed

public void setPreSortEnabed(boolean enabled)

Set the loader to pre-sort the vertices to improve their spatial locality before processing. Default is to not sort vertices.

Parameters:

enabled - true if the sort is enabled; otherwise, false.

readInputFile

public List<org.tinfour.common.Vertex> readInputFile(TestOptions options)
                                              throws IOException

Read the LAS file as specified in the supplied options, applying any settings such as maxNumberOfVertices or setPreSortEnabled that are passed as part of the options object.

Parameters:

options - a valid options object

Returns:

a list of vertices (potentially empty)

Throws:

IOException - in the event of a non-recoverable I/O condition such as file-not-found.

getXMin

public double getXMin()

Gets the minimum x coordinate in the sample

Returns:

a valid floating point value

getXMax

public double getXMax()

Gets the maximum x coordinate in the sample

Returns:

a valid floating point value

getYMin

public double getYMin()

Gets the minimum y coordinate in the sample

Returns:

a valid floating point value

getYMax

public double getYMax()

Gets the maximum y coordinate in the sample

Returns:

a valid floating point value

getZMin

public double getZMin()

Gets the minimum z coordinate in the sample

Returns:

a valid floating point value

getZMax

public double getZMax()

Gets the maximum z coordinate in the sample

Returns:

a valid floating point value

getTimeForPreSort

public double getTimeForPreSort()

Gets the time required for the spatial locality sort or zero if not performed

Returns:

a positive floating point value in milliseconds.

getTimeForLoad

public double getTimeForLoad()

Gets the total time to load a file (including the time required for pre-sort if enabled).

Returns:

a time in milliseconds

getNumberOfVerticesInFile

public long getNumberOfVerticesInFile()

Gets the number of vertices in source file (including those that were marked as withheld.

Returns:

a value of zero or greater.

setClip

public void setClip(double xClipMin,
                    double xClipMax,
                    double yClipMin,
                    double yClipMax)

Sets the limits for accepting vertices

Parameters:

xClipMin - the minimum x coordinate for accepting vertices.

xClipMax - the maximum x coordinate for accepting vertices.

yClipMin - the minimum y coordinate for accepting vertices.

yClipMax - the maximum y coordinate for accepting vertices.

isSourceInGeographicCoordinates

public boolean isSourceInGeographicCoordinates()

Indicates whether the source data was in geographic coordinates

Returns:

true if the source data used geographic coordinates; otherwise, false.

getLinearUnits

public org.tinfour.utils.LinearUnits getLinearUnits()

Gets the linear units for the coordinate system used by the data. It is assumed that the vertical and horizontal coordinate systems will be in the same unit system, though assumption could change in a future implementation.

Returns:

a valid enumeration instance

getCoordinateTransform

public org.tinfour.utils.loaders.ICoordinateTransform getCoordinateTransform()

Gets the coordinate transform, if any

Returns:

if provided, a valid instance; otherwise, a null.