#include <DbHelper.hpp>

Inheritance diagram for DbHelper:

Static Public Member Functions
static int	findDuplicates (Db db1, Db db2, bool flag_same, bool verbose, int opt_code, double tolcode, const VectorDouble &dist, VectorDouble &sel)

static int	centerPointToGrid (Db db_point, DbGrid db_grid, double eps_random=EPSILON6)

static int	normalizeVariables (Db db, const char oper, const VectorInt &cols, double center, double stdv)

static int	dbgrid_filling (DbGrid *dbgrid, int mode=0, int seed=34342, int radius=1, bool verbose=false, const NamingConvention &namconv=NamingConvention("Fill"))

static int	db_duplicate (Db *db, bool verbose=false, const VectorDouble &dist=VectorDouble(), int opt_code=0, double tolcode=0., const NamingConvention &namconv=NamingConvention("Duplicate", true, true, true, ELoc::fromKey("SEL")))

static int	db_compositional_transform (Db db, int verbose, int mode, int type, int number, int iatt_in, int iatt_out, int numout)

static DbGrid *	dbgrid_sampling (DbGrid *dbin, const VectorInt &nmult)

static int	db_grid1D_fill (DbGrid *dbgrid, int mode=0, int seed=34243, const NamingConvention &namconv=NamingConvention("Fill"))

Member Function Documentation

int DbHelper::centerPointToGrid	(	Db *	db_point,
		DbGrid *	db_grid,
		double	eps_random = `EPSILON6`
	)

static

Centers the samples of a Db to the center of blocks of a grid Db

Returns: Error return code

Parameters

[in]	db_point	descriptor of the point parameters
[in]	db_grid	descriptor of the grid parameters
[in]	eps_random	Randomisation Epsilon

Remarks: The argument 'eps_random' allows perturbating the centered; coordinate so that it does not lie exactly on the node.; This possibility makes sense in order to identify centered data; from data actually located on the grid center (before migration); The perturbation is calculated as DX(i) * eps

int DbHelper::db_compositional_transform	(	Db *	db,
		int	verbose,
		int	mode,
		int	type,
		int	number,
		int *	iatt_in,
		int *	iatt_out,
		int *	numout
	)

static

Translate a set of compositional variables into auxiliary variables

Returns: Error return code

Parameters

[in]	db	Db characteristics
[in]	verbose	1 for a Verbose option
[in]	mode	1 for Forward and -1 for Backward transformation
[in]	type	Type of conversion 0 : Simple transformation in proportion 1 : Additive logratio 2 : Centered logratio 3 : Isometric logratio
[in]	number	Number of input attributes
[in]	iatt_in	Array of the input attribute
[in]	iatt_out	Array of the output attribute
[out]	numout	Number of variables in output

Remarks: The additive and the isometric logratio transformations; transform N+1 compositional variables into N elements (Forward); and from N transformed elements into N+1 compositional variables; (Backwards).; The zero-values are replaced by a conventional small value; This is defined by a variable that can be corrected using; the keypair facility with the keyword 'CompositionalEps'; The arguments 'iatt_in' and 'iatt_out' can coincide.; Outlier Detection for Compositional Data Using Robust Methods; Math Geosciences (2008) 40: 233-248

int DbHelper::db_duplicate	(	Db *	db,
		bool	verbose = `false`,
		const VectorDouble &	dist = `VectorDouble()`,
		int	opt_code = `0`,
		double	tolcode = `0.`,
		const NamingConvention &	namconv = `NamingConvention("Duplicate", true, true, true, ELoc::fromKey("SEL"))`
	)

static

Look for duplicates within a Db

Returns: Error return code

Parameters

[in]	db	Db Structure
[in]	verbose	True for verbose output
[in]	dist	Array of the minimum distance
[in]	opt_code	code selection option (if code is defined) 0 : no use of the code selection 1 : codes must be close enough 2 : codes must be different
[in]	tolcode	Code tolerance
[in]	namconv	Naming convention

int DbHelper::db_grid1D_fill	(	DbGrid *	dbgrid,
		int	mode = `0`,
		int	seed = `34243`,
		const NamingConvention &	namconv = `NamingConvention("Fill")`
	)

static

Fill an incomplete 1-D grid

Returns: Error returned code

Parameters

[in]	dbgrid	Db grid structure
[in]	mode	Type of interpolation 0 : Linear interpolation 1 : Cubic Spline
[in]	seed	Seed used for the random number generation
[in]	namconv	Naming convention

int DbHelper::dbgrid_filling	(	DbGrid *	dbgrid,
		int	mode = `0`,
		int	seed = `34342`,
		int	radius = `1`,
		bool	verbose = `false`,
		const NamingConvention &	namconv = `NamingConvention("Fill")`
	)

static

Fill an incomplete grid

Returns: Error returned code

Parameters

[in]	dbgrid	Db grid structure
[in]	mode	Type of interpolation 0 : Moving average 1 : Inverse squared distance 2 : Interpolation by a linear plane 3 : Distance to the initial grains
[in]	seed	Seed used for the random number generation
[in]	radius	Radius of the neighborhood
[in]	verbose	Verbose flag
[in]	namconv	Naming convention

DbGrid * DbHelper::dbgrid_sampling	(	DbGrid *	dbin,
		const VectorInt &	nmult
	)

static

Sample a grid into a finer subgrid (all variables)

Returns: Error return code

Parameters

[in]	dbin	Descriptor of the grid parameters
[in]	nmult	Array of multiplicity coefficients

int DbHelper::findDuplicates	(	Db *	db1,
		Db *	db2,
		bool	flag_same,
		bool	verbose,
		int	opt_code,
		double	tolcode,
		const VectorDouble &	dist,
		VectorDouble &	sel
	)

static

Look for duplicates

Returns: Error return code

Parameters

[in]	db1	First Db
[in]	db2	Second Db
[in]	flag_same	True if the two Db files are the same
[in]	verbose	True for verbose output
[in]	opt_code	code selection option (if code is defined) 0 : no use of the code selection 1 : codes must be close enough 2 : codes must be different
[in]	tolcode	Code tolerance
[in]	dist	Array of the minimum distance whose length is the space dimension (or NULL for a null distance)
[out]	sel	Array containing the selection

int DbHelper::normalizeVariables	(	Db *	db,
		const char *	oper,
		const VectorInt &	cols,
		double	center,
		double	stdv
	)

static

Normalize a set of variables

Returns: Error returned code

Parameters

[in]	db	Db structure
[in]	oper	Name of the operator "mean" : Normalize the mean to the input value "stdv" : Normalize the st. dev. to the input value "scal" : Normalize the mean and st. dev. "prop" : Normalize the variables to proportions
[in]	cols	Ranks of the variables
[in]	center	Theoretical Mean value
[in]	stdv	Theoretical Standard Deviation value

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

include/Db/DbHelper.hpp
src/Db/DbHelper.cpp

Static Public Member Functions

Member Function Documentation