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 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 VectorDouble &dates=VectorDouble(), const Faults *faults=nullptr)
	VarioParam (const VarioParam &VarioParam, const VectorInt &dircols, const Faults *faults=nullptr)
	VarioParam (const VarioParam &r)
VarioParam &	operator= (const VarioParam &r)
virtual	~VarioParam ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	ICloneable interface. More...
void	addDir (const DirParam &dirparam)
void	addMultiDirs (const std::vector< DirParam > &dirparams)
void	delDir (int rank)
void	delAllDirs ()
const ASpace *	getSpace () const
double	getScale () const
int	getDateNumber () const
int	getDirectionNumber () const
const VectorDouble &	getDates () const
double	getDate (int idate, int icas) const
int	getLagNumber (int idir) const
VectorDouble	getCodirs (int idir=0) const
const std::vector< DirParam > &	getDirParams () const
const DirParam &	getDirParam (int idir) const
int	getDimensionNumber () const
bool	isDefinedForGrid () const
int	hasDate () const
bool	isDateUsed (const Db *db1, const Db *db2=nullptr) const
void	setScale (double scale)
void	setDates (const VectorDouble &dates)
void	setDPas (int idir, const DbGrid *db)
void	setGrincr (int idir, const VectorInt &grincr)
String	toStringMain (const AStringFormat *strfmt) const
const Faults *	getFaults () const
bool	hasFaults () const
void	addFaults (const Faults *faults)
Public Member Functions inherited from 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 (int level) const final
Public Member Functions inherited from ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0

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

Constructor & Destructor Documentation

VarioParam() [1/3]

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

VarioParam() [2/3]

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

VarioParam() [3/3]

VarioParam::VarioParam

(

const VarioParam &

r

)

~VarioParam()

VarioParam::~VarioParam ( )

virtual

Member Function Documentation

addDir()

void VarioParam::addDir

(

const DirParam &

dirparam

)

addFaults()

void VarioParam::addFaults ( const Faults *  faults )

inline

addMultiDirs()

void VarioParam::addMultiDirs

(

const std::vector< DirParam > &

dirparams

)

createFromSpaceDimension()

VarioParam * VarioParam::createFromSpaceDimension ( int  npas = 10, double  dpas = 1., double  toldis = 0.5, double  tolang = 45., double  scale = 0., const VectorDouble &  dates = VectorDouble(), const ASpace *  space = nullptr  )

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

  npas	Number of lags
  dpas	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 * VarioParam::createMultiple ( int  ndir, int  npas = 10, double  dpas = 1., double  toldis = 0.5, double  angref = 0., double  scale = 0., const VectorDouble &  dates = VectorDouble(), const ASpace *  space = nullptr  )

static

createMultipleFromGrid()

VarioParam * VarioParam::createMultipleFromGrid ( const DbGrid *  dbgrid, int  npas, double  scale = 0., const VectorDouble &  dates = VectorDouble(), const ASpace *  space = nullptr, int  ndimax = 0  )

static

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

Parameters

dbgrid	a DbGrid structure
npas	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 * VarioParam::createOmniDirection ( int  npas = 10, double  dpas = 1., double  toldis = 0.5, int  opt_code = 0, int  idate = 0, double  bench = TEST, double  cylrad = TEST, double  tolcode = 0., const VectorDouble &  breaks = VectorDouble(), double  scale = 0., const VectorDouble &  dates = VectorDouble(), const ASpace *  space = nullptr  )

static

Shortcuts.

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

Parameters

npas	Number of lags
dpas	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 * VarioParam::createSeveral2D ( const VectorDouble &  angles, int  npas = 10, double  dpas = 1., double  toldis = 0.5, double  tolang = TEST, double  scale = 0., const VectorDouble &  dates = VectorDouble(), const ASpace *  space = nullptr  )

static

delAllDirs()

void VarioParam::delAllDirs

(

)

delDir()

void VarioParam::delDir

(

int

rank

)

getCodirs()

VectorDouble VarioParam::getCodirs

(

int

idir = 0

)

const

getDate()

double VarioParam::getDate	(	int	idate,
		int	icas
	)		const

getDateNumber()

int VarioParam::getDateNumber ( ) const

inline

getDates()

const VectorDouble& VarioParam::getDates ( ) const

inline

getDimensionNumber()

int VarioParam::getDimensionNumber

(

)

const

getDirectionNumber()

int VarioParam::getDirectionNumber ( ) const

inline

getDirParam()

const DirParam& VarioParam::getDirParam ( int  idir ) const

inline

getDirParams()

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

inline

getFaults()

const Faults* VarioParam::getFaults ( ) const

inline

getLagNumber()

int VarioParam::getLagNumber

(

int

idir

)

const

getScale()

double VarioParam::getScale ( ) const

inline

getSpace()

const ASpace* VarioParam::getSpace ( ) const

inline

hasDate()

int VarioParam::hasDate ( ) const

inline

hasFaults()

bool VarioParam::hasFaults ( ) const

inline

isDateUsed()

bool 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 VarioParam::isDefinedForGrid

(

)

const

operator=()

VarioParam & VarioParam::operator=

(

const VarioParam &

r

)

setDates()

void VarioParam::setDates ( const VectorDouble &  dates )

inline

setDPas()

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

setGrincr()

void VarioParam::setGrincr	(	int	idir,
		const VectorInt &	grincr
	)

setScale()

void VarioParam::setScale ( double  scale )

inline

toString()

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

overridevirtual

ICloneable interface.

AStringable Interface

Reimplemented from AStringable.

toStringMain()

String VarioParam::toStringMain

(

const AStringFormat *

strfmt

)

const

---

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

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