gstlrn::VarioParam Class Reference

Class containing the definition of the criteria for calculating the Spatial (and Temporal) Characteristics from samples contained in a Db. More...

#include <VarioParam.hpp>

Inheritance diagram for gstlrn::VarioParam:

Detailed Description

Class containing the definition of the criteria for calculating the Spatial (and Temporal) Characteristics from samples contained in a Db.

These criteria consist in:

• some criteria based on the dates: this information will is used for calculating the Temporal Characteristics
• a collection of definitions of Calculation Directions for Spatial Characteristics. For more information on a Direction definition, please refer to DirParam.hpp

Note that this class also stores a pointer to any Faults definition, if to be used during the calculation of the Spatial Characteristics.

Public Member Functions
	VarioParam (double scale=0., const 1 &dates=1(), const Faults *faults=nullptr)
	VarioParam (const VarioParam &VarioParam, const 1 &dircols, const Faults *faults=nullptr)
	VarioParam (const VarioParam &r)
VarioParam &	operator= (const VarioParam &r)
virtual	~VarioParam ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	ICloneable interface.
void	addDir (const DirParam &dirparam)
void	addMultiDirs (const std::vector< DirParam > &dirparams)
void	delDir (Id rank)
void	delAllDirs ()
ASpaceSharedPtr	getSpace () const
double	getScale () const
Id	getNDate () const
Id	getNDir () const
const &	getDates () const
double	getDate (Id idate, Id icas) const
Id	getNLag (Id idir) const
	getCodirs (Id idir=0) const
const std::vector< DirParam > &	getDirParams () const
const DirParam &	getDirParam (Id idir) const
Id	getNDim () const
bool	isDefinedForGrid () const
Id	hasDate () const
bool	isDateUsed (const Db *db1, const Db *db2=nullptr) const
void	setScale (double scale)
void	setDates (const 1 &dates)
void	setDPas (Id idir, const DbGrid *db)
void	setGrincr (Id idir, const 1 &grincr)
String	toStringMain (const AStringFormat *strfmt=nullptr) const
const Faults *	getFaults () const
bool	hasFaults () const
void	addFaults (const Faults *faults)
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

Static Public Member Functions
static VarioParam *	createOmniDirection (Id nlag=10, double dlag=1., double toldis=0.5, Id opt_code=0, Id idate=0, double bench=TEST, double cylrad=TEST, double tolcode=0., const 1 &breaks=1(), double scale=0., const 1 &dates=1(), const ASpaceSharedPtr &space=ASpaceSharedPtr())
	Shortcuts.
static VarioParam *	createMultiple (Id ndir, Id nlag=10, double dlag=1., double toldis=0.5, double angref=0., double scale=0., const 1 &dates=1(), const ASpaceSharedPtr &space=ASpaceSharedPtr())
static VarioParam *	createMultipleFromGrid (const DbGrid *dbgrid, Id nlag, double scale=0., const 1 &dates=1(), const ASpaceSharedPtr &space=ASpaceSharedPtr(), Id ndimax=0)
static VarioParam *	createFromSpaceDimension (Id nlag=10, double dlag=1., double toldis=0.5, double tolang=45., double scale=0., const 1 &dates=1(), const ASpaceSharedPtr &space=ASpaceSharedPtr())
static VarioParam *	createSeveral2D (const 1 &angles, Id nlag=10, double dlag=1., double toldis=0.5, double tolang=TEST, double scale=0., const 1 &dates=1(), const ASpaceSharedPtr &space=ASpaceSharedPtr())

Constructor & Destructor Documentation

VarioParam() [1/3]

gstlrn::VarioParam::VarioParam	(	double	scale = 0.,
		const 1 &	dates = 1(),
		const Faults *	faults = nullptr
	)

VarioParam() [2/3]

gstlrn::VarioParam::VarioParam	(	const VarioParam &	VarioParam,
		const 1 &	dircols,
		const Faults *	faults = nullptr
	)

VarioParam() [3/3]

gstlrn::VarioParam::VarioParam

(

const VarioParam &

r

)

~VarioParam()

gstlrn::VarioParam::~VarioParam ( )

virtual

Member Function Documentation

addDir()

void gstlrn::VarioParam::addDir

(

const DirParam &

dirparam

)

addFaults()

void gstlrn::VarioParam::addFaults ( const Faults *  faults )

inline

addMultiDirs()

void gstlrn::VarioParam::addMultiDirs

(

const std::vector< DirParam > &

dirparams

)

createFromSpaceDimension()

VarioParam * gstlrn::VarioParam::createFromSpaceDimension ( Id  nlag = 10, double  dlag = 1., double  toldis = 0.5, double  tolang = 45., double  scale = 0., const 1 &  dates = 1(), const ASpaceSharedPtr &  space = ASpaceSharedPtr()  )

static

Automatically create a set of calculation directions for a given Space Direction:

• one calculation direction per space direction
• the same parameters are used for each direction, such as:

  Parameters

  nlag	Number of lags
  dlag	Value of the lag
  toldis	Tolerance on distancecomputeFromDb
  tolang	Tolerance on angle
  scale	Scaling factor
  dates	Range of dates
  space	Pointer to the Space definition

  Returns

