CalcSimpleInterpolation.hpp File Reference

#include "gstlearn_export.hpp"
#include "geoslib_define.h"
#include "Model/Model.hpp"
#include "Calculators/ACalcInterpolator.hpp"

Classes
class	CalcSimpleInterpolation

Functions
GSTLEARN_EXPORT int	inverseDistance (Db *dbin, Db *dbout, double exponent=2., bool flag_expand=true, double dmax=TEST, bool flag_est=true, bool flag_std=false, Model *model=nullptr, const NamingConvention &namconv=NamingConvention("InvDist"))
GSTLEARN_EXPORT int	nearestNeighbor (Db *dbin, Db *dbout, bool flag_est=true, bool flag_std=false, Model *model=nullptr, const NamingConvention &namconv=NamingConvention("Nearest"))
GSTLEARN_EXPORT int	movingAverage (Db *dbin, Db *dbout, ANeigh *neigh, bool flag_est=true, bool flag_std=false, Model *model=nullptr, const NamingConvention &namconv=NamingConvention("MovAve"))
GSTLEARN_EXPORT int	movingMedian (Db *dbin, Db *dbout, ANeigh *neigh, bool flag_est=true, bool flag_std=false, Model *model=nullptr, const NamingConvention &namconv=NamingConvention("MovMed"))
GSTLEARN_EXPORT int	leastSquares (Db *dbin, Db *dbout, ANeigh *neigh, int order=0, const NamingConvention &namconv=NamingConvention("LstSqr"))

Function Documentation

inverseDistance()

GSTLEARN_EXPORT int inverseDistance	(	Db *	dbin,
		Db *	dbout,
		double	exponent,
		bool	flag_expand,
		double	dmax,
		bool	flag_est,
		bool	flag_std,
		Model *	model,
		const NamingConvention &	namconv
	)

Inverse distance estimation

Returns

Error return code

Parameters

[in]	dbin	Input Db structure
[in]	dbout	Output Db structure
[in]	exponent	exponent of the inverse distance
[in]	flag_expand	True for expansion option (if dbin is Grid)
[in]	dmax	Maximum search radius (if dbin is Points)
[in]	flag_est	True if the estimation must be calculated
[in]	flag_std	True if the St. Dev. must be calculated
[in]	model	Model structure (used for St. Dev.)
[in]	namconv	Naming convention

leastSquares()

GSTLEARN_EXPORT int leastSquares	(	Db *	dbin,
		Db *	dbout,
		ANeigh *	neigh,
		int	order,
		const NamingConvention &	namconv
	)

Polynomial estimation using Least Squares

Returns

Error return code

Parameters

[in]	dbin	Input Db structure
[in]	dbout	Output Db structure
[in]	neigh	ANeigh structure
[in]	order	Order of the polynomial
[in]	namconv	Naming Convention

movingAverage()

GSTLEARN_EXPORT int movingAverage	(	Db *	dbin,
		Db *	dbout,
		ANeigh *	neigh,
		bool	flag_est,
		bool	flag_std,
		Model *	model,
		const NamingConvention &	namconv
	)

Moving Average estimation

Returns

Error return code

Parameters

[in]	dbin	Input Db structure
[in]	dbout	Output Db structure
[in]	neigh	ANeigh structure
[in]	flag_est	True if the estimation must be calculated
[in]	flag_std	True if the St. Dev. must be calculated
[in]	model	Model structure (used for St. Dev.)
[in]	namconv	Naming convention

movingMedian()

GSTLEARN_EXPORT int movingMedian	(	Db *	dbin,
		Db *	dbout,
		ANeigh *	neigh,
		bool	flag_est,
		bool	flag_std,
		Model *	model,
		const NamingConvention &	namconv
	)

Moving Median estimation

Returns

Error return code

Parameters

[in]	dbin	Input Db structure
[in]	dbout	Output Db structure
[in]	neigh	ANeigh structure
[in]	flag_est	True if the estimation must be calculated
[in]	flag_std	True if the St. Dev. must be calculated
[in]	model	Model structure (used for St. Dev.)
[in]	namconv	Naming convention

nearestNeighbor()

GSTLEARN_EXPORT int nearestNeighbor	(	Db *	dbin,
		Db *	dbout,
		bool	flag_est,
		bool	flag_std,
		Model *	model,
		const NamingConvention &	namconv
	)

Nearest Neighbor estimation

Returns

Error return code

Parameters

[in]	dbin	Input Db structure
[in]	dbout	Output Db structure
[in]	flag_est	True if the estimation must be calculated
[in]	flag_std	True if the St. Dev. must be calculated
[in]	model	Model structure (used for St. Dev.)
[in]	namconv	Naming convention