CVariogram Class Reference

experimental/theoretical variogram class More...

#include <variogram.h>

List of all members.

Public Types
enum	VariogramModel { VARIO_NONE, VARIO_SPH, VARIO_STB, VARIO_NUM }
Public Member Functions
	CVariogram (void)
	default constructor
virtual	~CVariogram (void)
	destructor
bool	isActive (void) const
bool	isEstimated (void) const
size_t	samples (void) const
	get number of samples
double	maxDistance (void) const
	get maximum distance of variogram cloud
double	minDistance (void) const
	get minumum distance of variogram cloud
double	nugget (void) const
	get nugget
double	sill (void) const
	get sill
double	range (void) const
	get range
double	power (void) const
	get power coefficient
int	modelType (void) const
	get type of theoretical variogram
size_t	countLessDist (double cap) const
	get number of samples that distance is less than given threshold
bool	getSample (size_t smpl, double &dist, double &vario) const
	get sample data
double	getModelData (double dist) const
	get theoretical dissimilarity
double	getModelCovariance (double dist) const
	get covariance corresponding to theoretical dissimilarity
bool	setSample (const std::vector< CVariogram::VarioItm > &vecSample)
	set variogram cloud
bool	setModel (int model, double nugget, double sill, double range, double power, double step, double maxdist)
	set theoretical variogram model
int	estimateModel (int model, double &nugget, double &sill, double &range, double power, double maxdist=1.0e6)
	estimate theoretical variogram from experimental variogram by non-linear least square fitting
Protected Member Functions
bool	sortByDistance (void)
	sort dissimilarity by distance
Classes
struct	VarioItm
	structure of distance and dissimilarity More...

---

Detailed Description

experimental/theoretical variogram class

Author:

Tomohiko Mukai

Definition at line 16 of file variogram.h.

---

Member Enumeration Documentation

enum CVariogram::VariogramModel

Enumerator: VARIO_NONE  not estimated VARIO_SPH  spherical model VARIO_STB  stable model VARIO_NUM  number of models Definition at line 24 of file variogram.h.

---

Constructor & Destructor Documentation

CVariogram::CVariogram (  void   )

default constructor Returns: none Definition at line 20 of file variogram.cpp.

CVariogram::~CVariogram (  void   )  [virtual]

destructor Returns: none Definition at line 39 of file variogram.cpp.

---

Member Function Documentation

size_t CVariogram::countLessDist (  double  cap  )  const

get number of samples that distance is less than given threshold Parameters: cap  [in] distance threthold Returns: number of samples Definition at line 180 of file variogram.cpp.

int CVariogram::estimateModel (  int  model, double &  nugget, double &  sill, double &  range, double  power, double  maxdist = 1.0e6 )

estimate theoretical variogram from experimental variogram by non-linear least square fitting Parameters: model  [in] theoretical variogram model nugget  [out] nugget sill  [out] sill range  [out] range power  [in] power coefficient of stable variograms maxdist  [in] range of distance for estimation Returns: GSL error number Definition at line 201 of file variogram.cpp.

double CVariogram::getModelCovariance (  double  dist  )  const

get covariance corresponding to theoretical dissimilarity Parameters: dist  [in] distance Returns: covariance Definition at line 340 of file variogram.cpp.

double CVariogram::getModelData (  double  dist  )  const

get theoretical dissimilarity Parameters: dist  [in] distance Returns: dissimilarity Definition at line 320 of file variogram.cpp.

bool CVariogram::getSample (  size_t  smpl, double &  dist, double &  vario )  const

get sample data Parameters: smpl  [in] sample index dist  [out] distance vario  [out] dissimilarity Return values: true  success false  fail Definition at line 164 of file variogram.cpp.

bool CVariogram::isActive (  void   )  const [inline]

Return values: true  active false  inactive Definition at line 92 of file variogram.h.

bool CVariogram::isEstimated (  void   )  const [inline]

Return values: true  estimated false  not estimated Definition at line 101 of file variogram.h.

double CVariogram::maxDistance (  void   )  const [inline]

get maximum distance of variogram cloud Returns: maximum distance Definition at line 119 of file variogram.h.

double CVariogram::minDistance (  void   )  const [inline]

get minumum distance of variogram cloud Returns: minimum distance Definition at line 128 of file variogram.h.

int CVariogram::modelType (  void   )  const [inline]

get type of theoretical variogram Returns: type of theoretical variogram Definition at line 173 of file variogram.h.

double CVariogram::nugget (  void   )  const [inline]

get nugget Returns: nugget Definition at line 137 of file variogram.h.

double CVariogram::power (  void   )  const [inline]

get power coefficient Returns: power coefficient (only for stable models) Definition at line 164 of file variogram.h.

double CVariogram::range (  void   )  const [inline]

get range Returns: range Definition at line 155 of file variogram.h.

size_t CVariogram::samples (  void   )  const [inline]

get number of samples Returns: number of samples Definition at line 110 of file variogram.h.

bool CVariogram::setModel (  int  model, double  nugget, double  sill, double  range, double  power, double  step, double  maxdist )

set theoretical variogram model Parameters: model  [in] theoretical variogram model nugget  [in] nugget sill  [in] sill range  [in] range power  [in] power coefficient of stable variograms step  [in] step width of reogionalization maxdist  [in] range of experimental variogram Return values: true  success false  fail Definition at line 133 of file variogram.cpp.

bool CVariogram::setSample (  const std::vector< CVariogram::VarioItm > &  vecSample  )

set variogram cloud Parameters: vecSample  [in] sample container (distance & dissimilarity) Return values: true  success false  fail Definition at line 100 of file variogram.cpp.

double CVariogram::sill (  void   )  const [inline]

get sill Returns: sill Definition at line 146 of file variogram.h.

bool CVariogram::sortByDistance (  void   )  [protected]

sort dissimilarity by distance Return values: true  success false  fail Definition at line 362 of file variogram.cpp.

---