createMultiple()

VarioParam * gstlrn::VarioParam::createMultiple ( Id  ndir, Id  nlag = 10, double  dlag = 1., double  toldis = 0.5, double  angref = 0., double  scale = 0., const 1 &  dates = 1(), const ASpaceSharedPtr &  space = ASpaceSharedPtr()  )

static

createMultipleFromGrid()

VarioParam * gstlrn::VarioParam::createMultipleFromGrid ( const DbGrid *  dbgrid, Id  nlag, double  scale = 0., const 1 &  dates = 1(), const ASpaceSharedPtr &  space = ASpaceSharedPtr(), Id  ndimax = 0  )

static

Automatically create several calculation directions from Grid information: For details, see DirParam::createMultipleFromGrid documentation

Parameters

dbgrid	a DbGrid structure
nlag	Number of lags
scale	Scaling factor
dates	Range of dates
space	Pointer to the Space definition
ndimax	Maximum dimension (see note)

Returns

A pointer to the newly created VarioParam object

Note

This method creates as many calculation direction as space dimension

However, this number can be truncated to 'ndimax' (when defined)

createOmniDirection()

VarioParam * gstlrn::VarioParam::createOmniDirection ( Id  nlag = 10, double  dlag = 1., double  toldis = 0.5, Id  opt_code = 0, Id  idate = 0, double  bench = TEST, double  cylrad = TEST, double  tolcode = 0., const 1 &  breaks = 1(), double  scale = 0., const 1 &  dates = 1(), const ASpaceSharedPtr &  space = ASpaceSharedPtr()  )

static

Shortcuts.

Create one Calculation Direction corresponding to the Omni-direction calculation For details, see DirParam::createOmniDirection documentation

Parameters

nlag	Number of lags
dlag	Lag value
toldis	Tolerance on distance
opt_code	Option for usage of the code
idate	Reference date
bench	Bench value
cylrad	Value of radius of the Cylinder search
tolcode	Tolerance on the code
breaks	Definition of the irregular intervals
scale	Scaling factor
dates	Range of dates
space	Pointer to the space definition

Returns

createSeveral2D()

VarioParam * gstlrn::VarioParam::createSeveral2D ( const 1 &  angles, Id  nlag = 10, double  dlag = 1., double  toldis = 0.5, double  tolang = TEST, double  scale = 0., const 1 &  dates = 1(), const ASpaceSharedPtr &  space = ASpaceSharedPtr()  )

static

delAllDirs()

void gstlrn::VarioParam::delAllDirs

(

)

delDir()

void gstlrn::VarioParam::delDir

(

Id

rank

)

getCodirs()

gstlrn::VarioParam::getCodirs

(

Id

idir = 0

)

const

getDate()

double gstlrn::VarioParam::getDate	(	Id	idate,
		Id	icas
	)		const

getDates()

const & gstlrn::VarioParam::getDates ( ) const

inline

getDirParam()

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

inline

getDirParams()

const std::vector< DirParam > & gstlrn::VarioParam::getDirParams ( ) const

inline

getFaults()

const Faults * gstlrn::VarioParam::getFaults ( ) const

inline

getNDate()

Id gstlrn::VarioParam::getNDate ( ) const

inline

getNDim()

Id gstlrn::VarioParam::getNDim

(

)

const

getNDir()

Id gstlrn::VarioParam::getNDir ( ) const

inline

getNLag()

Id gstlrn::VarioParam::getNLag

(

Id

idir

)

const

getScale()

double gstlrn::VarioParam::getScale ( ) const

inline

getSpace()

ASpaceSharedPtr gstlrn::VarioParam::getSpace ( ) const

inline

hasDate()

Id gstlrn::VarioParam::hasDate ( ) const

inline

hasFaults()

bool gstlrn::VarioParam::hasFaults ( ) const

inline

isDateUsed()

bool gstlrn::VarioParam::isDateUsed	(	const Db *	db1,
		const Db *	db2 = nullptr
	)		const

Check if dates are involved in the variogram calculation

Returns

1 if dates are used; 0 otherwise

Parameters

[in]	db1	First Db structure
[in]	db2	Second Db structure

isDefinedForGrid()

bool gstlrn::VarioParam::isDefinedForGrid

(

)

const

operator=()

VarioParam & gstlrn::VarioParam::operator=

(

const VarioParam &

r

)

setDates()

void gstlrn::VarioParam::setDates ( const 1 &  dates )

inline

setDPas()

void gstlrn::VarioParam::setDPas	(	Id	idir,
		const DbGrid *	db
	)

setGrincr()

void gstlrn::VarioParam::setGrincr	(	Id	idir,
		const 1 &	grincr
	)

setScale()

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

inline

toString()

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

overridevirtual

ICloneable interface.

AStringable Interface

Reimplemented from gstlrn::AStringable.

toStringMain()

String gstlrn::VarioParam::toStringMain

(

const AStringFormat *

strfmt = nullptr

)

const

---

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

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