Class containing the Spatial Characteristics as calculated experimentally from the data (contained in a Db). More...

#include <Vario.hpp>

Inheritance diagram for gstlrn::Vario:

Detailed Description

Class containing the Spatial Characteristics as calculated experimentally from the data (contained in a Db).

The experimental Spatial Characteristics is usually referred to as the experimental variogram. However, note that it can rather calculate other results such as a Covariance or a Madogram, Rodogram. All these quantities can be regrouped by considering them as two-points statistics. For a complete list of calculation methods, please refer to ECalcVario.hpp.

This class is composed of two parts:

the first part describes the rule when comparing two samples from the Db. They are defined by:
- the definition of the Geometry: e.g. definition of calculation direction, tolerances. For more information, please refer to VarioParam.hpp
- the definition of the calculations Options: e.g. calculation method.
- some additional Conditions used during calculations: e.g. usage of Faults. For more information, please refer to ABiTargetCheck.hpp.
the second part are the results of the calculations

Results

All the Spatial Characteristics are calculated:

from the sample values of active samples contained in a Db,
for all the variables (defined with the locator ELoc.Z): in the multivariate case, simple and cross-variograms are calculated
for a series of distance lags.

They are always expressed as a table with one row per distance lag and three columns containing:

the number of pairs
the average value of the distance
the average value of the two-points statistics

Note that:

