CalcSimuPost.hpp File Reference

#include "gstlearn_export.hpp"
#include "ACalcDbToDb.hpp"
#include <Enum/EPostUpscale.hpp>
#include <Enum/EPostStat.hpp>
#include "Db/DbGrid.hpp"
#include "Basic/NamingConvention.hpp"
#include "Basic/VectorNumT.hpp"

Classes
class	CalcSimuPost

Functions
GSTLEARN_EXPORT int	simuPost (Db *dbin, DbGrid *dbout, const VectorString &names, bool flag_match=false, const EPostUpscale &upscale=EPostUpscale::fromKey("MEAN"), const std::vector< EPostStat > &stats=EPostStat::fromKeys({"MEAN"}), bool verbose=false, const VectorInt &check_targets=VectorInt(), int check_level=0, const NamingConvention &namconv=NamingConvention("Post"))

Function Documentation

GSTLEARN_EXPORT int simuPost	(	Db *	dbin,
		DbGrid *	dbout,
		const VectorString &	names,
		bool	flag_match,
		const EPostUpscale &	upscale,
		const std::vector< EPostStat > &	stats,
		bool	verbose,
		const VectorInt &	check_targets,
		int	check_level,
		const NamingConvention &	namconv
	)

Parameters

dbin	Input data base
dbout	Output data base (must be a Grid)
names	Vector of simulation names
flag_match	True if the ranks of simulations must match; otherwise: product
upscale	Option within EPostUpscale
stats	Vector of options within EPostStat
verbose	Verbose flag
check_targets	Rank (1-based) of the target element to be checked (0: None; -1: All)
check_level	0: Statistics; 1: Sample Selection; 2: Iteration definition
namconv	Naming convention

Returns

Error code

Remarks

• N : number of variables in 'dbin' defined by 'names' (index 'n')
• k_1, ..., k_N : number of outcomes for each variable
• K : number of multivariate simulations according to 'flag_match' (index 'k')
• Transformation function 'F' from Z in R_N to Y in R_P (index 'p')

Description of the Flow Chart:

1. Loop over cells of 'dbout' (index 'C')
2. Loop over the simulations (index 'k')
3. Find the active samples of 'dbin' in 'C' (index 's') and build table of Z_n^{k}(s)
4. Apply the Transform function to table: Y_p^{k}(s)
5. Upscale to the target cell according to upscaling rule '_upscale': up_Y_p^{k}(C)
6. Compute statistics according to stat rule '_stats'