Libpiv API documentation

 Search for 

gpiv-piv_par.h File Reference

module for parameters for image evaluation More...

Go to the source code of this file.

Data Structures
struct	__GpivPivPar
	Parameters for PIV evaluation (interrogation) of images. More...
Defines
#define	GPIV_PIVPAR_KEY   "PIV"
Typedefs
typedef __GpivPivPar	GpivPivPar
Enumerations
enum	GpivIntScheme { GPIV_NO_CORR, GPIV_LK_WEIGHT, GPIV_ZERO_OFF_FORWARD, GPIV_ZERO_OFF_CENTRAL, GPIV_IMG_DEFORM }
Functions
void	gpiv_piv_default_parameters (GpivPivPar *piv_par_default, const gboolean force)
GpivPivPar *	gpiv_piv_get_parameters_from_resources (const gchar *localrc, const gboolean verbose)
void	gpiv_piv_parameters_set (GpivPivPar *piv_par, const gboolean flag)
void	gpiv_piv_read_parameters (FILE *fp, GpivPivPar *piv_par, const gboolean verbose)
gchar *	gpiv_piv_check_parameters_read (GpivPivPar *piv_par, const GpivPivPar *piv_par_default)
gchar *	gpiv_piv_testonly_parameters (const GpivImagePar *image_par, const GpivPivPar *piv_par)
gchar *	gpiv_piv_testadjust_parameters (const GpivImagePar *image_par, GpivPivPar *piv_par)
void	gpiv_piv_print_parameters (FILE *fp, const GpivPivPar *piv_par)
GpivPivPar *	gpiv_piv_cp_parameters (const GpivPivPar *piv_par)
void	gpiv_piv_cp_undef_parameters (const GpivPivPar *piv_par_src, GpivPivPar *piv_par_dest)
GpivPivPar *	gpiv_piv_fread_hdf5_parameters (const gchar *fname)
gchar *	gpiv_piv_fwrite_hdf5_parameters (const gchar *fname, const GpivPivPar *piv_par)

---

Detailed Description

module for parameters for image evaluation

SOURCES: lib/piv_par.c

LAST MODIFICATION DATE: $Id:$

Definition in file gpiv-piv_par.h.

---

Define Documentation

#define GPIV_PIVPAR_KEY   "PIV"

Key of evaluation parameters

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

---

Typedef Documentation

typedef struct __GpivPivPar GpivPivPar

Image evaluation or interrogation parameters for obtaining PIV estimators

Definition at line 80 of file gpiv-piv_par.h.

---

Enumeration Type Documentation

enum GpivIntScheme

PIV interrogation scheme

Enumerator:

GPIV_NO_CORR
GPIV_LK_WEIGHT	Linear kernel weighting if Interrogation Area's
GPIV_ZERO_OFF_FORWARD	classical zero ofsetting
GPIV_ZERO_OFF_CENTRAL	zero ofsetting using central differential scheme
GPIV_IMG_DEFORM	image deformation

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

---

Function Documentation

gchar* gpiv_piv_check_parameters_read	(	GpivPivPar *	piv_par,
		const GpivPivPar *	piv_par_default
	)

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

Parameters:

[in]	piv_par_default	default parameters
[out]	piv_par	PIV evaluation parameters

Returns:

NULL on success or error message on failure

GpivPivPar* gpiv_piv_cp_parameters

(

const GpivPivPar *

piv_par

)

Copies piv parameters.

Parameters:

[in]

piv_par

piv parameters to be copied

Returns:

GpivPivPar or NULL on failure

void gpiv_piv_cp_undef_parameters	(	const GpivPivPar *	piv_par_src,
		GpivPivPar *	piv_par_dest
	)

Copies piv parameters from piv_par_src to piv_par_dest if piv_par_dest have not been set.

Parameters:

[in]	piv_par_src	piv parameters to be copied
[out]	piv_par_dest	the copied piv parameters

Returns:

void

void gpiv_piv_default_parameters	(	GpivPivPar *	piv_par_default,
		const gboolean	force
	)

Sets default parameter values.

Parameters:

[in]	force	flag to enforce parameters set to defaults
[out]	piv_par_default	structure of piv evaluation parameters

Returns:

void

GpivPivPar* gpiv_piv_fread_hdf5_parameters

(

const gchar *

fname

)

Reads piv parameters from hdf5 data file.

Parameters:

[in]

fname

input filename

Returns:

GpivPivPar of NULL on failure

gchar* gpiv_piv_fwrite_hdf5_parameters	(	const gchar *	fname,
		const GpivPivPar *	piv_par
	)

Writes piv parameters from hdf5 data file

Parameters:

[in]	fname	output filename
[out]	piv_par	PIV evaluation parameters

Returns:

NULL on success or error message on failure

GpivPivPar* gpiv_piv_get_parameters_from_resources	(	const gchar *	localrc,
		const gboolean	verbose
	)

Reads piv parameters from system-wide gpiv.conf and $HOME/.gpivrc.

Parameters:

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

Returns:

GpivPivPar or NULL on failure

void gpiv_piv_parameters_set	(	GpivPivPar *	piv_par,
		const gboolean	flag
	)

Sets flags for all piv_par__set.

Parameters:

[in]	flag	true (1) or false (0)
[out]	piv_par	PIV evaluation parameters

Returns:

void

void gpiv_piv_print_parameters	(	FILE *	fp,
		const GpivPivPar *	piv_par
	)

Prints parameters to fp.

Parameters:

[in]	fp	file pointer for output. If NULL, stdout will be used.
[in]	piv_par	PIV evaluation parameters

Returns:

void

void gpiv_piv_read_parameters	(	FILE *	fp,
		GpivPivPar *	piv_par,
		const gboolean	verbose
	)

Reads all parameters for PIV evaluation.

Parameters:

[in]	fp	file pointer to parameter file. If NULL, stdin will be used.
[in]	verbose	flag to print parameters to stdout
[out]	piv_par	PIV evaluation parameters

Returns:

NULL on success or error message on failure

gchar* gpiv_piv_testadjust_parameters	(	const GpivImagePar *	image_par,
		GpivPivPar *	piv_par
	)

Tests if all piv parameters have been read and have been defined to valid values. Aplies missing parameters to defaults, as hard-coded in the library and adjusts parameters if necessary.

Parameters:

[in]	image_par	image parameters
[in]	piv_par	PIV parameters

Returns:

NULL on success or error message on failure

gchar* gpiv_piv_testonly_parameters	(	const GpivImagePar *	image_par,
		const GpivPivPar *	piv_par
	)

Tests all piv parameters if have been read and have been defined to valid values.

Parameters:

[in]	image_par	image parameters
[in]	piv_par	PIV evaluation parameters

Returns:

NULL on success or error message on failure

---