ExponentialVariogram Class Reference

#include <ExponentialVariogram.h>

Inheritance diagram for ExponentialVariogram:

Public Member Functions
	ExponentialVariogram ()
	ExponentialVariogram (Options *options)
	~ExponentialVariogram ()
Object *	copy ()
void	DeepEcho ()
void	Echo ()
int	Id ()
void	Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
int	ObjectEnum ()
double	Covariance (double deltax, double deltay)
double	SemiVariogram (double deltax, double deltay)
Public Member Functions inherited from Variogram
virtual	~Variogram ()
Public Member Functions inherited from Object
virtual	~Object ()

Data Fields
double	nugget
double	sill
double	range

Detailed Description

Definition at line 11 of file ExponentialVariogram.h.

Constructor & Destructor Documentation

ExponentialVariogram() [1/2]

ExponentialVariogram::ExponentialVariogram

(

)

Definition at line 15 of file ExponentialVariogram.cpp.

                                          {/*{{{*/
   this->nugget = 0.2;
   this->sill   = 1;
   this->range  = SQRT3;
   return;
}

ExponentialVariogram() [2/2]

ExponentialVariogram::ExponentialVariogram

(

Options *

options

)

Definition at line 22 of file ExponentialVariogram.cpp.

                                                          {/*{{{*/
 
   /*Defaults*/
   this->nugget = 0.2;
   this->sill   = 1;
   this->range  = SQRT3;
 
   /*Overwrite from options*/
   if(options->GetOption("nugget")) options->Get(&this->nugget,"nugget");
   if(options->GetOption("sill"))   options->Get(&this->sill,"sill");
   if(options->GetOption("range"))  options->Get(&this->range,"range");
 
   /*Checks*/
   if(nugget==sill) _error_("nugget and sill cannot be equal (constant semivariogram not allowed)");
}

~ExponentialVariogram()

ExponentialVariogram::~ExponentialVariogram

(

)

Definition at line 38 of file ExponentialVariogram.cpp.

                                           {/*{{{*/
   return;
}

Member Function Documentation

copy()

Object * ExponentialVariogram::copy ( void  )

virtual

Implements Object.

Definition at line 44 of file ExponentialVariogram.cpp.

                                      {/*{{{*/
      return new ExponentialVariogram(*this);
}

DeepEcho()

void ExponentialVariogram::DeepEcho ( void  )

inlinevirtual

Implements Object.

Definition at line 25 of file ExponentialVariogram.h.

{_error_("Not implemented yet");};

Echo()

void ExponentialVariogram::Echo ( void  )

virtual

Implements Object.

Definition at line 48 of file ExponentialVariogram.cpp.

                                   {/*{{{*/
   _printf_("ExponentialVariogram\n");
   _printf_("   nugget: " << this->nugget << "\n");
   _printf_("   sill  : " << this->sill << "\n");
   _printf_("   range : " << this->range << "\n");
}

Id()

int ExponentialVariogram::Id ( void  )

inlinevirtual

Implements Object.

Definition at line 27 of file ExponentialVariogram.h.

{_error_("Not implemented yet");}; 

Marshall()

void ExponentialVariogram::Marshall ( char **  pmarshalled_data, int *  pmarshalled_data_size, int  marshall_direction  )

inlinevirtual

Implements Object.

Definition at line 28 of file ExponentialVariogram.h.

{ _error_("not implemented yet!"); };

ObjectEnum()

int ExponentialVariogram::ObjectEnum ( void  )

inlinevirtual

Implements Object.

Definition at line 29 of file ExponentialVariogram.h.

{_error_("Not implemented yet");};

Covariance()

double ExponentialVariogram::Covariance ( double  deltax, double  deltay  )

virtual

Implements Variogram.

Definition at line 57 of file ExponentialVariogram.cpp.

                                                                  {/*{{{*/
   /*The covariance can be deduced from the variogram from the following
    * relationship:
    *    2 gamma = C(x,x) + C(y,y) -2 C(x,y)
    * so
    *    C(h) = sill - gamma                                            */
   double h,a,cova;
 
   /*Calculate length*/
   h=sqrt(deltax*deltax + deltay*deltay);
 
   /*If h is too small, return sill*/
   if(h<0.0000001) return sill;
 
   /*compute covariance*/
   a     = 1./3.;
   cova = (sill-nugget)*exp(-h/(a*range));
   return cova;
}

SemiVariogram()

double ExponentialVariogram::SemiVariogram ( double  deltax, double  deltay  )

virtual

Implements Variogram.

Definition at line 77 of file ExponentialVariogram.cpp.

                                                                     {/*{{{*/
   /*http://en.wikipedia.org/wiki/Variogram*/
   double h,a,gamma;
 
   /*Calculate length*/
   h=sqrt(deltax*deltax + deltay*deltay);
 
   /*return semi-variogram*/
   a     = 1./3.;
   gamma = (sill-nugget)*(1-exp(-h/(a*range))) + nugget;
   return gamma;
}

Field Documentation

nugget

double ExponentialVariogram::nugget

Definition at line 14 of file ExponentialVariogram.h.

sill

double ExponentialVariogram::sill

Definition at line 15 of file ExponentialVariogram.h.

range

double ExponentialVariogram::range

Definition at line 16 of file ExponentialVariogram.h.

---

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

• src/c/classes/kriging/ExponentialVariogram.h
• src/c/classes/kriging/ExponentialVariogram.cpp