GeoTessCPP  2.1
Software to facilitate storage and retrieval of 3D information about the Earth.
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Public Member Functions | Static Public Member Functions | List of all members
geotess::GeoTessPosition Class Reference

#include <GeoTessPosition.h>

Inheritance diagram for geotess::GeoTessPosition:
geotess::GeoTessPositionLinear geotess::GeoTessPositionNaturalNeighbor

Public Member Functions

virtual ~GeoTessPosition ()
 
void addReference ()
 
void copyVector (double *u)
 
const double * getClosestVertex () const
 
void getCoefficients (map< int, double > &coefficients)
 
double getDepth ()
 
double getDepthBottom ()
 
double getDepthBottom (int layid)
 
double getDepthTop ()
 
double getDepthTop (int layid)
 
double getEarthRadius ()
 
double getErrorValue ()
 
double getHorizontalCoefficient (int index) const
 
const vector< double > & getHorizontalCoefficients () const
 
int getIndexOfClosestVertex () const
 
virtual const
GeoTessInterpolatorType
getInterpolatorType () const
 
int getLayerId (double rad)
 
int getLayerId ()
 
double getLayerThickness (int layid)
 
double getLayerThickness ()
 
int getMaxTessLevel (int layid)
 
GeoTessModelgetModel ()
 
int getNVertices ()
 
double getRadius ()
 
double getRadiusBottom (int layid)
 
double getRadiusBottom ()
 
double getRadiusTop (int layid)
 
double getRadiusTop ()
 
int getReferenceCount ()
 
int getTessID ()
 
int getTessLevel () const
 
int getTessLevel (const int &tId)
 
int getTriangle ()
 
virtual double getValue (int attribute)
 
double * getVector ()
 
int getVertex (int index)
 
int getVertexIndex ()
 
const vector< int > & getVertices () const
 
void getWeights (map< int, double > &weights, double dkm)
 
bool isNotReferenced ()
 
bool isRadiusOutOfRangeAllowed ()
 
bool noEmptyProfiles ()
 
void removeReference ()
 
void set (double lat, double lon, double depth)
 
void set (const double *const uVector, const double &newRadius)
 
void set (int layid, double lat, double lon, double depth)
 
void set (int layid, const double *const uVector, double rad)
 
void setBottom (int layid, const double *const uVector)
 
void setBottom (int layid)
 
void setDepth (int layer, double depth)
 
void setDepth (double depth)
 
void setErrorValue (double errVal)
 
void setMaxTessLevel (int layid, int maxTess)
 
void setModel (GeoTessModel *newModel)
 
void setRadius (int layid, double rad)
 
void setRadius (double rad)
 
void setRadiusOutOfRangeAllowed (bool allowed)
 
void setTop (int layid, const double *const uVector)
 
void setTop (int layid)
 
string toString ()
 

Static Public Member Functions

static GeoTessPositiongetGeoTessPosition (GeoTessModel *model)
 
static GeoTessPositiongetGeoTessPosition (GeoTessModel *model, const GeoTessInterpolatorType &horizontalType)
 
static GeoTessPositiongetGeoTessPosition (GeoTessModel *model, const GeoTessInterpolatorType &horizontalType, const GeoTessInterpolatorType &radialType)
 

Detailed Description

Manages information about a single point at an arbitrary position in a triangular tessellation. It provides access to:

GeoTessModel has method getGeoTessPosition() that returns a pointer to a new GeoTessPosition object.

GeoTessPosition supports separate interpolation algorithms in the geographic and radial dimensions. In the geographic dimensions, LINEAR and NATURAL_NEIGHBOR interpolation algorithms are supported. LINEAR and CUBIC_SPLINE interpolation are supported in the radial dimension.

GeoTessPosition is not thread-safe in that it's internal state is mutable. The design intention is that single instances of a GeoTessGrid object and GeoTessData object can be shared among all the threads in a multi-threaded application and each thread will have it's own instance of a GeoTessPosition object that references the common GeoTessGrid + GeoTessData combination.

Author
Sandy Ballard

Constructor & Destructor Documentation

virtual geotess::GeoTessPosition::~GeoTessPosition ( )
virtual

Destructor.

Member Function Documentation

void geotess::GeoTessPosition::addReference ( )
inline

Add reference count;

void geotess::GeoTessPosition::copyVector ( double *  u)
inline

Copy the contents of the unit vector that corresponds to the current position into the supplied double* which must have at least 3 elements.

