gstlrn::ModelOptimParam Class Reference

#include <ModelOptimParam.hpp>

Inheritance diagram for gstlrn::ModelOptimParam:

Detailed Description

This class defines the options and parameters used during the Variogram Fitting. All the parameters described hereafter are either available in the construction, or can be set using a specific get() function.

• auth_aniso: When True, the inference looks for an anisotropic fit.
• auth_rotation: When True, the inference looks for a possible rotation
• lock_samerot: When True, the inference locks the same anisotropy for all basic structures
• lock_rot2d: When True, the anisotropy is restricted to a rotation around Z-axis only
• lock_no3D: When True, the inference parameters are limited to the 2-D space.
• lock_iso2d: When True, the inference looks for a 2-D isotropic model
• flag_goulard: This very efficient algorithm can be used for inferring the sill matrix for each basic structure. This option can be switched OFF on purpose (and replaced by the FOXLEG algorithm).
• flag_instrinsic: When True, fit a Model which includes at least one Intrinsic basic Structure
• wmode: Weighting option (see comments on the setWMode() function)
• maxiter: Maximum number of iterations
• tolred: Define the relative criterion used for stopping the iterations

Public Member Functions
	ModelOptimParam ()
	ModelOptimParam (const ModelOptimParam &m)
ModelOptimParam &	operator= (const ModelOptimParam &m)
virtual	~ModelOptimParam ()
String	toString (const AStringFormat *strfmt=nullptr) const override
bool	getAuthAniso () const
void	setAuthAniso (bool authAniso)
bool	getAuthRotation () const
void	setAuthRotation (bool authRotation)
bool	getFlagGoulard () const
void	setFlagGoulard (bool flagGoulard)
bool	getLockIso2d () const
void	setLockIso2d (bool lockIso2d)
bool	getLockNo3d () const
void	setLockNo3d (bool lockNo3d)
bool	getLockRot2d () const
void	setLockRot2d (bool lockRot2d)
bool	getLockSamerot () const
void	setLockSamerot (bool lockSamerot)
bool	getFlagIntrinsic () const
void	setFlagIntrinsic (bool flagIntrinsic)
Id	getWmode () const
void	setWmode (Id wmode)
Id	getMaxiter () const
void	setMaxiter (Id maxiter)
double	getTolred () const
void	setTolred (double tolred)
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

Static Public Member Functions
static ModelOptimParam *	create (bool auth_aniso=true, bool auth_rotation=true, bool lock_samerot=false, bool lock_rot2d=false, bool lock_no3d=false, bool lock_iso2d=false, bool flag_goulard=true, bool flag_intrinsic=false, Id wmode=2, Id maxiter=1000, double tolred=EPSILON10)

Constructor & Destructor Documentation

ModelOptimParam() [1/2]

gstlrn::ModelOptimParam::ModelOptimParam

(

)

ModelOptimParam() [2/2]

gstlrn::ModelOptimParam::ModelOptimParam

(

const ModelOptimParam &

m

)

~ModelOptimParam()

gstlrn::ModelOptimParam::~ModelOptimParam ( )

virtual

Member Function Documentation

create()

ModelOptimParam * gstlrn::ModelOptimParam::create ( bool  auth_aniso = true, bool  auth_rotation = true, bool  lock_samerot = false, bool  lock_rot2d = false, bool  lock_no3d = false, bool  lock_iso2d = false, bool  flag_goulard = true, bool  flag_intrinsic = false, Id  wmode = 2, Id  maxiter = 1000, double  tolred = EPSILON10  )

static

getAuthAniso()

bool gstlrn::ModelOptimParam::getAuthAniso ( ) const

inline

getAuthRotation()

bool gstlrn::ModelOptimParam::getAuthRotation ( ) const

inline

getFlagGoulard()

bool gstlrn::ModelOptimParam::getFlagGoulard ( ) const

inline

getFlagIntrinsic()

bool gstlrn::ModelOptimParam::getFlagIntrinsic ( ) const

inline

getLockIso2d()

bool gstlrn::ModelOptimParam::getLockIso2d ( ) const

inline

getLockNo3d()

bool gstlrn::ModelOptimParam::getLockNo3d ( ) const

inline

getLockRot2d()

bool gstlrn::ModelOptimParam::getLockRot2d ( ) const

inline

getLockSamerot()

bool gstlrn::ModelOptimParam::getLockSamerot ( ) const

inline

getMaxiter()

Id gstlrn::ModelOptimParam::getMaxiter ( ) const

inline

getTolred()

double gstlrn::ModelOptimParam::getTolred ( ) const

inline

getWmode()

Id gstlrn::ModelOptimParam::getWmode ( ) const

inline

Set the type of the weighting function used in the fitting procedure. This function is defined in the case of several directional experimental variograms, calculated in a multivariate case: 0: The weight is constant 1: The weight is proportional to the number of pairs 2: The weight is proportional to the number of pairs and inverse proportional to the distance 3: The weight is inverse proportional to the number of lags for each direction

Parameters

wmode

type of weighting function (0, 1, 2 or 3, see above)

Note

The default value for wmode is 2

operator=()

ModelOptimParam & gstlrn::ModelOptimParam::operator=

(

const ModelOptimParam &

m

)

setAuthAniso()

void gstlrn::ModelOptimParam::setAuthAniso ( bool  authAniso )

inline

setAuthRotation()

void gstlrn::ModelOptimParam::setAuthRotation ( bool  authRotation )

inline

setFlagGoulard()

void gstlrn::ModelOptimParam::setFlagGoulard ( bool  flagGoulard )

inline

setFlagIntrinsic()

void gstlrn::ModelOptimParam::setFlagIntrinsic ( bool  flagIntrinsic )

inline

setLockIso2d()

void gstlrn::ModelOptimParam::setLockIso2d ( bool  lockIso2d )

inline

setLockNo3d()

void gstlrn::ModelOptimParam::setLockNo3d ( bool  lockNo3d )

inline

setLockRot2d()

void gstlrn::ModelOptimParam::setLockRot2d ( bool  lockRot2d )

inline

setLockSamerot()

void gstlrn::ModelOptimParam::setLockSamerot ( bool  lockSamerot )

inline

setMaxiter()

void gstlrn::ModelOptimParam::setMaxiter ( Id  maxiter )

inline

setTolred()

void gstlrn::ModelOptimParam::setTolred ( double  tolred )

inline

setWmode()

void gstlrn::ModelOptimParam::setWmode ( Id  wmode )

inline

toString()

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

overridevirtual

Reimplemented from gstlrn::AStringable.

---

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

• include/Model/ModelOptimParam.hpp
• src/Model/ModelOptimParam.cpp