the lags for which no pair is found are skipped.
some methods correspond to an even function (values are equal whether the distance between the two end-points is counted positively or negatively: then only one-sided results are stored. For odd, the results of both sides are stored.
for a number of lags equal to N, the number of rows is {N+1} when the function is even and {2N+1} when the function is odd.
in the multivariate case (NV variables), the number of rows is multiplied by NV*(NV+1)/2. In order to avoid any indexing problem, the user should use the assessors provided in order to access to the information relative to the target pair of variables.

Public Member Functions
	Vario (const VarioParam &varioparam)

	Vario (const Vario &r)

Vario &	operator= (const Vario &r)

virtual	~Vario ()

String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable Interface.

String	getNFName () const override
	ASerializable 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

void	resetReduce (const 1 &varcols, const 1 &dircols, bool asSymmetric=false)

bool	isFittable () const

bool	drawOnlyPositiveX (Id ivar, Id jvar) const

bool	drawOnlyPositiveY (Id ivar, Id jvar) const

Id	getNVar () const

const &	getMeans () const

double	getMean (Id ivar) const

double	getVar (Id ivar=0, Id jvar=0) const

MatrixSymmetric	getVarMatrix () const

double	getVarIndex (Id ijvar) const

const &	getVars () const

void	setMeans (const 1 &means)

void	setMean (double mean, Id ivar=0)

void	setVar (double value, Id ivar=0, Id jvar=0)

void	setVars (const 1 &vars)

void	setVarIndex (Id ijvar, double value)

void	setDb (Db *db)

Id	getDirSize (Id idir) const

double	getGgByIndex (Id idir=0, Id i=0) const

double	getHhByIndex (Id idir=0, Id i=0) const

double	getSwByIndex (Id idir=0, Id i=0) const

double	getUtilizeByIndex (Id idir=0, Id i=0) const

double	getGg (Id idir=0, Id ivar=0, Id jvar=0, Id ilag=0, bool asCov=false, bool flagNormalized=false) const

double	getHh (Id idir=0, Id ivar=0, Id jvar=0, Id ilag=0) const

double	getSw (Id idir=0, Id ivar=0, Id jvar=0, Id ilag=0) const

double	getUtilize (Id idir=0, Id ivar=0, Id jvar=0, Id ilag=0) const

	getVec (Id idir=0, Id ivar=0, Id jvar=0) const

	getGgVec (Id idir=0, Id ivar=0, Id jvar=0, bool asCov=false, bool flagNormalized=false, bool compress=true) const

	getHhVec (Id idir=0, Id ivar=0, Id jvar=0, bool compress=true) const

	getSwVec (Id idir=0, Id ivar=0, Id jvar=0, bool compress=true) const

	getUtilizeVec (Id idir=0, Id ivar=0, Id jvar=0, bool compress=true) const

void	setSwVec (Id idir, Id ivar, Id jvar, const 1 &sw)

void	setHhVec (Id idir, Id ivar, Id jvar, const 1 &hh)

void	setGgVec (Id idir, Id ivar, Id jvar, const 1 &gg)

	getGgs (Id idir=0, Id ivar=0, Id jvar=0, const 1 &ilag=1()) const

	setGgs (Id idir, Id ivar, Id jvar, const 1 &ilag, const 1 &values)

const &	getAllGg (Id idir=0) const

const &	getAllHh (Id idir=0) const

const &	getAllSw (Id idir=0) const

const &	getAllUtilize (Id idir=0) const

void	setGgByIndex (Id idir, Id i, double gg)

void	setHhByIndex (Id idir, Id i, double hh)

void	setSwByIndex (Id idir, Id i, double sw)

void	setUtilizeByIndex (Id idir, Id i, double utilize)

void	setSw (Id idir, Id ivar, Id jvar, Id ilag, double sw)

void	setHh (Id idir, Id ivar, Id jvar, Id ilag, double hh)

void	setGg (Id idir, Id ivar, Id jvar, Id ilag, double gg)

void	setUtilize (Id idir, Id ivar, Id jvar, Id ilag, double utilize)

void	updateSwByIndex (Id idir, Id i, double sw)

void	updateHhByIndex (Id idir, Id i, double hh)

void	updateGgByIndex (Id idir, Id i, double gg)

void	updateLocalMeans (Id idir, Id iad, Id ivar, Id jvar, double w1, double w2, double z1, double z2)

Id	getCenter (Id ivar=0, Id jvar=0, Id idir=0) const

Id	getNext (Id ivar=0, Id jvar=0, Id idir=0, Id shift=1) const

void	internalVariableResize ()

void	internalMemoryResize (Id ndir=0, bool flagDirs=true)

double	getHmax (Id ivar=-1, Id jvar=-1, Id idir=-1) const

	getHRange (Id ivar=-1, Id jvar=-1, Id idir=-1) const

double	getGmax (Id ivar=-1, Id jvar=-1, Id idir=-1, bool flagAbs=false, bool flagSill=false) const

	getGRange (Id ivar=-1, Id jvar=-1, Id idir=-1, bool flagSill=false) const

void	patchCenter (Id idir, Id nech, double rho)

void	localCenterAndScale (Id idir)

Id	fill (Id idir, const 1 &sw, const 1 &gg, const 1 &hh)

Id	getAddressForGg (Id idir, Id ivar, Id jvar, Id ilag, Id orient=ITEST) const
	Reyurns the address for storage in sw, hh, gg arrays. It takes into account the variable ordering and the possible asymmetry flag.

Id	getAddressCenterForGg (Id idir, Id ivar, Id jvar) const

Id	getVarAddress (Id ivar, Id jvar) const

Id	getLagAddress (Id idir, Id ilag, Id orient=0) const

Id	getLagCenterAddress (Id idir) const

Id	getNLagTotal (Id idir) const

Id	compute (Db db, const ECalcVario &calculType=ECalcVario::fromKey("VARIOGRAM"), bool flag_ergodic=true, bool flag_sample=false, bool verr_mode=false, const Model model=nullptr, Id niter_UK=0, bool verbose=false)

Id	computeIndic (Db db, const ECalcVario &calculType=ECalcVario::fromKey("VARIOGRAM"), bool flag_ergodic=true, bool flag_sample=false, bool verr_mode=false, const Model model=nullptr, Id niter_UK=0, bool verbose=false, Id nfacmax=-1)

Id	computeGeometry (Db db, Vario_Order vorder, Id *npair)

Id	computeVarioVect (Db *db, Id ncomp)

Id	computeGeometryMLayers (Db db, 1 &seltab, Vario_Order vorder) const

Id	regularizeFromModel (const Model &model, const 1 &ext, const 1 &ndisc, const 1 &angles=1(), const CovCalcMode *mode=nullptr, bool asCov=false)

Id	regularizeFromDbGrid (Model model, const Db &db, const CovCalcMode mode=nullptr)

void	getExtension (Id ivar, Id jvar, Id idir0, Id flag_norm, Id flag_vars, double distmin, double distmax, double varmin, double varmax, Id flag_hneg, Id flag_gneg, double c0, double hmin, double hmax, double gmin, double *gmax)

Id	sampleModel (Model model, const CovCalcMode mode=nullptr)

const DirParam &	getDirParam (Id idir) const

Id	getNDir () const

const &	getDates () const

bool	hasDate () const

double	getDates (Id idate, Id icas) const

Id	getNDate () const

double	getScale () const

Id	getNDim () const

ASpaceSharedPtr	getSpace () const

void	setScale (double scale)

void	addDirs (const DirParam &dirparam)

Id	getNLag (Id idir) const

double	getDPas (Id idir) const

Id	getNDim (Id idir) const

	getCodirs (Id idir) const

double	getCodir (Id idir, Id idim) const

double	getMaximumDistance (Id idir) const

double	getMaximumDistance () const

Id	getIdate (Id idir) const

	getGrincrs (Id idir) const

double	getGrincr (Id idir, Id idim) const

bool	isDefinedForGrid () const

void	setNVar (Id nvar)

void	setVariableNames (const VectorString &variableNames)

void	setVariableName (Id ivar, const String &variableName)

Id	prepare (const ECalcVario &calculType=ECalcVario::fromKey("VARIOGRAM"), bool flag_ergodic=true, bool defineList=true)

const VarioParam &	getVarioParam () const

Id	getNBiPtsPerDir () const

const ABiTargetCheck *	getBipts (Id idir, Id rank) const

bool	keepPair (Id idir, SpaceTarget &T1, SpaceTarget &T2, double *dist) const

Id	getRankFromDirAndDate (Id idir, Id idate) const

const VectorString &	getVariableNames () const

String	getVariableName (Id ivar) const

Id	transformCut (Id nh, double ycut)

Id	transformZToY (const AAnam *anam)

Id	transformYToZ (const AAnam *anam)

bool	isLagCorrect (Id idir, Id k) const

double	getC00 (Id idir, Id ivar, Id jvar) const

	computeWeightPerDirection () const

Id	getTotalLagsPerDirection () const

	computeWeightsFromVario (Id wmode) const

void	finalScaleByWeights (Id idir)

void	varioDump (Id idir=0, const String &title=String()) const

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 Member Functions inherited from gstlrn::ASerializable
	ASerializable ()

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

	ASerializable (ASerializable &&r) noexcept

ASerializable &	operator= (ASerializable &&r) noexcept

virtual	~ASerializable ()

bool	dumpToNF (const String &NFFilename, const EFormatNF &format=EFormatNF::fromKey("DEFAULT")) const
	Dump the contents of an object into an Output File using a given Output NF Format.

void	setDefaultFormatNF (const EFormatNF &format)

Static Public Member Functions
static Vario *	create (const VarioParam &varioparam)

static Vario *	createFromNF (const String &NFFilename, bool verbose=true)

static Vario *	createRegularizeFromModel (const Model &model, const VarioParam &varioparam, const 1 &ext, const 1 &ndisc, const 1 &angles, bool asCov=false)

static Vario *	createTransformZToY (const Vario &varioZ, const AAnam *anam)

static Vario *	createTransformYToZ (const Vario &varioY, const AAnam *anam)

static Vario *	createReduce (const Vario &varioIn, const 1 &varcols, const 1 &dircols, bool asSymmetric=false)

static Vario *	computeFromDb (const VarioParam &varioparam, Db db, const ECalcVario &calculType=ECalcVario::fromKey("VARIOGRAM"), bool flag_ergodic=true, bool flag_sample=false, bool verr_mode=false, Model model=nullptr, Id niter_UK=0, bool verbose=false)

static Id	getIJVarAddress (Id ivar, Id jvar)

Static Public Member Functions inherited from gstlrn::ASerializable
static String	buildFileName (Id status, const String &filename, bool ensureDirExist=false)

static String	getFileIdentity (const String &filename, bool verbose=false)

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getPrefixName ()

Public Attributes
	DECLARE_TOTL
	ICloneable interface.

Constructor & Destructor Documentation

◆ Vario() [1/2]

gstlrn::Vario::Vario ( const VarioParam & varioparam )

Build a Vario object by calculating the experimental variogram

Parameters

varioparam VarioParam structure

◆ Vario() [2/2]

gstlrn::Vario::Vario ( const Vario & r )

◆ ~Vario()

gstlrn::Vario::~Vario ( )

virtual

Member Function Documentation

◆ _getIVAR()

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

overridevirtual

AVario Interface.

Calculate the data value (possibly after removing the global trend)

Returns: The data value (or the residual)

Parameters

[in]	db	Db descriptor
[in]	iech	Rank of the sample
[in]	ivar	Rank of the variable

Remarks: The trend removal only applies on the first variable; Therefore, if applied on any variable rank other than 0,; TEST is returned

Implements gstlrn::AVario.

◆ _setAVarioResult()

void gstlrn::Vario::_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 variogram 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.

◆ addDirs()

void gstlrn::Vario::addDirs ( const DirParam & dirparam )

inline

◆ compute()

Id gstlrn::Vario::compute	(	Db *	db,
		const ECalcVario &	calculType = `ECalcVario::fromKey("VARIOGRAM")`,
		bool	flag_ergodic = `true`,
		bool	flag_sample = `false`,
		bool	verr_mode = `false`,
		const Model *	model = `nullptr`,
		Id	niter_UK = `0`,
		bool	verbose = `false`
	)

◆ computeFromDb()

Vario * gstlrn::Vario::computeFromDb	(	const VarioParam &	varioparam,
		Db *	db,
		const ECalcVario &	calculType = `ECalcVario::fromKey("VARIOGRAM")`,
		bool	flag_ergodic = `true`,
		bool	flag_sample = `false`,
		bool	verr_mode = `false`,
		Model *	model = `nullptr`,
		Id	niter_UK = `0`,
		bool	verbose = `false`
	)

static

◆ computeGeometry()

Id gstlrn::Vario::computeGeometry	(	Db *	db,
		Vario_Order *	vorder,
		Id *	npair
	)

Calculate the geometry for a given direction

Returns: Error return code

Parameters

[in]	db	Db description
[out]	vorder	Vario_Order structure
[out]	npair	Number of pairs

◆ computeGeometryMLayers()

Id gstlrn::Vario::computeGeometryMLayers	(	Db *	db,
		1 &	seltab,
		Vario_Order *	vorder
	)		const

Determine the samples used for a variogram in multilayers framework

Returns: Error return code

Parameters

[in]	db	Db description
[in]	seltab	Number of sample definition (0, 1 or 2)
[out]	vorder	Vario_Order structure

◆ computeIndic()

Id gstlrn::Vario::computeIndic	(	Db *	db,
		const ECalcVario &	calculType = `ECalcVario::fromKey("VARIOGRAM")`,
		bool	flag_ergodic = `true`,
		bool	flag_sample = `false`,
		bool	verr_mode = `false`,
		const Model *	model = `nullptr`,
		Id	niter_UK = `0`,
		bool	verbose = `false`,
		Id	nfacmax = `-1`
	)

◆ computeVarioVect()

Id gstlrn::Vario::computeVarioVect	(	Db *	db,
		Id	ncomp
	)

Evaluate the experimental covariance for directional variables

Returns: Error return code

Parameters

[in]	db	Db descriptor
[in]	ncomp	Number of components

◆ computeWeightPerDirection()

gstlrn::Vario::computeWeightPerDirection ( ) const

◆ computeWeightsFromVario()

gstlrn::Vario::computeWeightsFromVario ( Id wmode ) const

◆ create()

Vario * gstlrn::Vario::create ( const VarioParam & varioparam )

static

◆ createFromNF()

Vario * gstlrn::Vario::createFromNF	(	const String &	NFFilename,
		bool	verbose = `true`
	)

static

◆ createReduce()

Vario * gstlrn::Vario::createReduce	(	const Vario &	varioIn,
		const 1 &	varcols,
		const 1 &	dircols,
		bool	asSymmetric = `false`
	)

static

◆ createRegularizeFromModel()

Vario * gstlrn::Vario::createRegularizeFromModel	(	const Model &	model,
		const VarioParam &	varioparam,
		const 1 &	ext,
		const 1 &	ndisc,
		const 1 &	angles,
		bool	asCov = `false`
	)

static

◆ createTransformYToZ()

Vario * gstlrn::Vario::createTransformYToZ	(	const Vario &	varioY,
		const AAnam *	anam
	)

static

◆ createTransformZToY()

Vario * gstlrn::Vario::createTransformZToY	(	const Vario &	varioZ,
		const AAnam *	anam
	)

static

◆ drawOnlyPositiveX()

bool gstlrn::Vario::drawOnlyPositiveX	(	Id	ivar,
		Id	jvar
	)		const

◆ drawOnlyPositiveY()

bool gstlrn::Vario::drawOnlyPositiveY	(	Id	ivar,
		Id	jvar
	)		const

◆ fill()

Id gstlrn::Vario::fill	(	Id	idir,
		const 1 &	sw,
		const 1 &	gg,
		const 1 &	hh
	)

◆ finalScaleByWeights()

void gstlrn::Vario::finalScaleByWeights ( Id idir )

Scale the variogram calculations

Parameters

[in] idir Rank of the Direction

◆ getAddressCenterForGg()

Id gstlrn::Vario::getAddressCenterForGg	(	Id	idir,
		Id	ivar,
		Id	jvar
	)		const

◆ getAddressForGg()

Id gstlrn::Vario::getAddressForGg	(	Id	idir,
		Id	ivar,
		Id	jvar,
		Id	ilag,
		Id	orient = `ITEST`
	)		const

Reyurns the address for storage in sw, hh, gg arrays. It takes into account the variable ordering and the possible asymmetry flag.

Parameters

idir	Rank of the direction
ivar	Rank of the first variable
jvar	Rank of the second variable
ilag	Rank of the lag (see remarks)
orient	Orientation (see remarks)

Returns: Id

Remarks

The returned address depends on the pair of variables and on the asymetry flag

if False, it relies on the rank 'ilag'
if True, it relies on the rank 'ilag' and the orientation 'orient'. For N lags:
- orient = 1 for positive lags, returns N + 'ilag'
- orient = -1 for negative lags, returns N - 'ilag' - 1
- orient = 0 for the center lag, returns N If orient = ITEST, it relies on the rank 'ilag' (regardless of the asymetry)

◆ getAllGg()

const & gstlrn::Vario::getAllGg ( Id idir = 0 ) const

◆ getAllHh()

const & gstlrn::Vario::getAllHh ( Id idir = 0 ) const

◆ getAllSw()

const & gstlrn::Vario::getAllSw ( Id idir = 0 ) const

◆ getAllUtilize()

const & gstlrn::Vario::getAllUtilize ( Id idir = 0 ) const

◆ getBipts()

const ABiTargetCheck * gstlrn::Vario::getBipts	(	Id	idir,
		Id	rank
	)		const

inline

◆ getC00()

double gstlrn::Vario::getC00	(	Id	idir,
		Id	ivar,
		Id	jvar
	)		const

◆ getCenter()

Id gstlrn::Vario::getCenter	(	Id	ivar = `0`,
		Id	jvar = `0`,
		Id	idir = `0`
	)		const

◆ getCodir()

double gstlrn::Vario::getCodir	(	Id	idir,
		Id	idim
	)		const

◆ getCodirs()

gstlrn::Vario::getCodirs ( Id idir ) const

◆ getDates() [1/2]

const & gstlrn::Vario::getDates ( ) const

inline

◆ getDates() [2/2]

double gstlrn::Vario::getDates	(	Id	idate,
		Id	icas
	)		const

inline

◆ getDirParam()

const DirParam & gstlrn::Vario::getDirParam ( Id idir ) const

inline

◆ getDirSize()

Id gstlrn::Vario::getDirSize ( Id idir ) const

Returns the Dimension of internal arrays after the number of variables has been defined

Parameters

idir	Target direction

Returns

◆ getDPas()

double gstlrn::Vario::getDPas ( Id idir ) const

inline

◆ getExtension()

void gstlrn::Vario::getExtension	(	Id	ivar,
		Id	jvar,
		Id	idir0,
		Id	flag_norm,
		Id	flag_vars,
		double	distmin,
		double	distmax,
		double	varmin,
		double	varmax,
		Id *	flag_hneg,
		Id *	flag_gneg,
		double *	c0,
		double *	hmin,
		double *	hmax,
		double *	gmin,
		double *	gmax
	)

Calculate the variogram extension for a pair of variables

Parameters

[in]	ivar	Rank of the first variable
[in]	jvar	Rank of the second variable
[in]	idir0	Rank of the direction (-1 for all)
[in]	flag_norm	1 if the variogram must be normalized by variance
[in]	flag_vars	1 if the global statistics must be taken into account
[in]	distmin	Minimum along the distance axis
[in]	distmax	Maximum along the distance axis
[in]	varmin	Minimum along the variogram (or covariance) axis
[in]	varmax	Maximum along the variogram (or covariance) axis
[out]	flag_hneg	1 if the distance scale can be negative
[out]	flag_gneg	1 if the variogram scale can be negative
[out]	c0	Value of the variogram at the origin
[out]	hmin	Minimum distance
[out]	hmax	Maximum distance
[out]	gmin	Minimum variogram value
[out]	gmax	Maximum variogram value

◆ getGg()

double gstlrn::Vario::getGg	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		Id	ilag = `0`,
		bool	asCov = `false`,
		bool	flagNormalized = `false`
	)		const

