Libpiv API documentation

 Search for 

gpiv-valid.h File Reference

module for validating PIV data More...

#include <gpiv/gpiv-valid_par.h>

Go to the source code of this file.

Data Structures
struct	__GpivLinRegData
	Data structure of linear regression data. More...
Defines
#define	GPIV_GRADIENT_THRESHOLD   2.0
#define	GPIV_THRESHOLD_DEFAULT   1.2
#define	GPIV_VALID_MAX_SWEEP   9
#define	GPIV_RESIDU_MAX_NORMMEDIAN   2.0
Typedefs
typedef __GpivLinRegData	GpivLinRegData
Functions
gchar *	gpiv_valid_residu (GpivPivData *piv_data, const GpivValidPar *valid_par, const gboolean incl_point)
GpivBinData *	gpiv_valid_residu_stats (const GpivPivData *piv_data, const guint nbins, GpivLinRegData *linreg)
GpivBinData *	gpiv_valid_peaklck (const GpivPivData *piv_data, const guint nbins)
gchar *	gpiv_valid_errvec (GpivPivData *piv_data, const GpivImage *image, const GpivPivPar *piv_par, const GpivValidPar *valid_par, const gboolean interrogate_valid)
void	gpiv_valid_gradient (const GpivPivPar *piv_par, GpivPivData *piv_data)
void	gpiv_cumhisto_eqdatbin_gnuplot (const gchar *fname_out, const gchar *title, const gchar *GNUPLOT_DISPLAY_COLOR, const gint GNUPLOT_DISPLAY_SIZE, const GpivLinRegData *linreg)
gfloat	gpiv_valid_threshold (const GpivPivPar *piv_par, const GpivValidPar *valid_par, const GpivLinRegData *linreg)

---

Detailed Description

module for validating PIV data

SOURCES: lib/valid.c, lib/valid_par.c

LAST MODIFICATION DATE:

Id

valid.h,v 1.20 2007-06-06 16:59:02 gerber Exp

Definition in file gpiv-valid.h.

---

Define Documentation

#define GPIV_GRADIENT_THRESHOLD   2.0

Default threshold of displacement gradient

Definition at line 65 of file gpiv-valid.h.

#define GPIV_RESIDU_MAX_NORMMEDIAN   2.0

residu threshold if normalized median is used

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

#define GPIV_THRESHOLD_DEFAULT   1.2

Default residu threshold

Definition at line 66 of file gpiv-valid.h.

#define GPIV_VALID_MAX_SWEEP   9

maximum number of validation sweeps, starting from zero

Definition at line 67 of file gpiv-valid.h.

---

Typedef Documentation

typedef struct __GpivLinRegData GpivLinRegData

Definition at line 73 of file gpiv-valid.h.

---

Function Documentation

void gpiv_cumhisto_eqdatbin_gnuplot	(	const gchar *	fname_out,
		const gchar *	title,
		const gchar *	GNUPLOT_DISPLAY_COLOR,
		const gint	GNUPLOT_DISPLAY_SIZE,
		const GpivLinRegData *	linreg
	)

Plots cumulative histogram with an equal number of data. per bin of klass on screen with gnuplot

Parameters:

[in]	fname_out	output file name
[in]	title	title of plot
[in]	GNUPLOT_DISPLAY_COLOR	color of gnuplot display
[in]	GNUPLOT_DISPLAY_SIZE	size of gnuplot display
[in]	linreg	linear regression data

Returns:

void

gchar* gpiv_valid_errvec	(	GpivPivData *	piv_data,
		const GpivImage *	image,
		const GpivPivPar *	piv_par,
		const GpivValidPar *	valid_par,
		const gboolean	interrogate_valid
	)

Piv data validation function on outliers

Parameters:

[in]	image	struct of image containing parameters and frames
[in]	piv_par	struct of piv image evaluation parameters
[in]	valid_par	struct of validation parameters
[in]	piv_data	piv data, will be corrected for outliers
[in]	interrogate_valid	validation during (iterative) interrogation process

Returns:

NULL or error message on failure

void gpiv_valid_gradient	(	const GpivPivPar *	piv_par,
		GpivPivData *	piv_data
	)

Searches vectors in a PIV data set that exceed the maximum gradient (dUxdt/int_size > GPIV_GRADIENT_THRESHOLD)

Parameters:

[in]	piv_par	struct of piv parameters
[in]	piv_data	PIV data set
[out]	piv_data	PIV data set containing peak_no = -1 for exceeded maxima

Returns:

void

GpivBinData* gpiv_valid_peaklck	(	const GpivPivData *	piv_data,
		const guint	nbins
	)

Piv data validation on peak-locking effects

Parameters:

[in]	piv_data	input piv data
[in]	nbins	number of bins that klass will contain

Returns:

GpivBinData on success or NULL on failure

gchar* gpiv_valid_residu	(	GpivPivData *	piv_data,
		const GpivValidPar *	valid_par,
		const gboolean	incl_point
	)

Calculates residu values (at the inner points) of a PIV data set and applies to snr member of returned GpivPivData

Parameters:

[in]	piv_data	piv dataset
[in]	valid_par	validation parameters
[in]	incl_point	flag to include data point under investigation

Returns:

NULL on success or error message on failure

GpivBinData* gpiv_valid_residu_stats	(	const GpivPivData *	piv_data,
		const guint	nbins,
		GpivLinRegData *	linreg
	)

Calculates cumulative histogram of residus and linear regression fit parameters

Parameters:

[out]	linreg	linear regression data structure
[in]	piv_data	piv dataset containing residu values in snr
[in]	nbins	number of points to be used for regression

Returns:

GpivBinData containing cumulative histogram or NULL on failure

gfloat gpiv_valid_threshold	(	const GpivPivPar *	piv_par,
		const GpivValidPar *	valid_par,
		const GpivLinRegData *	linreg
	)

Calculates threshold value (residu_max) from residus. Will need int_size_1 from the GpivPivPar struct

Parameters:

[in]	piv_par	piv image evaluation parameters
[in]	valid_par	validation parameters
[in]	linreg	linear regression data

Returns:

threshold value

---