te::sa::GeostatisticalMethodSemivariogram Class Reference

Semivariogram is a function describing the degree of spatial dependence of a spatial random field. It is defined as the variance of the difference between field values at two locations (x and y) across realizations of the field. More...

#include <GeostatisticalMethodSemivariogram.h>

Inheritance diagram for te::sa::GeostatisticalMethodSemivariogram:
te::sa::GeostatisticalMethod

Public Member Functions

virtual boost::numeric::ublas::matrix< double > calculate ()
 Function to calculate the geostatistical information. More...
 
 GeostatisticalMethodSemivariogram ()
 Default constructor. More...
 
double getAngleDirection ()
 Function to get the angle direction. More...
 
double getAngleTolerance ()
 Function to get the angle tolerance. More...
 
double getLagIncrement ()
 Function to get the lag increment. More...
 
boost::numeric::ublas::matrix< double > & getMatrix ()
 Function to get the input matrix with data information. More...
 
std::size_t getNumberOfLags ()
 Function to get the number of lags. More...
 
void setAngleDirection (double value)
 Function to set the angle direction. More...
 
void setAngleTolerance (double value)
 Function to set the angle tolerance. More...
 
void setLagIncrement (double value)
 Function to set the lag increment. More...
 
void setMatrix (boost::numeric::ublas::matrix< double > matrix)
 Function to set the input matrix with data information. More...
 
void setNumberOfLags (std::size_t value)
 Function to set the number of lags. More...
 
virtual ~GeostatisticalMethodSemivariogram ()
 Virtual destructor. More...
 

Protected Attributes

double m_angleDirection
 Attribute used to define the direction used to calculate the variogram. More...
 
double m_angleTolerance
 Attribute used to define the minimum and maximum angular direction. More...
 
boost::numeric::ublas::matrix< double > m_dataMatrix
 Matrix with input data information. More...
 
double m_lagIncrement
 Attribute used to define the distance between each lag. More...
 
std::size_t m_nLags
 Attribute used to specifies the basic distance unit. More...
 

Detailed Description

Semivariogram is a function describing the degree of spatial dependence of a spatial random field. It is defined as the variance of the difference between field values at two locations (x and y) across realizations of the field.

Definition at line 46 of file GeostatisticalMethodSemivariogram.h.

Constructor & Destructor Documentation

te::sa::GeostatisticalMethodSemivariogram::GeostatisticalMethodSemivariogram ( )

Default constructor.

virtual te::sa::GeostatisticalMethodSemivariogram::~GeostatisticalMethodSemivariogram ( )
virtual

Virtual destructor.

Member Function Documentation

virtual boost::numeric::ublas::matrix<double> te::sa::GeostatisticalMethodSemivariogram::calculate ( )
virtual

Function to calculate the geostatistical information.

Implements te::sa::GeostatisticalMethod.

double te::sa::GeostatisticalMethod::getAngleDirection ( )
inlineinherited

Function to get the angle direction.

Definition at line 89 of file GeostatisticalMethod.h.

double te::sa::GeostatisticalMethod::getAngleTolerance ( )
inlineinherited

Function to get the angle tolerance.

Definition at line 101 of file GeostatisticalMethod.h.

double te::sa::GeostatisticalMethod::getLagIncrement ( )
inlineinherited

Function to get the lag increment.

Definition at line 113 of file GeostatisticalMethod.h.

boost::numeric::ublas::matrix<double>& te::sa::GeostatisticalMethod::getMatrix ( )
inlineinherited

Function to get the input matrix with data information.

Definition at line 137 of file GeostatisticalMethod.h.

std::size_t te::sa::GeostatisticalMethod::getNumberOfLags ( )
inlineinherited

Function to get the number of lags.

Definition at line 125 of file GeostatisticalMethod.h.

void te::sa::GeostatisticalMethod::setAngleDirection ( double  value)
inlineinherited

Function to set the angle direction.

Definition at line 83 of file GeostatisticalMethod.h.

void te::sa::GeostatisticalMethod::setAngleTolerance ( double  value)
inlineinherited

Function to set the angle tolerance.

Definition at line 95 of file GeostatisticalMethod.h.

void te::sa::GeostatisticalMethod::setLagIncrement ( double  value)
inlineinherited

Function to set the lag increment.

Definition at line 107 of file GeostatisticalMethod.h.

void te::sa::GeostatisticalMethod::setMatrix ( boost::numeric::ublas::matrix< double >  matrix)
inlineinherited

Function to set the input matrix with data information.

Definition at line 131 of file GeostatisticalMethod.h.

void te::sa::GeostatisticalMethod::setNumberOfLags ( std::size_t  value)
inlineinherited

Function to set the number of lags.

Definition at line 119 of file GeostatisticalMethod.h.

Member Data Documentation

double te::sa::GeostatisticalMethod::m_angleDirection
protectedinherited

Attribute used to define the direction used to calculate the variogram.

Definition at line 144 of file GeostatisticalMethod.h.

double te::sa::GeostatisticalMethod::m_angleTolerance
protectedinherited

Attribute used to define the minimum and maximum angular direction.

Definition at line 146 of file GeostatisticalMethod.h.

boost::numeric::ublas::matrix<double> te::sa::GeostatisticalMethod::m_dataMatrix
protectedinherited

Matrix with input data information.

Definition at line 152 of file GeostatisticalMethod.h.

double te::sa::GeostatisticalMethod::m_lagIncrement
protectedinherited

Attribute used to define the distance between each lag.

Definition at line 148 of file GeostatisticalMethod.h.

std::size_t te::sa::GeostatisticalMethod::m_nLags
protectedinherited

Attribute used to specifies the basic distance unit.

Definition at line 150 of file GeostatisticalMethod.h.


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