OptimCostColored Class Reference

#include <OptimCostColored.hpp>

Inheritance diagram for OptimCostColored:

Public Member Functions
	OptimCostColored (const CGParam params=CGParam())
	OptimCostColored (int nprop, PrecisionOp *pmat, const ProjMatrix *projdata, const ProjMatrix *projseis=nullptr, const VectorDouble &propseis=VectorDouble(), const VectorDouble &varseis=VectorDouble())
	OptimCostColored (const OptimCostColored &m)
OptimCostColored &	operator= (const OptimCostColored &m)
virtual	~OptimCostColored ()
void	reset (int nprop, PrecisionOp *pmat, const ProjMatrix *projdata, const ProjMatrix *projseis=nullptr, const VectorDouble &propseis=VectorDouble(), const VectorDouble &varseis=VectorDouble())
VectorVectorDouble	minimize (const VectorDouble &facies, const VectorVectorInt &splits=VectorVectorInt(), const VectorDouble &meanprops=VectorDouble(), bool verbose=false, int maxiter=100, double eps=5.e-4)
VectorVectorInt	initSplit (int nfacies, bool verbose=false) const
void	printSplits (const VectorVectorInt &splits=VectorVectorInt()) const
void	setMeanProps (const VectorDouble &meanProps)
void	setSplits (const VectorVectorInt &splits)
Public Member Functions inherited from OptimCostBinary
	OptimCostBinary (const CGParam params=CGParam())
	OptimCostBinary (const OptimCostBinary &m)
OptimCostBinary &	operator= (const OptimCostBinary &m)
virtual	~OptimCostBinary ()
void	reset (PrecisionOp *pmat, const ProjMatrix *projdata, const ProjMatrix *projseis=nullptr, const VectorDouble &propseis=VectorDouble(), const VectorDouble &varseis=VectorDouble())
VectorDouble	minimize (VectorDouble &indic, bool verbose=false, int maxiter=100, double eps=5.e-4)
void	calculateGradient (const VectorDouble &indic, const VectorDouble &lambda, double *out)
int	setMeanProportion (double meanprop)
void	setParams (const CGParam &params)
void	setPreCondParams (int chebncmax=10001, double chebtol=5.e-3)
int	isInitialized ()
int	getNPoint () const
int	getNVertex () const
void	toggleSeismic (bool status)
Public Member Functions inherited from IOptimCost
	IOptimCost ()
virtual	~IOptimCost ()

Private Member Functions
void	_getFaciesToIndic (const VectorDouble &facies, const VectorInt &split, VectorDouble &indic) const
double	_getFaciesToProportion (const VectorInt &split) const
int	_checkFacies (const VectorDouble &facies) const
int	_checkSplits (const VectorVectorInt &splits)
int	_checkMeanProportions (const VectorDouble &meanprops)
void	_copyMultProportions (int level, int ip, const VectorDouble &propfac, VectorVectorDouble &propfacs)

Private Attributes
int	_nprop
VectorVectorInt	_splits
VectorDouble	_meanProps

Constructor & Destructor Documentation

OptimCostColored() [1/3]

OptimCostColored::OptimCostColored

(

const CGParam

params = CGParam()

)

OptimCostColored() [2/3]

OptimCostColored::OptimCostColored	(	int	nprop,
		PrecisionOp *	pmat,
		const ProjMatrix *	projdata,
		const ProjMatrix *	projseis = nullptr,
		const VectorDouble &	propseis = VectorDouble(),
		const VectorDouble &	varseis = VectorDouble()
	)

OptimCostColored() [3/3]

OptimCostColored::OptimCostColored

(

const OptimCostColored &

m

)

~OptimCostColored()

OptimCostColored::~OptimCostColored ( )

virtual

Member Function Documentation

_checkFacies()

int OptimCostColored::_checkFacies ( const VectorDouble &  facies ) const

private

Internal function to check the set of facies input values

Returns

Error returned code

Parameters

[in]

facies

Array containing the Facies values (see remarks) (Dimension: npoint)

_checkMeanProportions()

int OptimCostColored::_checkMeanProportions ( const VectorDouble &  meanprops )

private

Internal function to check the means Proportions

