Classical.cpp File Reference

#include "Db/Db.hpp"
#include "Db/DbGrid.hpp"
#include "Stats/Classical.hpp"
#include "Basic/Utilities.hpp"
#include "Basic/String.hpp"
#include "Basic/AStringable.hpp"
#include "Matrix/MatrixSquareSymmetric.hpp"
#include "Matrix/MatrixFactory.hpp"
#include "Model/Model.hpp"
#include "Space/SpaceRN.hpp"
#include "Space/SpaceTarget.hpp"
#include "Variogram/VarioParam.hpp"
#include "Variogram/Vario.hpp"
#include "Polygon/Polygons.hpp"
#include "Enum/EStatOption.hpp"
#include <math.h>
#include <Matrix/Table.hpp>
#include <string.h>

Functions
bool	_operStatisticsCheck (const EStatOption &oper, int flag_multi, int flag_indic, int flag_sum, int flag_median, int flag_qt)
void	_updateProportions (DbGrid *dbin, VectorInt &indg, int nfacies, VectorDouble &prop)
void	_updateTransition (DbGrid *dbin, int pos, VectorInt &indg, int nfacies, int orient, VectorDouble &trans)
void	_scaleAndAffect (Db *dbout, int iptr, int iech, int nitem, VectorDouble &tab)
bool	_operExists (const std::vector< EStatOption > &opers, const EStatOption &refe)
void	_refactor (int ncol, VectorDouble &tab)
void	_copyResults (int nx, int ny, const VectorDouble &tabin, VectorDouble &tabout)
void	_neighboringCell (int ndim, int radius, int rank0, const VectorInt &indg0, VectorInt &indg)
double	_getQuantile (VectorDouble &tab, int ntab, double proba)
VectorString	statOptionToName (const std::vector< EStatOption > &opers)
std::vector< EStatOption >	KeysToStatOptions (const VectorString &opers)
void	dbStatisticsVariables (Db *db, const VectorString &names, const std::vector< EStatOption > &opers, int iptr0, double proba, double vmin, double vmax)
Table	dbStatisticsMono (Db *db, const VectorString &names, const std::vector< EStatOption > &opers, bool flagIso, double proba, double vmin, double vmax, const String &title)
VectorDouble	dbStatisticsFacies (Db *db)
double	dbStatisticsIndicator (Db *db)
Table	dbStatisticsCorrel (Db *db, const VectorString &names, bool flagIso, const String &title)
int	statisticsProportion (DbGrid *dbin, DbGrid *dbout, int pos, int nfacies, int radius)
int	statisticsTransition (DbGrid *dbin, DbGrid *dbout, int pos, int nfacies, int radius, int orient)
void	_getRowname (const String &radix, int ncol, int icol, const String &name, char *string)
void	dbStatisticsPrint (const Db *db, const VectorString &names, const std::vector< EStatOption > &opers, bool flagIso, bool flagCorrel, const String &title, const String &radix)
MatrixSquareGeneral *	sphering (const AMatrix *X)
VectorDouble	dbStatisticsPerCell (Db *db, DbGrid *dbgrid, const EStatOption &oper, const String &name1, const String &name2, const VectorDouble &cuts)
Table	dbStatisticsMulti (Db *db, const VectorString &names, const EStatOption &oper, bool flagMono, const String &title)
int	dbStatisticsInGridTool (Db *db, DbGrid *dbgrid, const VectorString &names, const EStatOption &oper, int radius, int iptr0)
VectorVectorInt	correlationPairs (Db *db1, Db *db2, const String &name1, const String &name2, bool flagFrom1, bool verbose)
VectorVectorInt	hscatterPairs (Db *db, const String &name1, const String &name2, VarioParam *varioparam, int ipas, int idir, bool verbose)
int	correlationIdentify (Db *db1, Db *db2, int icol1, int icol2, Polygons *polygon)
VectorVectorDouble	condexp (Db *db1, Db *db2, int icol1, int icol2, double mini, double maxi, int nclass, bool verbose)
std::map< int, int >	contingencyTable (const VectorInt &values)
std::map< int, std::map< int, int > >	contingencyTable2 (const VectorInt &values, const VectorInt &bins)

Function Documentation

_copyResults()

void _copyResults	(	int	nx,
		int	ny,
		const VectorDouble &	tabin,
		VectorDouble &	tabout
	)

Copy the multivariate or monovariate statistics into the returned array

Parameters

[in]	nx	First dimension of the matrix
[in]	ny	First dimension of the matrix
[in]	tabin	Array to be refactored
[out]	tabout	Array to be refactored

_getQuantile()

double _getQuantile	(	VectorDouble &	tab,
		int	ntab,
		double	proba
	)

Calculate the quantile which corresponds to a given probability

