Libpiv API documentation

 Search for 

gpiv-post_par.h File Reference

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

Go to the source code of this file.

Data Structures
struct	__GpivRoi
	Region Of Interest. More...
struct	__GpivPostPar
	Parameters for post-processing PIV data. More...
Defines
#define	GPIV_POSTPAR_KEY   "POST"
Typedefs
typedef __GpivRoi	GpivRoi
typedef __GpivPostPar	GpivPostPar
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 }
Functions
void	gpiv_post_parameters_set (GpivPostPar *post_par, const gboolean flag)
void	gpiv_post_default_parameters (GpivPostPar *post_par_default, const gboolean force)
GpivPostPar *	gpiv_post_get_parameters_from_resources (const gchar *localrc, const gboolean verbose)
void	gpiv_post_read_parameters (FILE *fp_par, GpivPostPar *post_par, const gboolean print_par)
gchar *	gpiv_post_check_parameters_read (GpivPostPar *post_par, const GpivPostPar *post_par_default)
void	gpiv_post_print_parameters (FILE *fp_par_out, const GpivPostPar *post_par)
GpivPostPar *	gpiv_post_fread_hdf5_parameters (const gchar *fname)
gchar *	gpiv_post_fwrite_hdf5_parameters (const gchar *fname, const GpivPostPar *post_par)
Variables
enum GpivOperationManipiv	OPERATOR_MANIPIV
enum GpivScaleType	GPIV_SCALE_TYPE

---

Detailed Description

module for parameters for post-processing of PIV data

SOURCES: lib/post_par.c

LAST MODIFICATION DATE: $Id:$

Definition in file gpiv-post_par.h.

---

Define Documentation

#define GPIV_POSTPAR_KEY   "POST"

Key of post processing parameters

Definition at line 55 of file gpiv-post_par.h.

---

Typedef Documentation

typedef struct __GpivPostPar GpivPostPar

Definition at line 121 of file gpiv-post_par.h.

typedef struct __GpivRoi GpivRoi

Definition at line 108 of file gpiv-post_par.h.

---

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

Definition at line 78 of file gpiv-post_par.h.

enum GpivOperation

Type of derivative operation

Enumerator:

GPIV_VORTICITY	Vorticity
GPIV_S_STRAIN	Shear strain
GPIV_N_STRAIN	Normal strain

Definition at line 90 of file gpiv-post_par.h.

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

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

enum GpivScaleType

Variables for scaling PIV data

Enumerator:

GPIV_SCALE	Scaling PIV data
GPIV_SCALE_INV	Inverse scaling PIV data

Definition at line 101 of file gpiv-post_par.h.

---

Function Documentation

gchar* gpiv_post_check_parameters_read	(	GpivPostPar *	post_par,
		const GpivPostPar *	post_par_default
	)

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

Parameters:

[in]	post_par	post-processing parameters
[in]	post_par_default	default post-processing parameters
[out]	post_par	post-processing parameters

Returns:

NULL on success or error message on failure

void gpiv_post_default_parameters	(	GpivPostPar *	post_par_default,
		const gboolean	force
	)

Sets post-processing parameters to default values.

Parameters:

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

Returns:

void

GpivPostPar* gpiv_post_fread_hdf5_parameters

(

const gchar *

fname

)

Reads post parameters from hdf5 data file.

Parameters:

[in]

fname

file name of data file

Returns:

GpivPostPar or NULL on failure

gchar* gpiv_post_fwrite_hdf5_parameters	(	const gchar *	fname,
		const GpivPostPar *	post_par
	)

Writes post parameters to an existing hdf5 data file.

Parameters:

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

Returns:

NULL on success or error message on failure

GpivPostPar* gpiv_post_get_parameters_from_resources	(	const gchar *	localrc,
		const gboolean	verbose
	)

Reads post-processing parameters from localrc, $HOME/.gpivrc and system-wide gpiv.conf

Parameters:

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

Returns:

GpivPostPar or NULL on failure

void gpiv_post_parameters_set	(	GpivPostPar *	post_par,
		const gboolean	flag
	)

Sets flag for post_par __set.

Parameters:

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

Returns:

void

void gpiv_post_print_parameters	(	FILE *	fp_par_out,
		const GpivPostPar *	post_par
	)

Prints parameters to fp_par_out.

Parameters:

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

Returns:

void

void gpiv_post_read_parameters	(	FILE *	fp_par,
		GpivPostPar *	post_par,
		const 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]	post_par	post-processing parameters

Returns:

void

---

Variable Documentation

enum GpivScaleType GPIV_SCALE_TYPE

Variables for scaling PIV data

enum GpivOperationManipiv OPERATOR_MANIPIV

Operator to transform (manipulate) PIV data

---