◆ getGgByIndex()

double gstlrn::Vario::getGgByIndex	(	Id	idir = `0`,
		Id	i = `0`
	)		const

◆ getGgs()

gstlrn::Vario::getGgs	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		const 1 &	ilag = `1()`
	)		const

◆ getGgVec()

gstlrn::Vario::getGgVec	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		bool	asCov = `false`,
		bool	flagNorm = `false`,
		bool	compress = `true`
	)		const

Returns the vector of variogram values for a given pair of variables in a given direction

Parameters

idir	Direction
ivar	First variable
jvar	Second variable
asCov	True if result should be provided as Covariance, False for Variogram
flagNorm	If the result should be provided as a Normalized covariance / Variogram
compress	When true, suppress lags where 'sw' <= 0

Returns: The vector of 'gg'

◆ getGmax()

double gstlrn::Vario::getGmax	(	Id	ivar = `-1`,
		Id	jvar = `-1`,
		Id	idir = `-1`,
		bool	flagAbs = `false`,
		bool	flagSill = `false`
	)		const

◆ getGRange()

gstlrn::Vario::getGRange	(	Id	ivar = `-1`,
		Id	jvar = `-1`,
		Id	idir = `-1`,
		bool	flagSill = `false`
	)		const

◆ getGrincr()