Returns

Quantile value

Parameters

[in]	tab	Array of outcomes per sample
[in]	ntab	Number of active values
[in]	proba	Probability value (between 0 and 1)

_getRowname()

void _getRowname	(	const String &	radix,
		int	ncol,
		int	icol,
		const String &	name,
		char *	string
	)

Constitute the name of the row

Parameters

[in]	radix	Radix for the different variables (optional)
[in]	ncol	Number of variables
[in]	icol	Rank of the variable
[in]	name	Variables name
[in]	string	String array

_neighboringCell()

void _neighboringCell	(	int	ndim,
		int	radius,
		int	rank0,
		const VectorInt &	indg0,
		VectorInt &	indg
	)

Calculate the indices of the cell neighboring a target cell

Parameters

[in]	ndim	Space dimension
[in]	radius	Neighborhood radius
[in]	rank0	Rank of the neighbor
[in]	indg0	Array of indices of the target cell
[out]	indg	Array of indices of the neighboring cell

_operExists()

bool _operExists	(	const std::vector< EStatOption > &	opers,
		const EStatOption &	refe
	)

Check the operator name is mentioned within a list

Returns

true if the operator is mentioned; false otherwise

Parameters

[in]	opers	Array of operators
[in]	refe	Reference operator

Remarks

If the array 'opers' if empty, any name is considered as valid

_operStatisticsCheck()

bool _operStatisticsCheck	(	const EStatOption &	oper,
		int	flag_multi,
		int	flag_indic,
		int	flag_sum,
		int	flag_median,
		int	flag_qt
	)

Check the operator name

Returns

1 if the operator is valid; 0 otherwise

Parameters

[in]	oper	A EStatOption item
[in]	flag_multi	1 if multivariate operator is authorized
[in]	flag_indic	1 if indicator ("plus","minus","zero") is authorized
[in]	flag_sum	1 if sum of variable is authorized
[in]	flag_median	1 if median is authorized
[in]	flag_qt	1 if QT ("ore","metal") is authorized

Remarks

If an error occurred, the message is printed

_refactor()

void _refactor	(	int	ncol,
		VectorDouble &	tab
	)

Copy the multivariate into monovariate statistics (before printout)

Parameters

[in]	ncol	Dimension of the (square) matrix
[in,out]	tab	Array to be refactored

_scaleAndAffect()

void _scaleAndAffect	(	Db *	dbout,
		int	iptr,
		int	iech,
		int	nitem,
		VectorDouble &	tab
	)

Scale the proportions and store the proportions

Parameters

[in]	dbout	Db for the output grid
[in]	iptr	Writing pointer
[in]	iech	Rank of the target sample
[in]	nitem	Number of items
[in]	tab	Array of cumulative statistics

_updateProportions()

void _updateProportions	(	DbGrid *	dbin,
		VectorInt &	indg,
		int	nfacies,
		VectorDouble &	prop
	)

Update the proportions

Parameters

[in]	dbin	Db for the input grid
[in]	indg	Array of grid indices
[in]	nfacies	Number of facies
[out]	prop	Array of proportions

_updateTransition()

void _updateTransition	(	DbGrid *	dbin,
		int	pos,
		VectorInt &	indg,
		int	nfacies,
		int	orient,
		VectorDouble &	trans
	)

Update the transitions

Parameters

[in]	dbin	DbGrid for the input grid
[in]	pos	Rank of the montee axis
[in]	indg	Array of grid indices
[in]	nfacies	Number of facies
[in]	orient	Orientation
[out]	trans	Array of transitions

condexp()

VectorVectorDouble condexp	(	Db *	db1,
		Db *	db2,
		int	icol1,
		int	icol2,
		double	mini,
		double	maxi,
		int	nclass,
		bool	verbose
	)

Evaluate the experimental conditional expectation

Parameters

[in]	db1	Db descriptor (for target variable)
[in]	db2	Db descriptor (for auxiliary variables)
[in]	icol1	Rank of the target variable
[in]	icol2	Rank of the explanatory variable
[in]	mini	Minimum value for the explanaroty variable
[in]	maxi	Maximum value for the explanaroty variable
[in]	nclass	Number of classes
[in]	verbose	Verbose flag

contingencyTable()

std::map<int, int> contingencyTable

(

const VectorInt &

values

)

contingencyTable2()

std::map<int, std::map<int, int> > contingencyTable2	(	const VectorInt &	values,
		const VectorInt &	bins
	)

correlationIdentify()

int correlationIdentify	(	Db *	db1,
		Db *	db2,
		int	icol1,
		int	icol2,
		Polygons *	polygon
	)

Identify samples from scatter plot when included within a polygon

Returns

Error return code

Parameters

