Vario.hpp File Reference

#include "gstlearn_export.hpp"
#include "geoslib_define.h"
#include "Db/DbGrid.hpp"
#include "Variogram/AVario.hpp"
#include "Variogram/VarioParam.hpp"
#include "Covariances/CovCalcMode.hpp"
#include "Basic/ASerializable.hpp"
#include "Geometry/ABiTargetCheck.hpp"

Classes
struct	Vario_Order
class	Vario
	Class containing the Spatial Characteristics as calculated experimentally from the data (contained in a Db). More...

Functions
GSTLEARN_EXPORT Vario_Order *	vario_order_manage (int mode, int flag_dist, int size_aux, Vario_Order *vorder)
GSTLEARN_EXPORT Vario_Order *	vario_order_final (Vario_Order *vorder, int *npair)
GSTLEARN_EXPORT void	vario_order_print (Vario_Order *vorder, int idir_target, int ipas_target, int verbose)
GSTLEARN_EXPORT void	vario_order_get_bounds (Vario_Order *vorder, int idir, int ipas, int *ifirst, int *ilast)
GSTLEARN_EXPORT void	vario_order_get_indices (Vario_Order *vorder, int ipair, int *iech, int *jech, double *dist)
GSTLEARN_EXPORT void	vario_order_get_auxiliary (Vario_Order *vorder, int ipair, char *aux_iech, char *aux_jech)
GSTLEARN_EXPORT int	vario_order_add (Vario_Order *vorder, int iech, int jech, void *aux_iech, void *aux_jech, int ipas, int idir, double dist)

Function Documentation

vario_order_add()

GSTLEARN_EXPORT int vario_order_add	(	Vario_Order *	vorder,
		int	iech,
		int	jech,
		void *	aux_iech,
		void *	aux_jech,
		int	ipas,
		int	idir,
		double	dist
	)

Add a record to the Variogram Order structure

Returns

Error return code

Parameters

[in]	vorder	Vario_Order structure
[in]	iech	Rank of the first sample
[in]	jech	Rank of the second sample
[in]	aux_iech	Auxiliary array for sample 'iech' (or NULL)
[in]	aux_jech	Auxiliary array for sample 'jech' (or NULL)
[in]	ipas	Rank of the lag
[in]	idir	Rank of the direction (or 0)
[in]	dist	Calculated distance (only stored if flag_dist == 1)

vario_order_final()

GSTLEARN_EXPORT Vario_Order* vario_order_final	(	Vario_Order *	vorder,
		int *	npair
	)

Resize the array and sort it

Returns

Pointer to the Vario_Order structure

Parameters

[in]	vorder	Vario_Order structure
[in]	npair	Final number of pairs

vario_order_get_auxiliary()

GSTLEARN_EXPORT void vario_order_get_auxiliary	(	Vario_Order *	vorder,
		int	ipair,
		char *	aux_iech,
		char *	aux_jech
	)

Returns the two auxiliary arrays for a given (ordered) pair

Parameters

[in]	vorder	Vario_Order structure
[in]	ipair	Rank of the sorted pair
[out]	aux_iech	Array to auxiliary information for sample 'iech'
[out]	aux_jech	Array to auxiliary information for sample 'jech'

vario_order_get_bounds()

GSTLEARN_EXPORT void vario_order_get_bounds	(	Vario_Order *	vorder,
		int	idir,
		int	ipas,
		int *	ifirst,
		int *	ilast
	)

Returns the first and last indices matching a target lag

Parameters

[in]	vorder	Vario_Order structure
[in]	idir	Rank of the target direction
[in]	ipas	Rank of the target lag
[out]	ifirst	Rank of the first sample of the lag (included)
[out]	ilast	Rank of the last sample of the lag (excluded)

vario_order_get_indices()

GSTLEARN_EXPORT void vario_order_get_indices	(	Vario_Order *	vorder,
		int	ipair,
		int *	iech,
		int *	jech,
		double *	dist
	)

Returns the two samples for a given (ordered) pair

Parameters

[in]	vorder	Vario_Order structure
[in]	ipair	Rank of the sorted pair
[out]	iech	Rank of the first sample
[out]	jech	Rank of the second sample
[out]	dist	Calculated distance or TEST (if flag_dist == 0)

vario_order_manage()

GSTLEARN_EXPORT Vario_Order* vario_order_manage	(	int	mode,
		int	flag_dist,
		int	size_aux,
		Vario_Order *	vorder
	)

Manage the Variogram Order structure

Returns

Pointer to the Vario_Order structure

Parameters

[in]	mode	Usage: 1 : to initialize 0 : to clean the geometry -1 : to delete
[in]	flag_dist	1 if distances are stored; 0 otherwise
[in]	size_aux	Size (in bytes) of the auxiliary array
[in]	vorder	Vario_Order structure

vario_order_print()

GSTLEARN_EXPORT void vario_order_print	(	Vario_Order *	vorder,
		int	idir_target,
		int	ipas_target,
		int	verbose
	)

Print the Vario_Order structure

Parameters

[in]	vorder	Vario_Order structure
[in]	idir_target	Rank of the target direction (starting from 0) or -1
[in]	ipas_target	Rank of the target lag (starting from 0) or -1
[in]	verbose	1 for a complete printout