1.2.3
CCC
 
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:
AStringable ICloneable

Public Member Functions

 VarioParam (double scale=0., const VectorDouble &dates=VectorDouble(), const Faults *faults=nullptr)
 
 VarioParam (const VarioParam &VarioParam, const VectorInt &rankdirs, const Faults *faults=nullptr)
 
 VarioParam (const VarioParam &r)
 
VarioParamoperator= (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 ASpacegetSpace () const
 
double getScale () const
 
int getDateNumber () const
 
int getDirectionNumber () const
 
const VectorDoublegetDates () 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 DirParamgetDirParam (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 (VectorDouble dates)
 
void setDPas (int idir, const DbGrid *db)
 
void setGrincr (int idir, const VectorInt &grincr)
 
String toStringMain (const AStringFormat *strfmt) const
 
const FaultsgetFaults () const
 
bool hasFaults () const
 
void addFaults (const Faults *faults)
 
- Public Member Functions inherited from AStringable
 AStringable ()
 
 AStringable (const AStringable &r)
 
AStringableoperator= (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 ICloneableclone () const =0
 

Static Public Member Functions

static VarioParamcreateOmniDirection (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 VarioParamcreateMultiple (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 VarioParamcreateMultipleFromGrid (const DbGrid *dbgrid, int npas, double scale=0., const VectorDouble &dates=VectorDouble(), const ASpace *space=nullptr)
 
static VarioParamcreateFromSpaceDimension (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 VarioParamcreateSeveral2D (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)
 

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.

Constructor & Destructor Documentation

VarioParam::VarioParam ( double  scale = 0.,
const VectorDouble dates = VectorDouble(),
const Faults faults = nullptr 
)
VarioParam::VarioParam ( const VarioParam VarioParam,
const VectorInt rankdirs,
const Faults faults = nullptr 
)
VarioParam::VarioParam ( const VarioParam r)
VarioParam::~VarioParam ( )
virtual

Member Function Documentation

void VarioParam::addDir ( const DirParam dirparam)
void VarioParam::addFaults ( const Faults faults)
inline
void VarioParam::addMultiDirs ( const std::vector< DirParam > &  dirparams)
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
    npasNumber of lags
    dpasValue of the lag
    toldisTolerance on distancecomputeFromDb
    tolangTolerance on angle
    scaleScaling factor
    datesRange of dates
    spacePointer to the Space definition
    Returns
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
VarioParam * VarioParam::createMultipleFromGrid ( const DbGrid dbgrid,
int  npas,
double  scale = 0.,
const VectorDouble dates = VectorDouble(),
const ASpace space = nullptr 
)
static

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

Parameters
dbgrida DbGrid structure
npasNumber of lags
scaleScaling factor
datesRange of dates
spacePointer to the Space definition
Returns
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
npasNumber of lags
dpasLag value
toldisTolerance on distance
opt_codeOption for usage of the code
idateReference date
benchBench value
cylradValue of radius of the Cylinder search
tolcodeTolerance on the code
breaksDefinition of the irregular intervals
scaleScaling factor
datesRange of dates
spacePointer to the space definition
Returns
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
void VarioParam::delAllDirs ( )
void VarioParam::delDir ( int  rank)
VectorDouble VarioParam::getCodirs ( int  idir = 0) const
double VarioParam::getDate ( int  idate,
int  icas 
) const
int VarioParam::getDateNumber ( ) const
inline
const VectorDouble& VarioParam::getDates ( ) const
inline
int VarioParam::getDimensionNumber ( ) const
int VarioParam::getDirectionNumber ( ) const
inline
const DirParam& VarioParam::getDirParam ( int  idir) const
inline
const std::vector<DirParam>& VarioParam::getDirParams ( ) const
inline
const Faults* VarioParam::getFaults ( ) const
inline
int VarioParam::getLagNumber ( int  idir) const
double VarioParam::getScale ( ) const
inline
const ASpace* VarioParam::getSpace ( ) const
inline
int VarioParam::hasDate ( ) const
inline
bool VarioParam::hasFaults ( ) const
inline
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]db1First Db structure
[in]db2Second Db structure
bool VarioParam::isDefinedForGrid ( ) const
VarioParam & VarioParam::operator= ( const VarioParam r)
void VarioParam::setDates ( VectorDouble  dates)
inline
void VarioParam::setDPas ( int  idir,
const DbGrid db 
)
void VarioParam::setGrincr ( int  idir,
const VectorInt grincr 
)
void VarioParam::setScale ( double  scale)
inline
String VarioParam::toString ( const AStringFormat strfmt = nullptr) const
overridevirtual

ICloneable interface.

AStringable Interface

Reimplemented from AStringable.

String VarioParam::toStringMain ( const AStringFormat strfmt) const

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