Parameters
ua 3-element array into which the current position will be copied.
const double* geotess::GeoTessPosition::getClosestVertex ( ) const
inline

Retrieve the unit vector of the vertex wiht the highest interpolation coefficient.

Returns
a reference to the vertex that is closest to this position.
void geotess::GeoTessPosition::getCoefficients ( map< int, double > &  coefficients)
inline

Retrieve a map from pointIndex to interpolation coefficient. The returned coefficients sum to one.

Parameters
coefficientsHashMap<Integer, Double> from pointIndex to interpolation coefficient
double geotess::GeoTessPosition::getDepth ( )
inline

Retrieve the depth of the current position in km. Assumes GRS80 ellipsoid.

Returns
the depth of the current position in km.
double geotess::GeoTessPosition::getDepthBottom ( )
inline

Retrieve an interpolated value of the depth of the bottom of the current layer.

Returns
interpolated value of the depth of the bottom of the current layer.
double geotess::GeoTessPosition::getDepthBottom ( int  layid)
inline

Retrieve an interpolated value of the depth of the bottom of the current layer.

Parameters
layid
Returns
interpolated value of the depth of the bottom of the current layer.
double geotess::GeoTessPosition::getDepthTop ( )
inline

Retrieve an interpolated value of the depth of the top of the current layer.

Returns
interpolated value of the depth of the top of the current layer.
double geotess::GeoTessPosition::getDepthTop ( int  layid)
inline

Retrieve an interpolated value of the depth of the top of the current layer.

Parameters
layid
Returns
interpolated value of the depth of the top of the current layer.
double geotess::GeoTessPosition::getEarthRadius ( )
inline

Retrieve the radius of the Earth at this position, in km. Assumes GRS80 ellipsoid.

Returns
the radius of the Earth at this position, in km.
double geotess::GeoTessPosition::getErrorValue ( )
inline

If any calculated value is Double.NaN, then functions like getValue() or getRadiusTop() or getRadiusBottom() will return this errorValue. The default is NaN, but it can be set by calling setErrorValue();

Returns
errorValue
static GeoTessPosition* geotess::GeoTessPosition::getGeoTessPosition ( GeoTessModel model)
static

Static factory method to create a new GeoTessPosition object. Linear interpolation will be performed in both the horizontal and radial dimensions.

It is the caller's responsibility to delete this object when it is no longer needed.

Parameters
modelpointer to the model that supports this position
Returns
a GeoTessPosition object.
static GeoTessPosition* geotess::GeoTessPosition::getGeoTessPosition ( GeoTessModel model,
const GeoTessInterpolatorType horizontalType 
)
static

Static factory method to create a new GeoTessPosition object. If the horizontal InterpolatorType is LINEAR then the radial InterpolatorType will be LINEAR as well. If the horizontal InterpolatorType is NATUAL_NEIGHBOR then the radial InterpolatorType will be CUBIC_SPLINE.

It is the caller's responsibility to delete this object when it is no longer needed.

Parameters
modelthe GeoTessModel from which values will be interpolated.
horizontalTypethe type of interpolation that is to be used for interpolation in the geographic dimensions; either InterpolatorType:LINEAR or InterpolatorType::NATURAL_NEIGHBOR
Returns
a GeoTessPosition object.
static GeoTessPosition* geotess::GeoTessPosition::getGeoTessPosition ( GeoTessModel model,
const GeoTessInterpolatorType horizontalType,
const GeoTessInterpolatorType radialType 
)
static

Static factory method to create a new GeoTessPosition object.

It is the caller's responsibility to delete this object when it is no longer needed.

Parameters
modelthe GeoTessModel from which values will be interpolated.
horizontalTypethe type of interpolation that is to be used for interpolation in the geographic dimensions; either InterpolatorType:LINEAR or InterpolatorType::NATURAL_NEIGHBOR
radialTypethe type of interpolation that is to be used in the radia dimension; either InterpolatorType:LINEAR or InterpolatorType::CUBIC_SPLINE
Returns
a GeoTessPosition object.
double geotess::GeoTessPosition::getHorizontalCoefficient ( int  index) const
inline

Retrieve the interpolation coefficient associated with one of the vertices of the tessellation used to interpolate data.

Parameters
indexthe index of the desired coefficient.
Returns
one of the interpolation coefficients
const vector<double>& geotess::GeoTessPosition::getHorizontalCoefficients ( ) const
inline

