Libpiv API documentation

 Search for 

gpiv-piv_utils.h File Reference

utilities module for GpivPivData structure More...

Go to the source code of this file.

Functions
void	gpiv_null_pivdata (GpivPivData *piv_data)
GpivPivData *	gpiv_alloc_pivdata (const guint nx, const guint ny)
gchar *	gpiv_check_alloc_pivdata (const GpivPivData *piv_data)
void	gpiv_free_pivdata (GpivPivData *piv_data)
gchar *	gpiv_0_pivdata (GpivPivData *piv_data)
GpivPivData *	gpiv_cp_pivdata (const GpivPivData *piv_data)
gchar *	gpiv_ovwrt_pivdata (const GpivPivData *piv_data_in, GpivPivData *piv_data_out)
gchar *	gpiv_add_dxdy_pivdata (const GpivPivData *piv_data_in, GpivPivData *piv_data_out)
gchar *	gpiv_sum_dxdy_pivdata (const GpivPivData *piv_data, gfloat *sum)
gchar *	gpiv_piv_gnuplot (const gchar *title, const gfloat gnuplot_scale, const gchar *GNUPLOT_DISPLAY_COLOR, const guint GNUPLOT_DISPLAY_SIZE, const GpivImagePar *image_par, const GpivPivPar *piv_par, const GpivPivData *piv_data)
GpivCov *	gpiv_alloc_cov (const guint int_size0, const gboolean x_corr)
void	gpiv_free_cov (GpivCov *cov)

---

Detailed Description

utilities module for GpivPivData structure

SOURCES: lib/piv_utils.c

LAST MODIFICATION DATE:

Id

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

Definition in file gpiv-piv_utils.h.

---

Function Documentation

gchar* gpiv_0_pivdata

(

GpivPivData *

piv_data

)

Sets estimators, snr and peak_nr of piv_data to 0 or 0.0. The structure will have to be allocated before (with gpiv_alloc_pivdata).

Parameters:

[in]

piv_data

PIV data

Returns:

NULL on success or error message on failure

gchar* gpiv_add_dxdy_pivdata	(	const GpivPivData *	piv_data_in,
		GpivPivData *	piv_data_out
	)

Adds displacements (dx, dy), snr and peak_nr from piv_data_in to piv_data_out. Both structures will have to be allocated before (with gpiv_alloc_pivdata).

Parameters:

[in]	piv_data_in	Input PIV data structure
[out]	piv_data_out	Output PIV data structure

Returns:

NULL on success or error message on failure

GpivCov* gpiv_alloc_cov	(	const guint	int_size0,
		const gboolean	x_corr
	)

Allocates memory for GpivCov.

Parameters:

[in]	int_size0	size of zere-padded interrogation area
[in]	x_corr	two frame image / cross correlation

Returns:

covariance on success or NULL on failure

GpivPivData* gpiv_alloc_pivdata	(	const guint	nx,
		const guint	ny
	)

Allocates memory for GpivPivData.

Parameters:

[in]	nx	number of nx (column-wise data dimension)
[in]	ny	number of ny (row-wise data dimension)

Returns:

piv_data on success or NULL on failure

gchar* gpiv_check_alloc_pivdata

(

const GpivPivData *

piv_data

)

Checks if piv_data have been allocated.

Parameters:

[in]

piv_data

PIV data set to be checked if allocated

Returns:

NULL on success or error message on failure

GpivPivData* gpiv_cp_pivdata

(

const GpivPivData *

piv_data

)

Returns a copy of piv_data. Piv_data_in will have to be allocated with gpiv_alloc_pivdata and the returned datawill have to be freed with gpiv_free_pivdata.

Parameters:

[in]

piv_data

Input PIV data

Returns:

GpivPivData on success or NULL on failure

void gpiv_free_cov

(

GpivCov *

cov

)

Frees memory for GpivCov.

Parameters:

[in]

cov

Covariance structure

Returns:

void

void gpiv_free_pivdata

(

GpivPivData *

piv_data

)

Frees memory for GpivPivData.

Parameters:

[in]	piv_data	PIV data structure
[out]	piv_data	NULL pointer to point_x, point_y, dx, dy, snr and peak_no

Returns:

void

void gpiv_null_pivdata

(

GpivPivData *

piv_data

)

Sets all elements of piv_data structure to NULL.

Parameters:

[in]	piv_data	Input PIV data structure
[out]	piv_data	Output PIV data structure

Returns:

void

gchar* gpiv_ovwrt_pivdata	(	const GpivPivData *	piv_data_in,
		GpivPivData *	piv_data_out
	)

Overwrites piv_data_out with piv_data_in. Both PIV data sets will have to be allocated with gpiv_alloc_pivdata and must be of equal sizes.

Parameters:

[in]	piv_data_in	Input PIV data
[in]	piv_data_out	Output PIV data

Returns:

NULL on success or error message on failure

gchar* gpiv_piv_gnuplot	(	const gchar *	title,
		const gfloat	gnuplot_scale,
		const gchar *	GNUPLOT_DISPLAY_COLOR,
		const guint	GNUPLOT_DISPLAY_SIZE,
		const GpivImagePar *	image_par,
		const GpivPivPar *	piv_par,
		const GpivPivData *	piv_data
	)

Plots piv data as vectors on screen with gnuplot.

Parameters:

[in]	title	title of plot
[in]	gnuplot_scale	vector scale
[in]	GNUPLOT_DISPLAY_COLOR	display color of window containing graph
[in]	GNUPLOT_DISPLAY_SIZE	display size of window containing graph
[in]	image_par	image parameters
[in]	piv_par	piv evaluation parameters
[in]	piv_data	piv data

Returns:

NULL on success or error message on failure

gchar* gpiv_sum_dxdy_pivdata	(	const GpivPivData *	piv_data,
		gfloat *	sum
	)

Adds all displacements in order to calculate residuals The structure will have to be allocated before (with gpiv_alloc_pivdata).

Parameters:

[in]	piv_data	PIV data structure
[out]	sum	resulting sum

Returns:

NULL on success or error message on failure

---