gstlrn::VMap Class Reference

Class containing the Variogram Map which uses an DbGrid provided by the user This function simply calculate and add the results as new field in this DbGrid. More...

#include <VMap.hpp>

Inheritance diagram for gstlrn::VMap:

Detailed Description

Class containing the Variogram Map which uses an DbGrid provided by the user This function simply calculate and add the results as new field in this DbGrid.

Public Member Functions
	VMap (DbGrid *dbmap)
	VMap (const VMap &r)
VMap &	operator= (const VMap &r)
virtual	~VMap ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable Interface.
double	_getIVAR (const Db *db, Id iech, Id ivar) const override
	AVario Interface.
void	_setAVarioResult (Id iech1, Id iech2, Id nvar, Id idir, Id ilag, Id ivar, Id jvar, Id orient, double ww, double w1, double w2, double z1, double z2, double dist, double value) override
Id	compute (Db *db, Id radius, bool flag_FFT=true, const ECalcVario &calculType=ECalcVario::fromKey("VARIOGRAM"), bool flag_ergodic=true, const NamingConvention &namconv=NamingConvention("VMAP"))
Public Member Functions inherited from gstlrn::AVario
	AVario ()
	AVario (const AVario &r)
AVario &	operator= (const AVario &r)
virtual	~AVario ()
const ECalcVario &	getCalcul () const
void	setCalcul (const ECalcVario &calculType)
void	setStorage (bool flag)
void	setErgodic (bool flag)
bool	getNeedStats () const
bool	getErgodic () const
bool	getFlagAsym () const
bool	getCentered () const
bool	getScaled () const
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final
Public Member Functions inherited from gstlrn::ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0
std::shared_ptr< ICloneable >	cloneShared () const
std::unique_ptr< ICloneable >	cloneUnique () const

Public Attributes
	DECLARE_TOTL
	ICloneable interface.

Constructor & Destructor Documentation

VMap() [1/2]

gstlrn::VMap::VMap

(

DbGrid *

dbmap

)

VMap() [2/2]

gstlrn::VMap::VMap

(

const VMap &

r

)

~VMap()

gstlrn::VMap::~VMap ( )

virtual

Member Function Documentation

_getIVAR()

double gstlrn::VMap::_getIVAR ( const Db *  db, Id  iech, Id  ivar  ) const

overridevirtual

AVario Interface.

Implements gstlrn::AVario.

_setAVarioResult()

void gstlrn::VMap::_setAVarioResult ( Id  iech1, Id  iech2, Id  nvar, Id  idir, Id  ilag, Id  ivar, Id  jvar, Id  orient, double  ww, double  w1, double  w2, double  z1, double  z2, double  dist, double  value  )

overridevirtual

Internal function for setting a VMAP value

Parameters

[in]	iech1	Rank of the first sample
[in]	iech2	Rank of the second sample
[in]	nvar	Number of variables
[in]	idir	Rank of the direction
[in]	ilag	Rank of the variogram lag
[in]	ivar	Index of the first variable
[in]	jvar	Index of the second variable
[in]	orient	Orientation
[in]	ww	Weight
[in]	w1	Weight of the first sample
[in]	w2	Weight of the second sample
[in]	z1	Value of first variable
[in]	z2	Value of second variable
[in]	dist	Distance
[in]	value	Variogram value

Implements gstlrn::AVario.

compute()

Id gstlrn::VMap::compute	(	Db *	db,
		Id	radius,
		bool	flag_FFT = true,
		const ECalcVario &	calculType = ECalcVario::fromKey("VARIOGRAM"),
		bool	flag_ergodic = true,
		const NamingConvention &	namconv = NamingConvention("VMAP")
	)

Calculate the variogram map

Returns

Error return code

Parameters

[in]	db	Db containing the data
[in]	radius	Dilation radius (smooth resulting maps) only on points
[in]	flag_FFT	Use FFT method (only valid on grid)
[in]	calculType	Type of calculation (ECalcVario... only symmetrical ones)
[in]	flag_ergodic	Use ergodic assumption
[in]	namconv	Naming convention

operator=()

VMap & gstlrn::VMap::operator=

(

const VMap &

r

)

toString()

String gstlrn::VMap::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

AStringable Interface.

Reimplemented from gstlrn::AStringable.

Member Data Documentation

DECLARE_TOTL

gstlrn::VMap::DECLARE_TOTL

ICloneable interface.

Has a specific implementation in the Target language

---

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

• include/Variogram/VMap.hpp
• src/Variogram/VMap.cpp