Public Member Functions | Protected Attributes | List of all members
te::sa::GeostatisticalModelExponential Class Reference

Class that represents the geostatistical exponential model. More...

#include <GeostatisticalModelExponential.h>

Inheritance diagram for te::sa::GeostatisticalModelExponential:
te::sa::GeostatisticalModel

Public Member Functions

virtual boost::numeric::ublas::matrix< double > calculate (boost::numeric::ublas::matrix< double > matrix)
 Function to calculate the geostatistical information from model. More...
 
 GeostatisticalModelExponential ()
 Default constructor. More...
 
double getNugget ()
 Function to get the nugget value. More...
 
double getRange ()
 Function to get the range value. More...
 
double getSill ()
 Function to get the sill value. More...
 
void setNugget (double value)
 Function to set the nugget value. More...
 
void setRange (double value)
 Function to set the range value. More...
 
void setSill (double value)
 Function to set the sill value. More...
 
virtual ~GeostatisticalModelExponential ()
 Virtual destructor. More...
 

Protected Attributes

double m_nugget
 The height of the jump of the semivariogram at the discontinuity at the origin. More...
 
double m_range
 The distance in which the difference of the variogram from the sill becomes negligible. More...
 
double m_sill
 Limit of the variogram tending to infinity lag distances. More...
 
te::sa::GeostatisticalModelType m_type
 Attribute used to define the model type used. More...
 

Detailed Description

Class that represents the geostatistical exponential model.

gamma(h)=(s-n)(1-(-h/(ra)))+n 1_{(0,)}(h)

See also
GeostatisticalModel

Definition at line 47 of file GeostatisticalModelExponential.h.

Constructor & Destructor Documentation

te::sa::GeostatisticalModelExponential::GeostatisticalModelExponential ( )

Default constructor.

virtual te::sa::GeostatisticalModelExponential::~GeostatisticalModelExponential ( )
virtual

Virtual destructor.

Member Function Documentation

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

Function to calculate the geostatistical information from model.

Implements te::sa::GeostatisticalModel.

double te::sa::GeostatisticalModel::getNugget ( )
inlineinherited

Function to get the nugget value.

Definition at line 82 of file GeostatisticalModel.h.

double te::sa::GeostatisticalModel::getRange ( )
inlineinherited

Function to get the range value.

Definition at line 106 of file GeostatisticalModel.h.

double te::sa::GeostatisticalModel::getSill ( )
inlineinherited

Function to get the sill value.

Definition at line 94 of file GeostatisticalModel.h.

void te::sa::GeostatisticalModel::setNugget ( double  value)
inlineinherited

Function to set the nugget value.

Definition at line 76 of file GeostatisticalModel.h.

void te::sa::GeostatisticalModel::setRange ( double  value)
inlineinherited

Function to set the range value.

Definition at line 100 of file GeostatisticalModel.h.

void te::sa::GeostatisticalModel::setSill ( double  value)
inlineinherited

Function to set the sill value.

Definition at line 88 of file GeostatisticalModel.h.

Member Data Documentation

double te::sa::GeostatisticalModel::m_nugget
protectedinherited

The height of the jump of the semivariogram at the discontinuity at the origin.

Definition at line 113 of file GeostatisticalModel.h.

double te::sa::GeostatisticalModel::m_range
protectedinherited

The distance in which the difference of the variogram from the sill becomes negligible.

Definition at line 117 of file GeostatisticalModel.h.

double te::sa::GeostatisticalModel::m_sill
protectedinherited

Limit of the variogram tending to infinity lag distances.

Definition at line 115 of file GeostatisticalModel.h.

te::sa::GeostatisticalModelType te::sa::GeostatisticalModel::m_type
protectedinherited

Attribute used to define the model type used.

Definition at line 119 of file GeostatisticalModel.h.

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