Libpiv API documentation

 Search for 

/home/gerber/gpiv_all/libgpiv-0.4.0/include/gpiv/post.h File Reference

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

Data Structures
struct	__GpivRoi
struct	__GpivPostPar
Defines
#define	GPIV_POSTPAR_DEFAULT__OPERATOR_MANIPIV   0
#define	GPIV_POSTPAR_DEFAULT__SET   1
#define	GPIV_POSTPAR_DEFAULT__SET_DX   0.0
#define	GPIV_POSTPAR_DEFAULT__SET_DY   0.0
#define	GPIV_POSTPAR_DEFAULT__SUBTRACT   0
#define	GPIV_POSTPAR_DEFAULT__Z_OFF_DX   0.0
#define	GPIV_POSTPAR_DEFAULT__Z_OFF_DY   0.0
#define	GPIV_POSTPAR_DEFAULT__DIFF_TYPE   2
#define	GPIV_POSTPAR_DEFAULT__OPERATOR_VORSTRA   0
#define	GPIV_POSTPAR_DEFAULT__SCALE_TYPE   0
Enumerations
enum	GpivOperationManipiv { GPIV_FAST_Y = 0, GPIV_FLIP_X = 1, GPIV_FLIP_Y = 2, GPIV_REVERT = 3, GPIV_ROT90 = 4, GPIV_ROT180 = 5, GPIV_FILTER_BLOCK = 6, GPIV_PASS_BLOCK = 7, GPIV_ADD_XY = 8 }
enum	GpivDifferentiation { GPIV_CENTRAL = 0, GPIV_LEAST_SQUARES = 1, GPIV_RICHARDSON = 2, GPIV_CIRCULATION = 3 }
enum	GpivOperation { GPIV_VORTICITY = 0, GPIV_S_STRAIN = 1, GPIV_N_STRAIN = 2 }
enum	GpivScaleType { GPIV_SCALE = 0, GPIV_SCALE_INV = 1 }
enum	GpivVelComponent { GPIV_U, GPIV_V }
Functions
void	gpiv_post_parameters_logic (GpivPostPar *piv_post_par, gboolean flag)
void	gpiv_post_default_parameters (GpivPostPar *piv_post_par_default, gboolean force)
void	gpiv_post_read_parameters (FILE *fp_par, GpivPostPar *piv_post_par, gboolean print_par)
char *	gpiv_post_check_parameters_read (GpivPostPar *piv_post_par, GpivPostPar piv_post_par_default)
void	gpiv_post_fprint_parameters (FILE *fp_par_out, GpivPostPar piv_post_par)
char *	gpiv_post_fread_hdf5_parameters (char *fname, GpivPostPar *piv_post_par)
char *	gpiv_post_fwrite_hdf5_parameters (char *fname, GpivPostPar *piv_post_par)
char *	gpiv_post_manipiv (char *fname_in_piv, gboolean fname_logic, GpivPivData in_data, GpivPivData *out_data, GpivPostPar piv_post_par, char d_line[GPIV_MAX_LINES][GPIV_MAX_CHARS], int nd_lines, char c_line[GPIV_MAX_LINES_C][GPIV_MAX_CHARS], int *nc_lines)
void	gpiv_post_savg (GpivPivData in_data, GpivPivData *out_data, GpivPostPar piv_post_par, int *ndata)
void	gpiv_post_uvhisto (GpivPivData in_data, GpivBinData *klass, enum GpivVelComponent velcomp)
void	gpiv_post_subtract_dxdy (GpivPivData in_data, GpivPivData *out_data, float z_off_dx, float z_off_dy)
int	gpiv_post_scale (GpivPivData in_data, GpivPivData *out_data, GpivImagePar image_par)
int	gpiv_post_inverse_scale (GpivPivData in_data, GpivPivData *out_data, GpivImagePar image_par)
char *	gpiv_post_vorstra (GpivPivData in_data, GpivScalarData *out_data, GpivPostPar piv_post_par)
Variables
enum GpivOperationManipiv	OPERATOR_MANIPIV
__GpivRoi	block
enum GpivScaleType	GPIV_SCALE_TYPE

