gstlrn::Option_VarioFit Class Reference

#include <Option_VarioFit.hpp>

Inheritance diagram for gstlrn::Option_VarioFit:

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.

• flag_noreduce: in the different iterations, some structures can be discarded if their importance is considered as too small. The current option forbids this simplification, which ensures that all the basic structures are kept and their number remains unchanged.
• flag_goulard_used: 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).
• 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
• keep_instr: When True, at least ONE basic structure must be kept in the Model
• flag_instrinsic: When True, fit a Model which includes at least one Intrinsic basic Structure

Public Member Functions
	Option_VarioFit (bool flag_noreduce=false, bool auth_aniso=true, bool auth_rotation=true, bool lock_samerot=false, bool lock_rot2d=false, bool lock_no3d=false, bool lock_iso2d=false)
	Option_VarioFit (const Option_VarioFit &m)
Option_VarioFit &	operator= (const Option_VarioFit &m)
virtual	~Option_VarioFit ()
String	toString (const AStringFormat *strfmt=nullptr) const override
bool	getAuthAniso () const
void	setAuthAniso (bool authAniso)
bool	getAuthRotation () const
void	setAuthRotation (bool authRotation)
bool	getFlagGoulardUsed () const
void	setFlagGoulardUsed (bool flagGoulardUsed)
bool	getFlagNoreduce () const
void	setFlagNoreduce (bool flagNoreduce)
bool	getKeepIntstr () const
void	setKeepIntstr (bool keepIntstr)
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)
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

Constructor & Destructor Documentation

Option_VarioFit() [1/2]

gstlrn::Option_VarioFit::Option_VarioFit	(	bool	flag_noreduce = false,
		bool	auth_aniso = true,
		bool	auth_rotation = true,
		bool	lock_samerot = false,
		bool	lock_rot2d = false,
		bool	lock_no3d = false,
		bool	lock_iso2d = false
	)

Option_VarioFit() [2/2]

gstlrn::Option_VarioFit::Option_VarioFit

(

const Option_VarioFit &

m

)

~Option_VarioFit()

gstlrn::Option_VarioFit::~Option_VarioFit ( )

virtual

Member Function Documentation

getAuthAniso()

bool gstlrn::Option_VarioFit::getAuthAniso ( ) const

inline

getAuthRotation()

bool gstlrn::Option_VarioFit::getAuthRotation ( ) const

inline

getFlagGoulardUsed()

bool gstlrn::Option_VarioFit::getFlagGoulardUsed ( ) const

inline

getFlagIntrinsic()

bool gstlrn::Option_VarioFit::getFlagIntrinsic ( ) const

inline

getFlagNoreduce()

bool gstlrn::Option_VarioFit::getFlagNoreduce ( ) const

inline

getKeepIntstr()

bool gstlrn::Option_VarioFit::getKeepIntstr ( ) const

inline

getLockIso2d()

bool gstlrn::Option_VarioFit::getLockIso2d ( ) const

inline

getLockNo3d()

bool gstlrn::Option_VarioFit::getLockNo3d ( ) const

inline

getLockRot2d()

bool gstlrn::Option_VarioFit::getLockRot2d ( ) const

inline

getLockSamerot()

bool gstlrn::Option_VarioFit::getLockSamerot ( ) const

inline

operator=()

Option_VarioFit & gstlrn::Option_VarioFit::operator=

(

const Option_VarioFit &

m

)

setAuthAniso()

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

inline

setAuthRotation()

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

inline

setFlagGoulardUsed()

void gstlrn::Option_VarioFit::setFlagGoulardUsed ( bool  flagGoulardUsed )

inline

setFlagIntrinsic()

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

inline

setFlagNoreduce()

void gstlrn::Option_VarioFit::setFlagNoreduce ( bool  flagNoreduce )

inline

setKeepIntstr()

void gstlrn::Option_VarioFit::setKeepIntstr ( bool  keepIntstr )

inline

setLockIso2d()

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

inline

setLockNo3d()

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

inline

setLockRot2d()

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

inline

setLockSamerot()

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

inline

toString()

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

overridevirtual

Reimplemented from gstlrn::AStringable.

---

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

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