double gstlrn::Vario::getGrincr	(	Id	idir,
		Id	idim
	)		const

inline

◆ getGrincrs()

gstlrn::Vario::getGrincrs ( Id idir ) const

inline

◆ getHh()

double gstlrn::Vario::getHh	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		Id	ilag = `0`
	)		const

◆ getHhByIndex()

double gstlrn::Vario::getHhByIndex	(	Id	idir = `0`,
		Id	i = `0`
	)		const

◆ getHhVec()

gstlrn::Vario::getHhVec	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		bool	compress = `true`
	)		const

Returns the vector of distances for a given pair of variables in a given direction

Parameters

idir	Direction
ivar	First variable
jvar	Second variable
compress	When true, suppress lags where 'sw' <= 0

Returns: The vector of 'hh'

◆ getHmax()

double gstlrn::Vario::getHmax	(	Id	ivar = `-1`,
		Id	jvar = `-1`,
		Id	idir = `-1`
	)		const

◆ getHRange()

gstlrn::Vario::getHRange	(	Id	ivar = `-1`,
		Id	jvar = `-1`,
		Id	idir = `-1`
	)		const

Returns a vector with Minimum-Maximum of the Hh array

Parameters

ivar	Target variable (or -1)
jvar	Target variable (or -1)
idir	Target Direction (or -1)