Retrieve a reference to the horizontal interpolation coefficients associated with the vertices of the tessellation used to interpolate data.

Returns
a reference to the horizontal interpolation coefficients associated with the vertices of the tessellation used to interpolate data.
int geotess::GeoTessPosition::getIndexOfClosestVertex ( ) const

Retrieve the index of the highest interpolation coefficient.

Returns
the index of the vertex that is closest to this position.
virtual const GeoTessInterpolatorType& geotess::GeoTessPosition::getInterpolatorType ( ) const
virtual

Retrieve the type of interpolator being used for interpolation in geographic dimensions.

Returns
either InterpolatorType::LINEAR or InterpolatorType::NATURAL_NEIGHBOR

Reimplemented in geotess::GeoTessPositionLinear, and geotess::GeoTessPositionNaturalNeighbor.

int geotess::GeoTessPosition::getLayerId ( double  rad)
inline

Retrieve the index of the layer that contains the specified radius. If radius is less than bottom of model, returns 0. If radius greater than top of model, returns index of shallowest layer that has finite thickness. If radius greater than top of model and all layers have zero thickness, returns nLayers-1.

Parameters
radradius in km
Returns
int geotess::GeoTessPosition::getLayerId ( )
inline
Returns
the layerId
double geotess::GeoTessPosition::getLayerThickness ( int  layid)
inline

Retrieve the thickness of specified layer, in km.

Parameters
layidlayer index
Returns
the thickness of specified layer, in km.
double geotess::GeoTessPosition::getLayerThickness ( )
inline

Retrieve the thickness of specified layer, in km.

Returns
the thickness of specified layer, in km.
int geotess::GeoTessPosition::getMaxTessLevel ( int  layid)
inline

Retrieve the current value of maxTessLevel, which is the maximum tessellation level such that the triangle that is found during a walking triangle search will be on a tessellation level that is no higher than the specified value. Default value is Integer.maxValue-1.

Parameters
layid
Returns
current value of maxTessLevel
GeoTessModel* geotess::GeoTessPosition::getModel ( )
inline
Returns
a pointer to the current model
int geotess::GeoTessPosition::getNVertices ( )
inline

Return the number of vertices (3 for LINEAR interpolation, more for natural neighbor).

Returns
number of vertices involved in horizontal interpolation.
double geotess::GeoTessPosition::getRadius ( )
inline

Retrieve the radius of the current position, in km.

Returns
the radius of the current position, in km.
double geotess::GeoTessPosition::getRadiusBottom ( int  layid)

Retrieve an interpolated value of the radius of the bottom of the specified layer, in km.

Parameters
layidthe index of the layer
Returns
interpolated value of the radius, in km.
double geotess::GeoTessPosition::getRadiusBottom ( )
inline

Retrieve an interpolated value of the radius of the bottom of the current layer.

Returns
an interpolated value of the radius of the bottom of the specified layer.
double geotess::GeoTessPosition::getRadiusTop ( int  layid)

Retrieve an interpolated value of the radius of the top of the specified layer, in km.

Parameters
layidthe index of the layer
Returns
interpolated value of the radius, in km.
double geotess::GeoTessPosition::getRadiusTop ( )
inline

Retrieve an interpolated value of the radius of the top of the current layer.

Returns
interpolated value of the radius of the top of the specified layer.
int geotess::GeoTessPosition::getReferenceCount ( )
inline

Retrieve reference count - number of other objects that hold a reference to this position object.

Returns
current reference count
int geotess::GeoTessPosition::getTessID ( )
inline
Returns
the tessID
int geotess::GeoTessPosition::getTessLevel ( ) const
inline

Retrieve the index of the tessellation level of the triangle that was found the last time that the walinkg triangle algorithm was executed.

Returns
index of current tessellation level
int geotess::GeoTessPosition::getTessLevel ( const int &  tId)
inline

Retrieve the index of the tessellation level of the triangle that was found the last time that the walking triangle algorithm was executed.

Parameters
tIdtessellation index
Returns
index of current tessellation level, relative to the first tessellation level in the current tessellation
int geotess::GeoTessPosition::getTriangle ( )
inline

Retrieve the index of the triangle within which the current position is located

Returns
the index of the triangle within which the current position is located
virtual double geotess::GeoTessPosition::getValue ( int  attribute)
virtual

Retrieve an interpolated value of the specified model attribute.

Parameters
attributeindex
Returns
the value of the specified attribute interpolated at the current position
double* geotess::GeoTessPosition::getVector ( )
inline

