gstlrn::VCloud Class Reference

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

#include <VCloud.hpp>

Inheritance diagram for gstlrn::VCloud:

Detailed Description

Class containing the Variogram Cloud 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
	VCloud (DbGrid *dbcloud, const VarioParam *varioparam)
	VCloud (const VCloud &r)
VCloud &	operator= (const VCloud &r)
virtual	~VCloud ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable Interface.
double	_getIVAR (const Db *db, Id iech, Id ivar) const override
	AVCloud 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, const ECalcVario &calculType=ECalcVario::fromKey("VARIOGRAM"), bool flag_ergodic=true, const NamingConvention &namconv=NamingConvention("Cloud"))
Id	selectFromPolygon (Db *db, Polygons *polygon, Id idir=0)
void	dumpStorage (Id mode=0, double distmax=TEST, double varmin=0., Id npairmax=ITEST, Id ndataMax=ITEST)
	Dump the storage of variogram pair calculations.
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

VCloud() [1/2]

gstlrn::VCloud::VCloud	(	DbGrid *	dbcloud,
		const VarioParam *	varioparam
	)

VCloud() [2/2]

gstlrn::VCloud::VCloud

(

const VCloud &

r

)

~VCloud()

gstlrn::VCloud::~VCloud ( )

virtual

Member Function Documentation

_getIVAR()

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

overridevirtual

AVCloud Interface.

Implements gstlrn::AVario.

_setAVarioResult()

void gstlrn::VCloud::_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 VCloud 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::VCloud::compute	(	Db *	db,
		const ECalcVario &	calculType = ECalcVario::fromKey("VARIOGRAM"),
		bool	flag_ergodic = true,
		const NamingConvention &	namconv = NamingConvention("Cloud")
	)

Evaluate the experimental variogram cloud on irregular data This method creates one variable per direction of 'dirparam'

Returns

Error return code

Parameters

[in]	db	Db descriptor
[in]	calculType	Calculation type
[in]	flag_ergodic	Ergodic flag
[in]	namconv	Naming convention

dumpStorage()

void gstlrn::VCloud::dumpStorage	(	Id	mode = 0,
		double	distmax = TEST,
		double	varmin = 0.,
		Id	npairmax = ITEST,
		Id	ndatamax = ITEST
	)

Dump the storage of variogram pair calculations.

Parameters

mode	See remarks
distmax	Maximum distance for pairs to be considered (mode=1 or 2)
varmin	Minimum variogram value for pairs to be considered (mode=2)
npairmax	Maximum number of pairs to be displayed (mode=1)
ndatamax	Maximum number of data to be displayed (mode=2)

Remarks

The argument 'mode' can be:

• 0 : Full dump of all the pairs
• 1 : Printout of the pairs (up to 'nparimax') with largest variogram values for a distance lower then 'distmax'
• 2 : Printout of the sample mostly involved in large varioagrma value (> 'varmin') for a distance lower then 'distmax'

operator=()

VCloud & gstlrn::VCloud::operator=

(

const VCloud &

r

)

selectFromPolygon()

Id gstlrn::VCloud::selectFromPolygon	(	Db *	db,
		Polygons *	polygon,
		Id	idir = 0
	)

Check the samples which are involved in the pairs which are located within the polygon

Parameters

[in]	db	Db descriptor
[in]	polygon	Polygons structure
[in]	idir	Rank of the direction of itnerest

toString()

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

overridevirtual

AStringable Interface.

Reimplemented from gstlrn::AStringable.

Member Data Documentation

DECLARE_TOTL

gstlrn::VCloud::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/VCloud.hpp
• src/Variogram/VCloud.cpp