---

Detailed Description

module for post-processing of PIV data

SOURCES: lib/postc, lib/post_par.c

LAST MODIFICATION DATE:

Id

post.h,v 1.18 2007-01-29 11:53:54 gerber Exp

---

Define Documentation

#define GPIV_POSTPAR_DEFAULT__DIFF_TYPE   2

Default parameter for diff_type of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__OPERATOR_MANIPIV   0

Default parameter for operator_manipiv of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__OPERATOR_VORSTRA   0

Default parameter for operator_vorstra of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__SCALE_TYPE   0

Default parameter for scale_type of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__SET   1

Default parameter for set of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__SET_DX   0.0

Default parameter for set_dx of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__SET_DY   0.0

Default parameter for set_dx of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__SUBTRACT   0

Default parameter for subtract of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__Z_OFF_DX   0.0

Default parameter for z_off_dx of __GpivPostPar

#define GPIV_POSTPAR_DEFAULT__Z_OFF_DY   0.0

Default parameter for z_off_dy of __GpivPostPar

---

Enumeration Type Documentation

enum GpivDifferentiation

Differential type

Enumerator:

GPIV_CENTRAL	Central differential
GPIV_LEAST_SQUARES	Least square
GPIV_RICHARDSON	Richarchon differential
GPIV_CIRCULATION	Circulation method

enum GpivOperation

Type of derivative operation

Enumerator:

GPIV_VORTICITY	Vorticity
GPIV_S_STRAIN	Shear strain
GPIV_N_STRAIN	Normal strain

enum GpivOperationManipiv

Operator to transform (manipulate) PIV data

Enumerator:

GPIV_FAST_Y	returns fast running y-positions of data
GPIV_FLIP_X	flip in x-direction
GPIV_FLIP_Y	flip in y-direction
GPIV_REVERT	reverts array indexes
GPIV_ROT90	rotates over 90 degrees
GPIV_ROT180	rotates over 180 degrees
GPIV_FILTER_BLOCK	filters out
GPIV_PASS_BLOCK	passes through
GPIV_ADD_XY	adds specified displacement/velocity in x and y direction

enum GpivScaleType

Variables for scaling PIV data

Enumerator:

GPIV_SCALE	Scaling PIV data
GPIV_SCALE_INV	Inverse scaling PIV data

enum GpivVelComponent

Velocity component

Enumerator:

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

---

Function Documentation

char* gpiv_post_check_parameters_read	(	GpivPostPar *	piv_post_par,
		GpivPostPar	piv_post_par_default
	)

Checks out if all parameters have been read. Else, set to default value.

Parameters:

[in]	piv_post_par	post-processing parameters
[in]	piv_post_par_default	default post-processing parameters
[out]	piv_post_par	post-processing parameters

Returns:

NULL on success or *err_msg on failure

void gpiv_post_default_parameters	(	GpivPostPar *	piv_post_par_default,
		gboolean	force
	)

Sets post-processing parameters to default values.

Parameters:

[in]	force	flag to enforce parameters set to defaults
[out]	piv_post_par_default	default post-processing parameters

Returns:

void

void gpiv_post_fprint_parameters	(	FILE *	fp_par_out,
		GpivPostPar	piv_post_par
	)

Prints parameters to fp_par_out.

Parameters:

[in]	piv_post_par	post-processing parameters
[in]	fp_par_out	pointer to output file

Returns:

void

char* gpiv_post_fread_hdf5_parameters	(	char *	fname,
		GpivPostPar *	piv_post_par
	)

Reads post parameters from hdf5 data file.

Parameters:

[in]	fname	file name of data file
[out]	piv_post_par	post-processing parameters

Returns:

NULL on success or *err_msg on failure

char* gpiv_post_fwrite_hdf5_parameters	(	char *	fname,
		GpivPostPar *	piv_post_par
	)

Writes post parameters to an existing hdf5 data file.

Parameters:

[in]	fname	file name of data file
[in]	piv_post_par	post-processing parameters

Returns:

NULL on success or *err_msg on failure

int gpiv_post_inverse_scale	(	GpivPivData	in_data,
		GpivPivData *	out_data,
		GpivImagePar	image_par
	)

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

Parameters:

[in]	in_data	input piv data
[in]	image_par	image parameter structure
[out]	out_data	output piv data

Returns:

0 on success

char* gpiv_post_manipiv	(	char *	fname_in_piv,
		gboolean	fname_logic,
		GpivPivData	in_data,
		GpivPivData *	out_data,
		GpivPostPar	piv_post_par,
		char	d_line[GPIV_MAX_LINES][GPIV_MAX_CHARS],
		int	nd_lines,
		char	c_line[GPIV_MAX_LINES_C][GPIV_MAX_CHARS],
		int *	nc_lines
	)

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

Parameters:

[in]	fname_in_piv	file name of input piv data
[in]	fname_logic	flag whether files are to be used
[in]	in_data	input piv data
[in]	piv_post_par	post-processing parameters
[in]	d_line	data lines
[in]	nd_lines	number of data lines
[in]	c_line	commented lines
[in]	nc_lines	number of commented lines
[out]	out_data	output piv data

Returns:

NULL on success or *err_msg on failure

void gpiv_post_parameters_logic	(	GpivPostPar *	piv_post_par,
		gboolean	flag
	)

Sets flag for piv_post_par _logic.

Parameters:

[in]	piv_post_par	post-processing parameters
[in]	flag	boolean to set

Returns:

void

void gpiv_post_read_parameters	(	FILE *	fp_par,
		GpivPostPar *	piv_post_par,
		gboolean	print_par
	)

Reads all parameters for PIV data validation.

Parameters:

[in]	fp_par	pointer to input file
[in]	print_par	flag to print parameters to stdout
[out]	piv_post_par	post-processing parameters

Returns:

void

void gpiv_post_savg	(	GpivPivData	in_data,
		GpivPivData *	out_data,
		GpivPostPar	piv_post_par,
		int *	ndata
	)

Piv post processing function to calculate spatial mean, variances.

Parameters:

[in]	in_data	input piv data
[in]	piv_post_par	post-processing parameters
[out]	out_data	output piv data
[out]	ndata	number of valid iput piv data

Returns:

void

int gpiv_post_scale	(	GpivPivData	in_data,
		GpivPivData *	out_data,
		GpivImagePar	image_par
	)

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

Parameters:

[in]	in_data	input piv data
[in]	image_par	image parameter structure
[out]	out_data	output piv data

Returns:

1 on success

void gpiv_post_subtract_dxdy	(	GpivPivData	in_data,
		GpivPivData *	out_data,
		float	z_off_dx,
		float	z_off_dy
	)

Subtracts displacements or velocity from piv data.

Parameters:

[in]	in_data	input piv data
[in]	z_off_dx	value in horizontal direction to be subtracted
[in]	z_off_dy	value in vertical direction to be subtracted
[out]	out_data	output piv data

Returns:

void

void gpiv_post_uvhisto	(	GpivPivData	in_data,
		GpivBinData *	klass,
		enum GpivVelComponent	velcomp
	)

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

Parameters:

[in]	in_data	input piv data
[in]	velcomp	velocity component from which histogram is calculated
[out]	klass	histogram

Returns:

void

char* gpiv_post_vorstra	(	GpivPivData	in_data,
		GpivScalarData *	out_data,
		GpivPostPar	piv_post_par
	)

Piv post processing function to calculate vorticity and strain.

Parameters:

[in]	in_data	input piv data
[in]	piv_post_par	post-processing parameters
[out]	out_data	output piv data

Returns:

NULL on success or *err_msg on failure

---

Variable Documentation

struct __GpivRoi block

Region Of Interest

enum GpivScaleType GPIV_SCALE_TYPE

Variables for scaling PIV data

enum GpivOperationManipiv OPERATOR_MANIPIV

Operator to transform (manipulate) PIV data

---