Returns

Error returned code

Parameters

[in]

meanprops

Array of mean of proportions (Dimension: nfacies)

_checkSplits()

int OptimCostColored::_checkSplits ( const VectorVectorInt &  splits )

private

Internal function to check the validity of the Splits

Returns

Error returned code

Parameters

[in]

splits

Array giving the facies split (Dimension: nfacies * (nfacies-1))

_copyMultProportions()

void OptimCostColored::_copyMultProportions ( int  level, int  ip, const VectorDouble &  propfac, VectorVectorDouble &  propfacs  )

private

Internal function to convert Proportions into conditional proportions

Parameters

[in]	level	Level in the Split order
[in]	ip	Rank of the reference proportion
[in]	propfac	Marginal proportions
[out]	propfacs	Array of facies proportions (Dimension: nvertex * _nprop)

_getFaciesToIndic()

void OptimCostColored::_getFaciesToIndic ( const VectorDouble &  facies, const VectorInt &  split, VectorDouble &  indic  ) const

private

Internal function to Extract the Indicator value of a given facies

Parameters

facies	Array of facies values
split	Array giving the facies split (Dimension: nfacies * (nfacies-1))
indic	Array of output indicator values

_getFaciesToProportion()

double OptimCostColored::_getFaciesToProportion ( const VectorInt &  split ) const

private

Internal function to evaluate the proportion for a given split

Returns

The proportion of the target facies

Parameters

[in]

split

Array giving the facies split (at a given level)

initSplit()

VectorVectorInt OptimCostColored::initSplit	(	int	nfacies,
		bool	verbose = false
	)		const

Provides the list of regrouped facies during Optimizaition

Parameters

nfacies	Number of facies
verbose	Verbose flag

Returns

For each level, Vector of regrouped facies

minimize()

VectorVectorDouble OptimCostColored::minimize	(	const VectorDouble &	facies,
		const VectorVectorInt &	splits = VectorVectorInt(),
		const VectorDouble &	meanprops = VectorDouble(),
		bool	verbose = false,
		int	maxiter = 100,
		double	eps = 5.e-4
	)

Perform the minimization

Returns

Array of facies proportions (Dimension: [nprop][nvertex]

Parameters

[in]	facies	Array containing the Facies values (see remarks) (Dimension: npoint)
[in]	splits	Array giving the facies split (Dimension: [nfacies-1][nfacies])
[in]	meanprops	Array of mean of proportions (Dimension: nfacies)
[in]	verbose	Verbose flag
[in]	maxiter	Maximum number of iterations for Optimization algorithm
[in]	eps	Tolerance for Optimization algorithm

Remarks

Argument 'facies' should contain values ranging from 1 to _nprop

operator=()

OptimCostColored & OptimCostColored::operator=

(

const OptimCostColored &

m

)

printSplits()

void OptimCostColored::printSplits

(

const VectorVectorInt &

splits = VectorVectorInt()

)

const

Internal function to print the Splits

reset()

void OptimCostColored::reset	(	int	nprop,
		PrecisionOp *	pmat,
		const ProjMatrix *	projdata,
		const ProjMatrix *	projseis = nullptr,
		const VectorDouble &	propseis = VectorDouble(),
		const VectorDouble &	varseis = VectorDouble()
	)

Initialize the Hessian Operator

Parameters

[in]	nprop	Number of different proportions (or facies)
[in]	pmat	The precision matrix to be optimized
[in]	projdata	The Projection operator between Data and Meshing
[in]	projseis	The Projection operator between Seismic and Meshing
[in]	propseis	Array of facies proportions
[in]	varseis	Array of variance attached to the seismic

setMeanProps()

void OptimCostColored::setMeanProps ( const VectorDouble &  meanProps )

inline

setSplits()

void OptimCostColored::setSplits ( const VectorVectorInt &  splits )

inline

Member Data Documentation

_meanProps

VectorDouble OptimCostColored::_meanProps

private

_nprop

int OptimCostColored::_nprop

private

_splits

VectorVectorInt OptimCostColored::_splits

private

---

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

• include/LinearOp/OptimCostColored.hpp
• src/LinearOp/OptimCostColored.cpp