com.c5corp.c5utm
Class StatisticalPoint

java.lang.Object
  com.c5corp.c5utm.Point
      com.c5corp.c5utm.StatisticalPoint

public class StatisticalPoint
extends Point

A Statistical Point extends a Point. A Point is a structure to hold the fields from a UTM_COORDS record, and a StatisicalPoint adds the attributes (if any) stored in the associated record in the UTM_POINT_STATS table. Note that these need to be processed into a relational database with the com.c5corp.c5utm.util classes. It provides constructor and accessor methods for all fields. Usually you will not create and instance of this class yourself, but will use the static methods in the C5UTM class class to create a StasticalPoint from a query of some sort.

Since:

2.0

Author:

Brett Stalbaum copyright 2002-2005

See Also:

Points, com.c5corp.c5utm.util

Constructor Summary

protected

StatisticalPoint(int zone, int easting, int northing, int elevation, java.lang.String dem_id, java.lang.String id, int low, int high, int mean, int median, double stdev, int percentile, int contiguous_modality_percentage, int topographic_descriptor, int terrain_descriptor) Constructor for the StatisticalPoint class.

Method Summary

int	getClosestMean() Returns the closest elevation to the mean found in the associated set
int	getClosestMedian() Returns the (snapped) median elevation found in the associated set
int	getContiguousModalityPercentage() Returns the contiguous modality percentage of the associated set, with -1 indicating a perfectly flat area, and -2 an error.
int	getHighest() Returns the highest elevation found in the associated set
int	getLowest() Returns the lowest elevation found in the associated set
int	getPercentile() Returns the percentile of this Point compared to the elevations in the associated set.
double	getStandardDeviation() Returns the standard deviation of the points surroundin this point
int	getTerrainDescriptor() Returns a descriptor describing the terrain imediately around the point
int	getTopographicDescriptor() Returns a descriptor describing the area surrounding the point
java.lang.String	toString() overrides toString() of the Object class

Methods inherited from class com.c5corp.c5utm.Point

getDemId, getEasting, getElevation, getId, getNorthing, getZone

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticalPoint

protected StatisticalPoint(int zone,
                           int easting,
                           int northing,
                           int elevation,
                           java.lang.String dem_id,
                           java.lang.String id,
                           int low,
                           int high,
                           int mean,
                           int median,
                           double stdev,
                           int percentile,
                           int contiguous_modality_percentage,
                           int topographic_descriptor,
                           int terrain_descriptor)

Constructor for the StatisticalPoint class. Normally you would not call this constructor yourself, but would use one of the static methods fo the C5UTM class to create an object of this type. The static methods of the C5UTM class makes an call to the database in which the related data from the UTM_COORDS table is taken and an instance of this class produced.

Parameters:

zone - the UTM zone

easting - the UTM easting

northing - the UTM northing

elevation - the elevation

dem_id - the database id for the dem

id - the database id

low - the lowest elevation represented in the set represented by this point

high - the highest elevation represented in the set represented by this point

mean - the mean elevation represented in the set represented by this point

median - the median elevation represented in the set represented by this point

stdev - the stdev of the area represented in the set represented by this point

percentile - the percentile of this points elevation realtive to the rest of the area

contiguous_modality_percentage - the cmp associated with this point

topographic_descriptor - topographic descriptor for this point

terrain_descriptor - the terrain descriptor for this point

Method Detail

getLowest

public int getLowest()

Returns the lowest elevation found in the associated set

Returns:

low elevation

getHighest

public int getHighest()

Returns the highest elevation found in the associated set

Returns:

high elevation

getClosestMean

public int getClosestMean()

Returns the closest elevation to the mean found in the associated set

Returns:

closest mean

getClosestMedian

public int getClosestMedian()

Returns the (snapped) median elevation found in the associated set

Returns:

closest median

getStandardDeviation

public double getStandardDeviation()

Returns the standard deviation of the points surroundin this point

Returns:

the standard deviation

getPercentile

public int getPercentile()

Returns the percentile of this Point compared to the elevations in the associated set.

Returns:

the percentile

getContiguousModalityPercentage

public int getContiguousModalityPercentage()

Returns the contiguous modality percentage of the associated set, with -1 indicating a perfectly flat area, and -2 an error.

Returns:

the cmp

getTerrainDescriptor

public int getTerrainDescriptor()

Returns a descriptor describing the terrain imediately around the point

Returns:

the terrain descriptor

getTopographicDescriptor

public int getTopographicDescriptor()

Returns a descriptor describing the area surrounding the point

Returns:

the topographic descriptor

toString

public java.lang.String toString()

overrides toString() of the Object class

Overrides:

toString in class Point