Libpiv API documentation

 Search for 

gpiv-post.h File Reference

module for post-processing of PIV data More...

#include <gpiv/gpiv-post_par.h>

Go to the source code of this file.

Enumerations
enum	GpivVelComponent { GPIV_U, GPIV_V }
Functions
gchar *	gpiv_post_manipiv (GpivPivData *piv_data, const GpivPostPar *post_par)
gchar *	gpiv_post_savg (GpivPivData *piv_data, const GpivPostPar *post_par)
GpivBinData *	gpiv_post_uvhisto (const GpivPivData *piv_data, const guint nbins, const enum GpivVelComponent velcomp)
gchar *	gpiv_post_subtract_dxdy (GpivPivData *piv_data, const gfloat z_off_dx, const gfloat z_off_dy)
gchar *	gpiv_post_scale (GpivPivData *piv_data, const GpivImagePar *image_par)
gchar *	gpiv_post_inverse_scale (GpivPivData *piv_data, const GpivImagePar *image_par)
GpivScalarData *	gpiv_post_vorstra (const GpivPivData *piv_data, const GpivPostPar *post_par)

---

Detailed Description

module for post-processing of PIV data

SOURCES: lib/postc

LAST MODIFICATION DATE:

Id

post.h,v 1.19 2007-06-06 16:59:02 gerber Exp

Definition in file gpiv-post.h.

---

Enumeration Type Documentation

enum GpivVelComponent

Velocity component

Enumerator:

GPIV_U	Horizontal (x, column-wise
GPIV_V	Vertical (y, row-wise

Definition at line 62 of file gpiv-post.h.

---

Function Documentation

gchar* gpiv_post_inverse_scale	(	GpivPivData *	piv_data,
		const GpivImagePar *	image_par
	)

Piv post processing function to adjust for inversed time and spatial scales

Parameters:

[in]	piv_data	PIV data to be scaled in-place
[in]	image_par	image parameter structure

Returns:

NULL on success or error message on failure

gchar* gpiv_post_manipiv	(	GpivPivData *	piv_data,
		const GpivPostPar *	post_par
	)

Piv post processing function to manipulate data; flipping rotating, etc.

Parameters:

[in]	piv_data	PIV data to be manipulated in-place
[in]	post_par	post-processing parameters

Returns:

NULL on success or error message on failure

gchar* gpiv_post_savg	(	GpivPivData *	piv_data,
		const GpivPostPar *	post_par
	)

Piv post processing function to calculate spatial mean, variances.

Parameters:

[in]	piv_data	PIV data of which spatial average is calculated in-place
[in]	post_par	post-processing parameters

Returns:

NULL on success or error message on failure

gchar* gpiv_post_scale	(	GpivPivData *	piv_data,
		const GpivImagePar *	image_par
	)

Piv post processing function to adjust for time and spatial scales.

Parameters:

[in]	piv_data	PIV data to be scaled in-place
[in]	image_par	image parameter structure

Returns:

NULL on success or error message on failure

gchar* gpiv_post_subtract_dxdy	(	GpivPivData *	piv_data,
		const gfloat	z_off_dx,
		const gfloat	z_off_dy
	)

Subtracts a specified quantity from the PIV displacements.

Parameters:

[in]	piv_data	PIV data to be reduced in-place
[in]	z_off_dx	value in horizontal direction to be subtracted
[in]	z_off_dy	value in vertical direction to be subtracted

Returns:

NULL on success or error message on failure

GpivBinData* gpiv_post_uvhisto	(	const GpivPivData *	piv_data,
		const guint	nbins,
		const enum GpivVelComponent	velcomp
	)

Calculating histogram of U (horizontal) or V (vertical) particle displacements.

Parameters:

[in]	piv_data	PIV data
[in]	nbins	number of bins that klass will contain
[in]	velcomp	velocity component from which histogram is calculated

Returns:

GpivBinData on success or NULL on failure

GpivScalarData* gpiv_post_vorstra	(	const GpivPivData *	piv_data,
		const GpivPostPar *	post_par
	)

Piv post processing function to calculate vorticity and strain.

Parameters:

[in]	piv_data	PIV data from which derivatives are calculated
[in]	post_par	post-processing parameters

Returns:

GpivScalarData containing vorticity or strain

---