Returns

◆ getIdate()

Id gstlrn::Vario::getIdate ( Id idir ) const

inline

◆ getIJVarAddress()

Id gstlrn::Vario::getIJVarAddress	(	Id	ivar,
		Id	jvar
	)

static

◆ getLagAddress()

Id gstlrn::Vario::getLagAddress	(	Id	idir,
		Id	ilag,
		Id	orient = `0`
	)		const

◆ getLagCenterAddress()

Id gstlrn::Vario::getLagCenterAddress ( Id idir ) const

◆ getMaximumDistance() [1/2]

double gstlrn::Vario::getMaximumDistance ( ) const

◆ getMaximumDistance() [2/2]

double gstlrn::Vario::getMaximumDistance ( Id idir ) const

inline

◆ getMean()

double gstlrn::Vario::getMean ( Id ivar ) const

◆ getMeans()

const & gstlrn::Vario::getMeans ( ) const

inline

◆ getNBiPtsPerDir()

Id gstlrn::Vario::getNBiPtsPerDir ( ) const

inline

◆ getNDate()

Id gstlrn::Vario::getNDate ( ) const

inline

◆ getNDim() [1/2]

Id gstlrn::Vario::getNDim ( ) const

inline

◆ getNDim() [2/2]

Id gstlrn::Vario::getNDim ( Id idir ) const