Retrieve a reference to the 3 component unit vector that corresponds to the current position. Do not modify the values of this array.

Returns
a reference to the 3 component unit vector that corresponds to the current position
int geotess::GeoTessPosition::getVertex ( int  index)
inline

Return the index of one of the vertices used to interpolate data.

Parameters
indexthe index of the desired coefficient.
Returns
the index of one of the vertices used to interpolate data.
int geotess::GeoTessPosition::getVertexIndex ( )
inline

If the position of this GeoTessPosition object is currently set to a location that coincides with one of the grid vertices, return the index of that vertex. Otherwise return -1;

Returns
index of colocated vertex or -1.
const vector<int>& geotess::GeoTessPosition::getVertices ( ) const
inline

Return a reference to the array containing the indexes of vertices in the 2D grid that will be involved in the interpolation of data.

Returns
vector<int>& a reference to the array containing the indexes of vertices in the 2D grid that will be involved in the interpolation of data.
void geotess::GeoTessPosition::getWeights ( map< int, double > &  weights,
double  dkm 
)
inline

Add the weights of the current interpolation position to the supplied map of weights. Weights is a map from a pointIndex to the 'weight' associated with that point. For an individual point, the weight associated with that point is the product of the interpoation coefficient times the supplied value of dkm.

  1. Consider all the points in the model that contribute interpolation coefficients to the position where this GeoTessPosition object is currently located.
  2. For each of those points, look in the supplied weights and see if there is already an entry for the pointIndex.
  3. If there is no entry for the current pointIndex, add an entry with weight = interpolation coefficient * dkm.
  4. If there is already an entry for the current pointIndex, add interpolation coefficient * dkm to the weight that is currently associated with the pointIndex.
Parameters
weightsa map from a point index to the weight assigned to that point.
dkmthe 'length' in km associated with each interpolation position.
bool geotess::GeoTessPosition::isNotReferenced ( )
inline

Returns true if reference count is zero.

Returns
true if reference count is zero.
bool geotess::GeoTessPosition::isRadiusOutOfRangeAllowed ( )
inline

Controls radius out-of-range behavior. If position or radius is set with a specified layer index, and a radius is specified that is outside the bounds of that layer, and radiusOutOfRangeAllowed is true, then interpolated values will be computed using the values from the top or bottom of the specified layer as appropriate. If radiusOutOfRangeAllowed is false then errorValue is returned.

If position or radius is set without a specified layer index, and a radius is specified that is above the surface of the Earth, and radiusOutOfRangeAllowed is true, then interpolated values will be computed using the values from the top of the shallowest layer that has finite thickness. If radiusOutOfRangeAllowed is false then errorValue is returned.

Returns
current setting of radiusOutOfRangeAllowed.
bool geotess::GeoTessPosition::noEmptyProfiles ( )

Returns true if the current interpolation position has no empty profiles

Returns
true if the current interpolation position has no empty profiles
void geotess::GeoTessPosition::removeReference ( )
inline

Remove reference count;

void geotess::GeoTessPosition::set ( double  lat,
double  lon,
double  depth 
)
inline

Set the interpolation point to specified latitude and and longitude in degrees and depth in km below sea level. This method will perform a walking triangle search for the triangle in which the specified position is located and compute the associated interpolation coefficients.

This method is pretty expensive compared to the other version of setPosition where the position is specified as a unit vector and a radius.

Assumes GRS80 ellipsoid.

Parameters
latin degrees.
lonin degrees.
depthbelow sea level in km.
void geotess::GeoTessPosition::set ( const double *const  uVector,
const double &  newRadius 
)
inline

Set the interpolation point. This method will perform a walking triangle search for the triangle in which the specified position is located and compute the associated 2D and radial interpolation coefficients.

Parameters
uVectorthe Earth-centered unit vector that defines the position that is to be set.
newRadiusthe radius of the position, in km.
void geotess::GeoTessPosition::set ( int  layid,
double  lat,
double  lon,
double  depth 
)
inline

Set the interpolation point to specified latitude and longitude in degrees and depth in km below sea level. This method will perform a walking triangle search for the triangle in which the specified position is located and compute the associated interpolation coefficients.

This method is pretty expensive compared to the other version of setPosition where the position is specified as a unit vector and a radius.

Assumes GRS80 ellipsoid.