[in]	db1	Db descriptor (first variable)
[in]	db2	Db descriptor (second variable for flag.same=T)
[in]	icol1	Rank of the first column
[in]	icol2	Rank of the second column
[in]	polygon	Polygons structure

Remarks

The two input Db must match exactly (same number of samples with

same set of coordinates and same optional selection)

correlationPairs()

VectorVectorInt correlationPairs	(	Db *	db1,
		Db *	db2,
		const String &	name1,
		const String &	name2,
		bool	flagFrom1,
		bool	verbose
	)

Evaluate the correlation Correl(Z1(x) , Z2(x))

Returns

Array of the indices of pairs of samples (or VectorVectorInt())

Parameters

[in]	db1	Db descriptor (first variable)
[in]	db2	Db descriptor (second variable for flag.same=T)
[in]	name1	Name of the first variable
[in]	name2	Name of the second variable
[in]	flagFrom1	Start numbering of indices from 1 if True
[in]	verbose	Verbose flag

Remarks

The two input Db must match exactly (same number of samples with

same set of coordinates and same optional selection)

The returned Vector of Vector of integer 'indices' contain

the set of indices of the pairs of samples.

Its contents is i1,j1,i2,j2,...

The indices are numbered starting from 0

dbStatisticsFacies()

VectorDouble dbStatisticsFacies

(

Db *

db

)

Considering that the Unique variable is a Facies (positive integer) returns the vector of proportions

Returns

The vector of proportions per Facies

Parameters

[in]

db

Db structure

dbStatisticsIndicator()

double dbStatisticsIndicator

(

Db *

db

)

Considering that the Unique variable is an Indicator (0 or 1) returns the proportion of 1

Returns

The vector of proportions per Facies

Parameters

[in]

db

Db structure

dbStatisticsInGridTool()

int dbStatisticsInGridTool	(	Db *	db,
		DbGrid *	dbgrid,
		const VectorString &	names,
		const EStatOption &	oper,
		int	radius,
		int	iptr0
	)

Calculates the monovariate statistics within cells of a grid

Returns

Error return code

Parameters

[in]	db	Db for the points
[in]	dbgrid	Db for the grid
[in]	names	Vector of target variable names
[in]	oper	A EStatOption item
[in]	radius	Neighborhood radius
[in]	iptr0	Storage address (first variable)

hscatterPairs()

VectorVectorInt hscatterPairs	(	Db *	db,
		const String &	name1,
		const String &	name2,
		VarioParam *	varioparam,
		int	ipas,
		int	idir,
		bool	verbose
	)

Evaluate the shifted correlation calculated as follows: Correl(Z1(x) , Z2(x+h))

Returns

Vector of indices (or VectorVectorInt())

Parameters

[in]	db	Db descriptor
[in]	name1	Name of the first variable
[in]	name2	Name of the second variable
[in]	varioparam	pointer to a VarioParam structure
[in]	ipas	Rank of the lag of interest
[in]	idir	Rank of the direction of interest (within VarioParam)
[in]	verbose	Verbose flag

Remarks

The returned Vector of Vector of integer 'indices' contain

the set of indices of the pairs of samples.

Its contents is i1,j1,i2,j2,...

The indices are numbered starting from 1

KeysToStatOptions()

std::vector<EStatOption> KeysToStatOptions

(

const VectorString &

opers

)

sphering()

MatrixSquareGeneral* sphering

(

const AMatrix *

X

)

Sphering procedure

Parameters

X	Input Data vector

Returns

The Sphering matrix (or nullptr if problem)

Remarks

When performing the (forward) sphering, you must perform the following operation

X <- prodMatMat(X, S)

statisticsProportion()

int statisticsProportion	(	DbGrid *	dbin,
		DbGrid *	dbout,
		int	pos,
		int	nfacies,
		int	radius
	)

Calculates the "montee" from a grid into a 1-D grid

Returns

Error return code

Parameters

[in]	dbin	Db for the input grid
[in]	dbout	Db for the output grid
[in]	pos	Rank of the montee axis (starting from 0)
[in]	nfacies	Number of facies
[in]	radius	Radius of the neighborhood

statisticsTransition()

int statisticsTransition	(	DbGrid *	dbin,
		DbGrid *	dbout,
		int	pos,
		int	nfacies,
		int	radius,
		int	orient
	)

Calculates the transition from a grid into a 1-D grid

Returns

Error return code

Parameters

[in]	dbin	Db for the input grid
[in]	dbout	Db for the output grid
[in]	pos	Rank of the montee axis (starting from 0)
[in]	nfacies	Number of facies
[in]	radius	Radius of the neighborhood
[in]	orient	Orientation (+1 or -1)

statOptionToName()

VectorString statOptionToName

(

const std::vector< EStatOption > &

opers

)