inline

◆ getNDir()

Id gstlrn::Vario::getNDir ( ) const

inline

◆ getNext()

Id gstlrn::Vario::getNext	(	Id	ivar = `0`,
		Id	jvar = `0`,
		Id	idir = `0`,
		Id	shift = `1`
	)		const

◆ getNFName()

String gstlrn::Vario::getNFName ( ) const

inlineoverridevirtual

ASerializable Interface.

Implements gstlrn::ASerializable.

◆ getNLag()

Id gstlrn::Vario::getNLag ( Id idir ) const

inline

◆ getNLagTotal()

Id gstlrn::Vario::getNLagTotal ( Id idir ) const

◆ getNVar()

Id gstlrn::Vario::getNVar ( ) const

inline

◆ getRankFromDirAndDate()

Id gstlrn::Vario::getRankFromDirAndDate	(	Id	idir,
		Id	idate
	)		const

Ask for the rank of the 'vardir' structure, given direction and date

Returns: Absolute rank (or -1 for error)

Parameters

[in]	idir	Rank for the direction (starting from 0)
[in]	idate	Rank for the Date (starting from 0)

Remarks: An error occurs if 'idir' is negative or larger than 'ndir'; or if 'idate' is negative or larger than 'ndate'

◆ getScale()

double gstlrn::Vario::getScale ( ) const

inline

◆ getSpace()

ASpaceSharedPtr gstlrn::Vario::getSpace ( ) const

inline

◆ getSw()

double gstlrn::Vario::getSw	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		Id	ilag = `0`
	)		const

◆ getSwByIndex()

double gstlrn::Vario::getSwByIndex	(	Id	idir = `0`,
		Id	i = `0`
	)		const

◆ getSwVec()

gstlrn::Vario::getSwVec	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		bool	compress = `true`
	)		const

Returns the vector of weights for a given pair of variables in a given direction

Parameters

idir	Direction
ivar	First variable
jvar	Second variable
compress	When true, suppress lags where 'sw' <= 0

Returns: The vector of 'sw'

◆ getTotalLagsPerDirection()

Id gstlrn::Vario::getTotalLagsPerDirection ( ) const

◆ getUtilize()

double gstlrn::Vario::getUtilize	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		Id	ilag = `0`
	)		const

◆ getUtilizeByIndex()

double gstlrn::Vario::getUtilizeByIndex	(	Id	idir = `0`,
		Id	i = `0`
	)		const

◆ getUtilizeVec()