Parameters
layidthe index of the layer of the model in which the position is to be constrained.
latin degrees.
lonin degrees.
depthbelow sea level in km.
void geotess::GeoTessPosition::set ( int  layid,
const double *const  uVector,
double  rad 
)
inline

Set the interpolation point. This method will perform a walking triangle search for the triangle in which the specified position is located and compute the associated 2D and radial interpolation coefficients.

Parameters
layidthe index of the layer of the model in which the position is to be constrained.
uVectorthe Earth-centered unit vector that defines the position that is to be set.
radthe radius of the position, in km.
void geotess::GeoTessPosition::setBottom ( int  layid,
const double *const  uVector 
)
inline

Set the 2D position to unitVector and radius to the radius of the bottom of the specified layer.

Parameters
layidthe index of the layer of the model in which the position is located.
uVectorthe Earth-centered unit vector that defines the position that is to be set.
void geotess::GeoTessPosition::setBottom ( int  layid)
inline

Set the radius to the radius of the bottom of the specified layer.

Parameters
layidthe index of the layer of the model in which the position is located.
void geotess::GeoTessPosition::setDepth ( int  layer,
double  depth 
)
inline

Change the current layer and/or depth without changing the geographic position.

Parameters
layerthe index of the layer of the model in which the position is located.
depth
Returns
reference to this GeoTessPosition object. the depth of the position, in km.
void geotess::GeoTessPosition::setDepth ( double  depth)
inline

Change the current depth without changing the geographic position.

Parameters
depthdepth in km.
void geotess::GeoTessPosition::setErrorValue ( double  errVal)
inline

If any calculated value is NaN, then functions like getValue() or getRadiusTop() or getRadiusBottom() will return this value. The default is NaN, but it can be set by calling this function.

Parameters
errValnew value for errVal
void geotess::GeoTessPosition::setMaxTessLevel ( int  layid,
int  maxTess 
)
inline

Set the maximum tessellation level such that the triangle that is found during a walking triangle search will be on a tessellation level that is no higher than the specified value. Default value is Integer.maxValue.

Parameters
layid
maxTess
void geotess::GeoTessPosition::setModel ( GeoTessModel newModel)

Replace the model that currently supports this GeoTessPosition object with a new model. For this to work, the new model and the current model must use the same grid.

The benefit of calling this method is that if the application needs to interpolate a value at the same position in multiple models that share the same grid, then the walking triangle algorithm and the calculation of geographic interpolation coefficients do not have to be repeated. The radial interpolation information is updated by this method as well so after the call to this method, GeoTessPosition is ready to interpolate values from the new model.

Parameters
newModelmodel that is to replace the currently supported model.
Exceptions
GeoTessExceptionif the new model and current model do not have GeoTessGrids that have the same gridID.
void geotess::GeoTessPosition::setRadius ( int  layid,
double  rad 
)
inline

Change the current radius without changing the geographic position.

Parameters
layidthe index of the layer of the model in which the position is located.
radthe new radius in km
void geotess::GeoTessPosition::setRadius ( double  rad)
inline

Change the current radius without changing the geographic position.

Parameters
radthe new radius in km
void geotess::GeoTessPosition::setRadiusOutOfRangeAllowed ( bool  allowed)
inline

Controls radius out-of-range behavior. If position or radius is set with a specified layer index, and a radius is specified that is outside the bounds of that layer, and radiusOutOfRangeAllowed is true, then interpolated values will be computed using the values from the top or bottom of the specified layer as appropriate. If radiusOutOfRangeAllowed is false then errorValue is returned.

If position or radius is set without a specified layer index, and a radius is specified that is above the surface of the Earth, and radiusOutOfRangeAllowed is true, then interpolated values will be computed using the values from the top of the shallowest layer that has finite thickness. If radiusOutOfRangeAllowed is false then errorValue is returned.

Parameters
allowedthe new value for radiusOutOfRangeAllowed
void geotess::GeoTessPosition::setTop ( int  layid,
const double *const  uVector 
)
inline

Set the 2D position to unitVector and radius to the radius of the top of the specified layer.

Parameters
layidthe index of the layer of the model in which the position is located.
uVectorthe Earth-centered unit vector that defines the position that is to be set.
void geotess::GeoTessPosition::setTop ( int  layid)
inline

Set the radius to the radius of the top of the specified layer.

Parameters
layidthe index of the layer of the model in which the position is located.
string geotess::GeoTessPosition::toString ( )

Returns position as a string.

Returns
string

The documentation for this class was generated from the following file: