Libpiv API documentation

 Search for 

gpiv-valid_par.h File Reference

module for parameters for validating PIV data More...

Go to the source code of this file.

Data Structures
struct	__GpivValidPar
	Piv validation parameters. More...
Defines
#define	GPIV_VALIDPAR_KEY   "VALID"
#define	GPIV_VALIDPAR_MAX__NEIGHBORS   9
Typedefs
typedef __GpivValidPar	GpivValidPar
Enumerations
enum	ResiduType { GPIV_VALID_RESIDUTYPE__SNR, GPIV_VALID_RESIDUTYPE__MEDIAN, GPIV_VALID_RESIDUTYPE__NORMMEDIAN }
enum	SubstitutionType { GPIV_VALID_SUBSTYPE__NONE, GPIV_VALID_SUBSTYPE__L_MEAN, GPIV_VALID_SUBSTYPE__MEDIAN, GPIV_VALID_SUBSTYPE__COR_PEAK }
Functions
void	gpiv_valid_parameters_set (GpivValidPar *valid_par, const gboolean flag)
void	gpiv_valid_default_parameters (GpivValidPar *valid_par_default, const gboolean force)
GpivValidPar *	gpiv_valid_get_parameters_from_resources (const gchar *localrc, const gboolean verbose)
void	gpiv_valid_read_parameters (FILE *fp_par, GpivValidPar *valid_par, const gboolean print_par)
gchar *	gpiv_valid_check_parameters_read (GpivValidPar *valid_par, const GpivValidPar *valid_par_default)
gchar *	gpiv_valid_testonly_parameters (const GpivValidPar *valid_par)
gchar *	gpiv_valid_testadjust_parameters (GpivValidPar *valid_par)
void	gpiv_valid_print_parameters (FILE *fp, const GpivValidPar *valid_par)
GpivValidPar *	gpiv_valid_cp_parameters (const GpivValidPar *valid_par)
void	gpiv_valid_dupl_parameters (const GpivValidPar *valid_par_src, GpivValidPar *valid_par_dest)
GpivValidPar *	gpiv_valid_fread_hdf5_parameters (const gchar *fname)
gchar *	gpiv_valid_fwrite_hdf5_parameters (const gchar *fname, const GpivValidPar *valid_par)

---

Detailed Description

module for parameters for validating PIV data

SOURCES: lib/valid_par.c

LAST MODIFICATION DATE: $Id:$

Definition in file gpiv-valid_par.h.

---

Define Documentation

#define GPIV_VALIDPAR_KEY   "VALID"

Key of validation processing parameters

Definition at line 60 of file gpiv-valid_par.h.

#define GPIV_VALIDPAR_MAX__NEIGHBORS   9

Maximum numbers of adjacent neighbours for validation testing and and calculation of substitution

Definition at line 61 of file gpiv-valid_par.h.

---

Typedef Documentation

typedef struct __GpivValidPar GpivValidPar

Definition at line 93 of file gpiv-valid_par.h.

---

Enumeration Type Documentation

enum ResiduType

Type of residu to detect outliers

Enumerator:

GPIV_VALID_RESIDUTYPE__SNR	Signal to noise ratio
GPIV_VALID_RESIDUTYPE__MEDIAN	median value of NxN surrounding estimators
GPIV_VALID_RESIDUTYPE__NORMMEDIAN	normalized median, obtained from the ratio between datapoint under investigation and median velocity (from 3x3 array, excluding current point) and median residu. Ref. Westerweel, Scarano, Exp. in Fluids, 39 (2005), pp1096-1100.

Definition at line 68 of file gpiv-valid_par.h.

enum SubstitutionType

Erroneous vector substituted by type

Enumerator:

GPIV_VALID_SUBSTYPE__NONE	no value, point will be disabled by setting __GpivPivData peak_nr to -1
GPIV_VALID_SUBSTYPE__L_MEAN	substitute by local mean value
GPIV_VALID_SUBSTYPE__MEDIAN	substitute by median value from surroundings
GPIV_VALID_SUBSTYPE__COR_PEAK	use location of next highest correlation peak as estimator

Definition at line 84 of file gpiv-valid_par.h.

---

Function Documentation

gchar* gpiv_valid_check_parameters_read	(	GpivValidPar *	valid_par,
		const GpivValidPar *	valid_par_default
	)

Checks out if all parameters have been read. If a parameter has not been read, it will set to valid_par_default or to the default value from libgpiv in case valid_par_default is NULL.

Parameters:

[in]	valid_par_default	default validation parameters
[in]	valid_par	validation parameters
[out]	valid_par	validation parameters

Returns:

NULL on success or error message on failure

GpivValidPar* gpiv_valid_cp_parameters

(

const GpivValidPar *

valid_par

)

Copies validation parameters.

Parameters:

[in]

valid_par

validation parameters to be copied

Returns:

GpivValidPar * or NULL on failure

void gpiv_valid_default_parameters	(	GpivValidPar *	valid_par_default,
		const gboolean	force
	)

Sets parameters to default values.

Parameters:

[in]	force	flag to enforce parameters set to defaults
[out]	valid_par_default	struct of validation parameters

Returns:

void

void gpiv_valid_dupl_parameters	(	const GpivValidPar *	valid_par_src,
		GpivValidPar *	valid_par_dest
	)

Duplicates validation parameters from valid_par_src to valid_par_dest if valid_par_dest have not been set.

Parameters:

[in]	valid_par_src	source validation parameters to be copied
[out]	valid_par_dest	the copied validation parameters

Returns:

void

GpivValidPar* gpiv_valid_fread_hdf5_parameters

(

const gchar *

fname

)

Reads validation parameters from hdf5 data file.

Parameters:

[in]

fname

file name of data file

Returns:

GpivValidPar or NULL on failure

gchar* gpiv_valid_fwrite_hdf5_parameters	(	const gchar *	fname,
		const GpivValidPar *	valid_par
	)

Writes validation parameters to an existing hdf5 data file.

Parameters:

[in]	fname	file name of data file
[in]	valid_par	struct of validation parameters

Returns:

NULL on success or error message on failure

GpivValidPar* gpiv_valid_get_parameters_from_resources	(	const gchar *	localrc,
		const gboolean	verbose
	)

Reads validation parameters from system-wide gpiv.conf and $HOME/.gpivrc.

Parameters:

[in]	localrc	resource filename containing parameter at current directory
[in]	verbose	prints parameter values when read

Returns:

GpivValidPar or NULL on failure

void gpiv_valid_parameters_set	(	GpivValidPar *	valid_par,
		const gboolean	flag
	)

Defines value of __set members of PivValidPar.

Parameters:

[in]	valid_par	validation parameters
[in]	flag	boolean to define __set value
[out]	valid_par	struct of validation parameters

Returns:

void

void gpiv_valid_print_parameters	(	FILE *	fp,
		const GpivValidPar *	valid_par
	)

Prints all validation parameters in ASCII format to fp.

Parameters:

[in]	fp	file pointer to printed file. If NULL, fp points to stdout.
[in]	valid_par	validation parameters

Returns:

void

void gpiv_valid_read_parameters	(	FILE *	fp_par,
		GpivValidPar *	valid_par,
		const gboolean	print_par
	)

Reads validation parameters from file.

Parameters:

[in]	fp_par	file pointer to file to be read. If NULL, stdin will be used.
[in]	print_par	boolean to print parameters to stdout
[out]	valid_par	validation parameters

Returns:

void

gchar* gpiv_valid_testadjust_parameters

(

GpivValidPar *

valid_par

)

Tests if all validation parameters have been read and have been defined to valid values. Aplies missing parameters to defaults, as hard-coded in the library and adjusts parameters if necessary.

Parameters:

[in]

valid_par

validation parameters

Returns:

NULL on success or error message on failure

gchar* gpiv_valid_testonly_parameters

(

const GpivValidPar *

valid_par

)

Tests if all validation parameters have been read and have been defined to valid values.

Parameters:

[in]

valid_par

validation parameters

Returns:

NULL on success or error message on failure

---