gstlrn::Vario::getUtilizeVec	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`,
		bool	compress = `true`
	)		const

Returns the vector of utilization flags for a given pair of variables in a given direction

Parameters

idir	Direction
ivar	First variable
jvar	Second variable
compress	When true, suppress lags where 'sw' <= 0

Returns: The vector of 'utilize'

◆ getVar()

double gstlrn::Vario::getVar	(	Id	ivar = `0`,
		Id	jvar = `0`
	)		const

◆ getVarAddress()

Id gstlrn::Vario::getVarAddress	(	Id	ivar,
		Id	jvar
	)		const

◆ getVariableName()

String gstlrn::Vario::getVariableName ( Id ivar ) const

◆ getVariableNames()

const VectorString & gstlrn::Vario::getVariableNames ( ) const

inline

◆ getVarIndex()

double gstlrn::Vario::getVarIndex ( Id ijvar ) const

◆ getVarioParam()

const VarioParam & gstlrn::Vario::getVarioParam ( ) const

inline

◆ getVarMatrix()

MatrixSymmetric gstlrn::Vario::getVarMatrix ( ) const

◆ getVars()

const & gstlrn::Vario::getVars ( ) const

inline

◆ getVec()

gstlrn::Vario::getVec	(	Id	idir = `0`,
		Id	ivar = `0`,
		Id	jvar = `0`
	)		const

Returns a triple array of values: 0-Weight; 1-Distance; 2-Variogram

Parameters

idir	Target Direction
ivar	Target first variable
jvar	Target second variable

Returns

◆ hasDate()

bool gstlrn::Vario::hasDate ( ) const

inline

◆ internalMemoryResize()

void gstlrn::Vario::internalMemoryResize	(	Id	ndir = `0`,
		bool	flagDirs = `true`
	)

◆ internalVariableResize()

void gstlrn::Vario::internalVariableResize ( )

◆ isDefinedForGrid()

bool gstlrn::Vario::isDefinedForGrid ( ) const

inline

◆ isFittable()

bool gstlrn::Vario::isFittable ( ) const

◆ isLagCorrect()

bool gstlrn::Vario::isLagCorrect	(	Id	idir,
		Id	k
	)		const

◆ keepPair()

bool gstlrn::Vario::keepPair	(	Id	idir,
		SpaceTarget &	T1,
		SpaceTarget &	T2,
		double *	dist
	)		const

◆ localCenterAndScale()

void gstlrn::Vario::localCenterAndScale ( Id idir )

◆ operator=()

Vario & gstlrn::Vario::operator= ( const Vario & r )

◆ patchCenter()

void gstlrn::Vario::patchCenter	(	Id	idir,
		Id	nech,
		double	rho
	)

◆ prepare()

Id gstlrn::Vario::prepare	(	const ECalcVario &	calculType = `ECalcVario::fromKey("VARIOGRAM")`,
		bool	flag_ergodic = `true`,
		bool	defineList = `true`
	)

◆ regularizeFromDbGrid()

Id gstlrn::Vario::regularizeFromDbGrid	(	Model *	model,
		const Db &	db,
		const CovCalcMode *	mode = `nullptr`
	)

Calculate the regularized model as an experimental variogram

Returns: Error return code

Parameters

[in]	model	Model structure
[in]	db	Db discretization structure
[in]	mode	CovCalcMode structure

◆ regularizeFromModel()

Id gstlrn::Vario::regularizeFromModel	(	const Model &	model,
		const 1 &	ext,
		const 1 &	ndisc,
		const 1 &	angles = `1()`,
		const CovCalcMode *	mode = `nullptr`,
		bool	asCov = `false`
	)

Calculate the regularized model as an experimental variogram

Returns: Error return code

Parameters

[in]	model	Model structure
[in]	ext	Vector of Block extension
[in]	ndisc	Vector of discretization counts
[in]	angles	Vector of rotation angles (optional)
[in]	mode	CovCalcMode structure
[in]	asCov	When true; produces a covariance

◆ resetReduce()

void gstlrn::Vario::resetReduce	(	const 1 &	varcols,
		const 1 &	dircols,
		bool	asSymmetric = `false`
	)

Reduce the current variogram by keeping a subset of variables and/or directions

Parameters

varcols	Vector of variable ranks (starting from 0)
dircols	Vector of direction ranks (starting from 0)
asSymmetric	Turn the result into as Symmetrical function (i.e. variogram)

◆ sampleModel()

Id gstlrn::Vario::sampleModel	(	Model *	model,
		const CovCalcMode *	mode = `nullptr`
	)

Calculates variogram values by sampling a model

Returns: Error return code

Parameters

[in]	model	Model structure
[in]	mode	CovCalcMode structure

◆ setDb()

void gstlrn::Vario::setDb ( Db * db )

◆ setGg()

void gstlrn::Vario::setGg	(	Id	idir,
		Id	ivar,
		Id	jvar,
		Id	ilag,
		double	gg
	)

◆ setGgByIndex()

void gstlrn::Vario::setGgByIndex	(	Id	idir,
		Id	i,
		double	gg
	)

◆ setGgs()

gstlrn::Vario::setGgs	(	Id	idir,
		Id	ivar,
		Id	jvar,
		const 1 &	ilag,
		const 1 &	values
	)

◆ setGgVec()

void gstlrn::Vario::setGgVec	(	Id	idir,
		Id	ivar,
		Id	jvar,
		const 1 &	gg
	)

◆ setHh()

void gstlrn::Vario::setHh	(	Id	idir,
		Id	ivar,
		Id	jvar,
		Id	ilag,
		double	hh
	)

◆ setHhByIndex()

void gstlrn::Vario::setHhByIndex	(	Id	idir,
		Id	i,
		double	hh
	)

◆ setHhVec()

void gstlrn::Vario::setHhVec	(	Id	idir,
		Id	ivar,
		Id	jvar,
		const 1 &	hh
	)

◆ setMean()

void gstlrn::Vario::setMean	(	double	mean,
		Id	ivar = `0`
	)

◆ setMeans()

void gstlrn::Vario::setMeans ( const 1 & means )

◆ setNVar()

void gstlrn::Vario::setNVar ( Id nvar )

inline

◆ setScale()

void gstlrn::Vario::setScale ( double scale )

inline

◆ setSw()

void gstlrn::Vario::setSw	(	Id	idir,
		Id	ivar,
		Id	jvar,
		Id	ilag,
		double	sw
	)

◆ setSwByIndex()

void gstlrn::Vario::setSwByIndex	(	Id	idir,
		Id	i,
		double	sw
	)

◆ setSwVec()

void gstlrn::Vario::setSwVec	(	Id	idir,
		Id	ivar,
		Id	jvar,
		const 1 &	sw
	)

◆ setUtilize()

void gstlrn::Vario::setUtilize	(	Id	idir,
		Id	ivar,
		Id	jvar,
		Id	ilag,
		double	utilize
	)

◆ setUtilizeByIndex()

void gstlrn::Vario::setUtilizeByIndex	(	Id	idir,
		Id	i,
		double	utilize
	)

◆ setVar()

void gstlrn::Vario::setVar	(	double	value,
		Id	ivar = `0`,
		Id	jvar = `0`
	)

◆ setVariableName()

void gstlrn::Vario::setVariableName	(	Id	ivar,
		const String &	variableName
	)

◆ setVariableNames()

void gstlrn::Vario::setVariableNames ( const VectorString & variableNames )

inline

◆ setVarIndex()

void gstlrn::Vario::setVarIndex	(	Id	ijvar,
		double	value
	)

◆ setVars()

void gstlrn::Vario::setVars ( const 1 & vars )

◆ toString()

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

overridevirtual

AStringable Interface.

Reimplemented from gstlrn::AStringable.

◆ transformCut()

Id gstlrn::Vario::transformCut	(	Id	nh,
		double	ycut
	)

Update the experimental variogram of the completed variable starting from the experimental variogram of the truncated variable This only functions in the monovariate case

Parameters

[in]	nh	Number of Hermite polynomials
[in]	ycut	Truncation (lowest) value

Returns: Error return code

◆ transformYToZ()

Id gstlrn::Vario::transformYToZ ( const AAnam * anam )

Calculate the experimental variogram of the Raw starting from the Model of the Gaussian variable

Returns: Error return code

Parameters

[in] anam Point anamorphosis

◆ transformZToY()

Id gstlrn::Vario::transformZToY ( const AAnam * anam )

Transform the experimental variogram from raw to gaussian space

Returns: Error return code

Parameters

[in] anam Point Hermite anamorphosis

◆ updateGgByIndex()

void gstlrn::Vario::updateGgByIndex	(	Id	idir,
		Id	i,
		double	gg
	)

◆ updateHhByIndex()

void gstlrn::Vario::updateHhByIndex	(	Id	idir,
		Id	i,
		double	hh
	)

◆ updateLocalMeans()

void gstlrn::Vario::updateLocalMeans	(	Id	idir,
		Id	iad,
		Id	ivar,
		Id	jvar,
		double	w1,
		double	w2,
		double	z1,
		double	z2
	)

◆ updateSwByIndex()

void gstlrn::Vario::updateSwByIndex	(	Id	idir,
		Id	i,
		double	sw
	)

◆ varioDump()

void gstlrn::Vario::varioDump	(	Id	idir = `0`,
		const String &	title = `String()`
	)		const

Member Data Documentation

◆ DECLARE_TOTL

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

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ Vario() [1/2]

◆ Vario() [2/2]

◆ ~Vario()

Member Function Documentation

◆ _getIVAR()

◆ _setAVarioResult()

◆ addDirs()

◆ compute()

◆ computeFromDb()

◆ computeGeometry()

◆ computeGeometryMLayers()

◆ computeIndic()

◆ computeVarioVect()

◆ computeWeightPerDirection()

◆ computeWeightsFromVario()

◆ create()

◆ createFromNF()

◆ createReduce()

◆ createRegularizeFromModel()

◆ createTransformYToZ()

◆ createTransformZToY()

◆ drawOnlyPositiveX()

◆ drawOnlyPositiveY()

◆ fill()

◆ finalScaleByWeights()

◆ getAddressCenterForGg()

◆ getAddressForGg()

◆ getAllGg()

◆ getAllHh()

◆ getAllSw()

◆ getAllUtilize()

◆ getBipts()

◆ getC00()

◆ getCenter()

◆ getCodir()

◆ getCodirs()

◆ getDates() [1/2]

◆ getDates() [2/2]

◆ getDirParam()

◆ getDirSize()

◆ getDPas()

◆ getExtension()

◆ getGg()

◆ getGgByIndex()

◆ getGgs()

◆ getGgVec()

◆ getGmax()

◆ getGRange()

◆ getGrincr()

◆ getGrincrs()

◆ getHh()

◆ getHhByIndex()

◆ getHhVec()

◆ getHmax()

◆ getHRange()

◆ getIdate()

◆ getIJVarAddress()

◆ getLagAddress()

◆ getLagCenterAddress()

◆ getMaximumDistance() [1/2]

◆ getMaximumDistance() [2/2]

◆ getMean()

◆ getMeans()

◆ getNBiPtsPerDir()

◆ getNDate()

◆ getNDim() [1/2]

◆ getNDim() [2/2]

◆ getNDir()

◆ getNext()

◆ getNFName()

◆ getNLag()

◆ getNLagTotal()

◆ getNVar()

◆ getRankFromDirAndDate()

◆ getScale()