LibGpiv API dokumentatsie

char* 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, for example).

Parameters:

[in] piv_data PIV data structure

Returns:: char * to NULL on success or *err_msg on failure

char* gpiv_add_dxdy_pivdata	(	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, for example).

Parameters:

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

Returns:: char * to NULL on success or *err_msg on failure

void gpiv_alloc_bindata ( GpivBinData * bin_data )

Allocates memory for GpivBinData

Parameters:

`[in]`	bin_data	nbins of GpivBinData
`[out]`	bin_data	count, bound, centre of GpivBinData

Returns:: void

guint16** gpiv_alloc_img ( GpivImagePar image_par )

Allocates memory for image

Parameters:

[in] image_par image parameters

Returns:: img 2-dim image data arry

void gpiv_alloc_pivdata ( GpivPivData * piv_data )

Allocates memory for GpivPivData

Parameters:

`[in]`	piv_data	.nx and .ny members of GpivPivData structure
`[out]`	piv_data	point_x, point_y, dx, dy, snr, peak_no of GpivPivData

Returns:: void

void gpiv_alloc_scdata ( GpivScalarData * scal_data )

Allocates memory for GpivScalarData

Parameters:

`[in]`	scal_data	.nx and .ny members of GpivScalarData structure
`[out]`	scal_data	point_x, point_y, scalar, flag of GpivScalarData

Returns:: void

void gpiv_cp_img	(	guint16 **	img_src,
		guint16 **	img_dest,
		GpivImagePar	image_par
	)

Copies contents of img_src to img_dest. Img_src and img_dest will have to be allocated with gpiv_alloc_img and freed with gpiv_free_img.

Parameters:

`[in]`	image_par	image parameters
`[in]`	img_src	2-dim image data arry
`[out]`	img_dest	2-dim image data arry

Returns:: void

char* gpiv_cp_pivdata	(	GpivPivData *	piv_data_in,
		GpivPivData *	piv_data_out
	)

Copies data from piv_data_in to piv_data_out. Piv_data_in and piv_data_out will have to allocated with gpiv_alloc_pivdata and freed with gpiv_free_pivdata.

Parameters:

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

Returns:: char * to NULL on success or *err_msg on failure

void gpiv_cumhisto	(	GpivPivData *	data,
		GpivBinData *	klass
	)

Calculates cumulative histogram from GpivPivData (NOT from GpivScalarData!!)

Parameters:

`[in]`	data	Input data
`[out]`	klass	Output data

Returns:: void

double** gpiv_double_matrix	(	glong	nr,
		glong	nc
	)

Allocates a contiguous 2-dimensional double matrix of nr x nc

Parameters:

`[in]`	nr	number of rows
`[in]`	nc	number of columns

Returns:: matrix

gdouble* gpiv_dvector ( glong nl )

Allocates memory for a 1-dimensional vector of gdouble data

Parameters:

[in] nl vector length

Returns:: vector

double* gpiv_dvector_index	(	long	nl,
		long	nh
	)

Allocates memory for a 1-dimensional vector of double data with subscript range v[nl..nh]

Parameters:

`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: vector

void gpiv_error	(	char *	message,
			...
	)

Prints error handling with variable argumanent list to stdout and exits program

Parameters:

[in] message warning message

Returns:: void

fftw_complex** gpiv_fftw_complex_matrix	(	long	nr,
		long	nc
	)

Allocates a contiguous 2-dimensional fftw_complex matrix of nr x nc

Parameters:

`[in]`	nr	number of rows
`[in]`	nc	number of columns

Returns:: matrix

fftw_real** gpiv_fftw_real_matrix	(	glong	nr,
		glong	nc
	)

Allocates a contiguous 2-dimensional fftw_real_matrix matrix of nr x nc

Parameters:

`[in]`	nr	number of rows
`[in]`	nc	number of columns

Returns:: matrix

void gpiv_free_bindata ( GpivBinData * bin_data )

Frees memory for GpivBinData

Parameters:

`[in]`	bin_data	data of bins
`[out]`	bin_data	NULL pointer to count, bound, centre

Returns:: void

void gpiv_free_double_matrix ( double ** m )

Frees a double matrix allocated by gpiv_double_matrix()

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_dvector ( double * vector )

Frees memory for a 1-dimensional vector of double data

Parameters:

[in] vector vector of 1-dimensional float data

Returns:: void

void gpiv_free_dvector_index	(	double *	vector,
		long	nl,
		long	nh
	)

Frees memory for a 1-dimensional vector of double data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	vector	vector of 1-dimensional float data
`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: void

void gpiv_free_fftw_complex_matrix ( fftw_complex ** m )

Frees a fftw_real matrix allocated by gpiv_fftw_complex_matrix()

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_fftw_real_matrix ( fftw_real ** m )

Frees a gdouble matrix allocated by gpiv_fftw_real_matrix_matrix()

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_gbolvector ( gboolean * vector )

Frees memory for a 1-dimensional vector of gboolean data

Parameters:

[in] vector vector of 1-dimensional boolean data

Returns:: void

void gpiv_free_imatrix ( int ** m )

Frees memory for 2-dimensional array of integer data unappreciated, use gpiv_free_imatrix_index instead

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_imatrix_index	(	int **	m,
		long	nrl,
		long	nrh,
		long	ncl,
		long	nch
	)

Frees memory for 2-dimensional array of integer data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	m	matrix
`[in]`	nrl	lowest row index number
`[in]`	nrh	highest row index number
`[in]`	ncl	lowest column index number
`[in]`	nch	highest column index number

Returns:: void

void gpiv_free_img	(	guint16 **	img,
		GpivImagePar	image_par
	)

Frees memory for image

Parameters:

`[in]`	image_par	image parameters
`[in]`	img	2-dim image data arry

RETURNS

Returns:: void

void gpiv_free_ivector ( int * vector )

Frees memory for a 1-dimensional vector of integer data

Parameters:

[in] vector vector of 1-dimensional float data

Returns:: void

void gpiv_free_ivector_index	(	int *	vector,
		long	nl,
		long	nh
	)

Frees memory for a 1-dimensional vector of integer data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	vector	vector of 1-dimensional float data
`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: void

void gpiv_free_matrix ( float ** m )

Frees memory for 2-dimensional array of float data

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_matrix_guint16 ( guint16 ** m )

Frees a guint16 matrix allocated by gpiv_matrix_guint16

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_matrix_guint8 ( guint8 ** m )

Frees a guint8 matrix allocated by gpiv_matrix_guint8

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_matrix_index	(	float **	m,
		long	nrl,
		long	nrh,
		long	ncl,
		long	nch
	)

Frees memory for 2-dimensional array of float data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	m	matrix
`[in]`	nrl	lowest row index number
`[in]`	nrh	highest row index number
`[in]`	ncl	lowest column index number
`[in]`	nch	highest column index number

Returns:: void

void gpiv_free_nulvector ( long * vector )

Frees memory for a 1-dimensional vector of long data

Parameters:

[in] vector vector of 1-dimensional float data

Returns:: void

void gpiv_free_nulvector_index	(	long *	vector,
		long	nl,
		long	nh
	)

Frees memory for a 1-dimensional vector of long data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	vector	vector of 1-dimensional float data
`[in]`	nl	lowest index number
`[in]`	nh	highest index number

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, peak_no

Returns:: void

void gpiv_free_scdata ( GpivScalarData * scal_data )

Frees memory for GpivScalarData

Parameters:

`[in]`	scal_data	scalar data structure
`[out]`	scal_data	NULL pointer to point_x, point_y, scalar, flag

Returns:: void

void gpiv_free_ucmatrix ( unsigned char ** m )

Frees memory for 2-dimensional array of guint16 data

Parameters:

[in] m matrix

Returns:: void

void gpiv_free_ulvector ( unsigned long * vector )

Frees memory for a 1-dimensional vector of unsigned long data

Parameters:

[in] vector vector of 1-dimensional float data

Returns:: void

void gpiv_free_ulvector_index	(	unsigned long *	vector,
		long	nl,
		long	nh
	)

Frees memory for a 1-dimensional vector of unsigned long data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	vector	vector of 1-dimensional float data
`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: void

void gpiv_free_vector ( float * vector )

Frees memory for a 1-dimensional vector of float data

Parameters:

[in] vector vector of 1-dimensional float data

Returns:: void

void gpiv_free_vector_index	(	float *	vector,
		long	nl,
		long	nh
	)

Frees memory for a 1-dimensional vector of float data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	vector	vector of 1-dimensional float data
`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: void

gboolean gpiv_fscan_cph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		char *	parameter,
		char	print_par,
		FILE *	fp,
		int	flag_par
	)

Scans line string on **char** parameter key and value or image header value (without program key). Prints result to file.

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	fp	file pointer to print parameter to file
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

gboolean gpiv_fscan_fph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		float *	parameter,
		char	print_par,
		FILE *	fp,
		int	flag_par
	)

Scans line string on **float** parameter/header key and value or image header value (without program key). Prints result to file.

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	fp	file pointer to print parameter to file or NULL
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

gboolean gpiv_fscan_iph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		int *	parameter,
		int	print_par,
		FILE *	fp,
		gboolean	flag_par
	)

Scans line string on **integer** parameter key and value or image header value (without program key). Prints result to file.

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	fp	file pointer to print parameter to file
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

gboolean gpiv_fscan_sph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		char	parameter[],
		char	print_par,
		FILE *	fp,
		int	flag_par
	)

Scans line string on **string** parameter key and value or image header value (without program key). Prints result to file.

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	fp	file pointer to print parameter to file
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

gboolean* gpiv_gbolvector ( glong nl )

Allocates memory for a 1-dimensional vector of gboolean data

Parameters:

[in] nl vector length

Returns:: vector

void gpiv_histo	(	GpivPivData *	data,
		GpivBinData *	klass
	)

Calculates histogram from GpivPivData (NOT from GpivScalarData!!)

Parameters:

`[in]`	data	Input data
`[out]`	klass	Output data

Returns:: void

char* gpiv_histo_gnuplot	(	char *	fname_out,
		char *	title,
		const char *	GNUPLOT_DISPLAY_COLOR,
		const int	GNUPLOT_DISPLAY_SIZE
	)

Plots histogram on screen with gnuplot

Parameters:

`[in]`	fname_out	output filename
`[in]`	title	plot title
`[in]`	GNUPLOT_DISPLAY_COLOR	display color of window containing graph
`[in]`	GNUPLOT_DISPLAY_SIZE	display size of window containing graph

Returns:: NULL on success or *err_msg on failure

int** gpiv_imatrix	(	long	nr,
		long	nc
	)

Allocates memory for 2-dimensional matrix of integer data depreciated, use gpiv_imatrix_index instead

Parameters:

`[in]`	nr	number of rows
`[in]`	nc	number of columns

Returns:: matrix

int** gpiv_imatrix_index	(	long	nrl,
		long	nrh,
		long	ncl,
		long	nch
	)

Allocates memory for 2-dimensional matrix of integer data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	nrl	lowest row index number
`[in]`	nrh	highest row index number
`[in]`	ncl	lowest column index number
`[in]`	nch	highest column index number

Returns:: matrix

int* gpiv_ivector ( long nl )

Allocates memory for a 1-dimensional vector of integer data

Parameters:

[in] nl vector length

Returns:: vector

int* gpiv_ivector_index	(	long	nl,
		long	nh
	)

Allocates memory for a 1-dimensional vector of integer data with subscript range v[nl..nh]

Parameters:

`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: vector

long gpiv_lmax	(	long	a,
		long	b
	)

Calculates maximum of longs a and b

Parameters:

`[in]`	a	first variable to be tested
`[in]`	b	second variable to be tested

Returns:: result of maximum

long gpiv_lmin	(	long	a,
		long	b
	)

Calculates minimum of longs a and b

Parameters:

`[in]`	a	first variable to be tested
`[in]`	b	second variable to be tested

Returns:: result of minimum

float** gpiv_matrix	(	long	nr,
		long	nc
	)

Allocates memory for 2-dimensional matrix of float data

Parameters:

`[in]`	nr	number of rows
`[in]`	nc	number of columns

Returns:: matrix

guint16** gpiv_matrix_guint16	(	long	nr,
		long	nc
	)

Allocates a guint16 matrix with subscript range m[0..nr][0..nc]

Parameters:

`[in]`	nr	number of rows
`[in]`	nc	number of columns

Returns:: matrix

guint8** gpiv_matrix_guint8	(	long	nr,
		long	nc
	)

Allocates a guint8 matrix with subscript range m[0..nr][0..nc]

Parameters:

`[in]`	nr	number of rows
`[in]`	nc	number of columns

Returns:: matrix

float** gpiv_matrix_index	(	long	nrl,
		long	nrh,
		long	ncl,
		long	nch
	)

Allocates memory for 2-dimensional matrix of float data with subscript range v[nrl..nrh][ncl..nch]

Parameters:

`[in]`	nrl	lowest row index number
`[in]`	nrh	highest row index number
`[in]`	ncl	lowest column index number
`[in]`	nch	highest column index number

Returns:: 2-dimensional array

int gpiv_max	(	int	a,
		int	b
	)

Calculates maximum of integers a and b

Parameters:

`[in]`	a	first variable to be tested
`[in]`	b	second variable to be tested

Returns:: result of maximum

int gpiv_min	(	int	a,
		int	b
	)

Calculates minimum of integers a and b

Parameters:

`[in]`	a	first variable to be tested
`[in]`	b	second variable to be tested

Returns:: result of minimum

void gpiv_null_bindata ( GpivBinData * bin_data )

Sets all elements of bin_data structure to NULL

Parameters:

`[in]`	bin_data	Input Bin data structure
`[out]`	bin_data	Output Bin data structure

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:: char * to NULL on success or *err_msg on failure

void gpiv_null_scdata ( GpivScalarData * scal_data )

Sets all elements of sc_data structure to NULL

Parameters:

`[in]`	scal_data	Input Scalar data structure
`[out]`	scal_data	Output Scalar data structure

Returns:: void

long* gpiv_nulvector ( long nl )

Allocates memory for a 1-dimensional vector of long data

Parameters:

[in] nl vector length

Returns:: vector

long* gpiv_nulvector_index	(	long	nl,
		long	nh
	)

Allocates memory for a 1-dimensional vector of long data with subscript range v[nl..nh]

Parameters:

`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: vector

char* gpiv_piv_gnuplot	(	char *	fname,
		char *	title,
		float	gnuplot_scale,
		const char *	GNUPLOT_DISPLAY_COLOR,
		const int	GNUPLOT_DISPLAY_SIZE,
		GpivImagePar	image_par,
		GpivEvalPar	piv_eval_par,
		GpivPivData	piv_data,
		const char *	RCSID
	)

Plots piv data as vectors on screen with gnuplot

Parameters:

`[in]`	fname	file name containing plot
`[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_eval_par	piv evaluation parameters
`[in]`	piv_data	piv data
`[in]`	RCSID	program name and version that interrogated the image

Returns:: NULL on success or *err_msg on failure

char* gpiv_scalar_gnuplot	(	char *	fname_out,
		char *	title,
		const char *	GNUPLOT_DISPLAY_COLOR,
		const int	GNUPLOT_DISPLAY_SIZE
	)

Graphical output with gnuplot for scalar data

Parameters:

`[in]`	fname_out	file name containing plot
`[in]`	title	title of plot
`[in]`	GNUPLOT_DISPLAY_COLOR	display color of window containing graph
`[in]`	GNUPLOT_DISPLAY_SIZE	display size of window containing graph

Returns:: NULL on success or *err_msg on failure

gboolean gpiv_scan_cph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		char *	parameter,
		char	print_par,
		int	flag_par
	)

Scans line string on **char** parameter key and value or image header value (without program key).

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	flag_par,:	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

Deprecated:: Redirects to gpiv_fscan_cph

gboolean gpiv_scan_fph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		float *	parameter,
		char	print_par,
		int	flag_par
	)

Scans line string on **float** parameter/header key and value or image header value (without program key). Prints result to file.

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

Deprecated:: Redirects to gpiv_fscan_fph

gboolean gpiv_scan_iph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		int *	parameter,
		gboolean	print_par,
		gboolean	flag_par
	)

Scans line string on **integer** parameter key and value or image header value (without program key).

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

Deprecated:: Redirects to gpiv_fscan_iph

gboolean gpiv_scan_iph_nl	(	FILE *	fp_h,
		const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		int *	parameter,
		gboolean	print_par,
		gboolean	flag_par
	)

Scans line string on **integer** parameter key and value or image header value (without program key). The value to be read is on the next line of the key.

Parameters:

`[in]`	fp_h	file pointer of header to read the data from
`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

void gpiv_scan_parameter	(	const char *	PAR_KEY,
		const char *	PARFILE,
		void *	pstruct,
		int	print_par
	)

Reads parameters from local parameter file PARFILE

Parameters:

`[in]`	PAR_KEY	Parameter key, specific for each process
`[in]`	PARFILE	Parameter file, specific for each process
`[in]`	print_par	flag for printing parameters
`[out]`	pstruct	pointer to parameter structure

Returns:: void

char* gpiv_scan_resourcefiles	(	const char *	PAR_KEY,
		void *	pstruct,
		int	print_par
	)

Opens resource files ~/GPIV_HOME_RSC_FILE (hidden) and SYSTEM_RSC_DIR/GPIV_SYSTEM_RSC_FILE Reads parameters from it

Parameters:

`[in]`	PAR_KEY	Parameter key, specific for each process
`[in]`	print_par	parameter to print to stdout
`[out]`	pstruct	pointer to parameter structure

Returns:: NULL on success or *err_msg on failure

gboolean gpiv_scan_sph	(	const char *	PROGNAME,
		char *	line,
		char *	par_name,
		char *	key,
		char	parameter[],
		char	print_par,
		int	flag_par
	)

Scans line string on **string** parameter key and value or image header value (without program key)

Parameters:

`[in]`	PROGNAME	Program name as part of parameter key
`[in]`	line	line to be scanned
`[in]`	par_name	parameter name which is scanned in line
`[in]`	key	parameter key
`[in]`	print_par	flag to print prarameter to stdout
`[in]`	flag_par	flag to use program key
`[out]`	parameter	parameter value to be returned

Returns:: flag representing parameter_logic. Set to FALSE if parameter has been read, else TRUE

char* gpiv_sort_3	(	unsigned long	n,
		float	arr[],
		float	arr_2[],
		float	arr_3[]
	)

Orders array arr AND its belonging arrays arr_2 and arr_3 Also swaps accompanying arrays

Parameters:

`[in]`	n	length of array
`[in]`	arr	array to be sorted
`[in]`	arr_2	second belonging array to arr
`[in]`	arr_3	third belonging array to arr

Returns:: NULL on success or *err_msg on failure

char* gpiv_sum_dxdy_pivdata	(	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, for example).

Parameters:

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

Returns:: char * to NULL on success or *err_msg on failure

unsigned char** gpiv_ucmatrix	(	long	nr,
		long	nc
	)

Allocates memory for 2-dimensional matrix of guint16 data

Parameters:

`[in]`	nr	lowest row index number
`[in]`	nc	lowest column index number

Returns:: matrix

unsigned long* gpiv_ulvector ( long nl )

Allocates memory for a 1-dimensional vector of unsigned long data

Parameters:

[in] nl vector length

Returns:: vector

unsigned long* gpiv_ulvector_index	(	long	nl,
		long	nh
	)

Allocates memory for a 1-dimensional vector of unsigned long data with subscript range v[nl..nh]

Parameters:

`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: vector

float* gpiv_vector ( long nl )

Allocates memory for a 1-dimensional vector of float data

Parameters:

[in] nl vector length

Returns:: vector

float* gpiv_vector_index	(	long	nl,
		long	nh
	)

Allocates memory for a 1-dimensional vector of float data with subscript range v[nl..nh]

Parameters:

`[in]`	nl	lowest index number
`[in]`	nh	highest index number

Returns:: vector

void gpiv_warning	(	char *	message,
			...
	)

Prints warning message with variable argumanent list

Parameters:

[in] message warning message

Returns:: void


Functions
void	gpiv_scan_parameter (const char PAR_KEY, const char PARFILE, void *pstruct, int print_par)
char *	gpiv_scan_resourcefiles (const char PAR_KEY, void pstruct, int print_par)
guint16 **	gpiv_alloc_img (GpivImagePar image_par)
void	gpiv_free_img (guint16 **img, GpivImagePar image_par)
void	gpiv_cp_img (guint16 img_src, guint16 img_dest, GpivImagePar image_par)
void	gpiv_null_pivdata (GpivPivData *piv_data)
void	gpiv_alloc_pivdata (GpivPivData *piv_data)
void	gpiv_free_pivdata (GpivPivData *piv_data)
char *	gpiv_0_pivdata (GpivPivData *piv_data)
char *	gpiv_cp_pivdata (GpivPivData piv_data_in, GpivPivData piv_data_out)
char *	gpiv_add_dxdy_pivdata (GpivPivData piv_data_in, GpivPivData piv_data_out)
char *	gpiv_sum_dxdy_pivdata (GpivPivData piv_data, gfloat *sum)
void	gpiv_null_scdata (GpivScalarData *scal_data)
void	gpiv_alloc_scdata (GpivScalarData *scal_data)
void	gpiv_free_scdata (GpivScalarData *scal_data)
void	gpiv_null_bindata (GpivBinData *bin_data)
void	gpiv_alloc_bindata (GpivBinData *bin_data)
void	gpiv_free_bindata (GpivBinData *bin_data)
float **	gpiv_matrix_index (long nrl, long nrh, long ncl, long nch)
void	gpiv_free_matrix_index (float **m, long nrl, long nrh, long ncl, long nch)
float **	gpiv_matrix (long nr, long nc)
void	gpiv_free_matrix (float **m)
unsigned char **	gpiv_ucmatrix (long nr, long nc)
void	gpiv_free_ucmatrix (unsigned char **m)
guint8 **	gpiv_matrix_guint8 (long nr, long nc)
void	gpiv_free_matrix_guint8 (guint8 **m)
guint16 **	gpiv_matrix_guint16 (long nr, long nc)
void	gpiv_free_matrix_guint16 (guint16 **m)
int **	gpiv_imatrix_index (long nrl, long nrh, long ncl, long nch)
void	gpiv_free_imatrix_index (int **m, long nrl, long nrh, long ncl, long nch)
int **	gpiv_imatrix (long nr, long nc)
void	gpiv_free_imatrix (int **m)
double **	gpiv_double_matrix (glong nr, glong nc)
void	gpiv_free_double_matrix (double **m)
fftw_real **	gpiv_fftw_real_matrix (glong nr, glong nc)
void	gpiv_free_fftw_real_matrix (fftw_real **m)
fftw_complex **	gpiv_fftw_complex_matrix (long nr, long nc)
void	gpiv_free_fftw_complex_matrix (fftw_complex **m)
float *	gpiv_vector (long nl)
void	gpiv_free_vector (float *vector)
float *	gpiv_vector_index (long nl, long nh)
void	gpiv_free_vector_index (float *vector, long nl, long nh)
gdouble *	gpiv_dvector (glong nl)
void	gpiv_free_dvector (double *vector)
double *	gpiv_dvector_index (long nl, long nh)
void	gpiv_free_dvector_index (double *vector, long nl, long nh)
long *	gpiv_nulvector (long nl)
void	gpiv_free_nulvector (long *vector)
long *	gpiv_nulvector_index (long nl, long nh)
void	gpiv_free_nulvector_index (long *vector, long nl, long nh)
unsigned long *	gpiv_ulvector (long nl)
void	gpiv_free_ulvector (unsigned long *vector)
unsigned long *	gpiv_ulvector_index (long nl, long nh)
void	gpiv_free_ulvector_index (unsigned long *vector, long nl, long nh)
int *	gpiv_ivector (long nl)
void	gpiv_free_ivector (int *vector)
int *	gpiv_ivector_index (long nl, long nh)
void	gpiv_free_ivector_index (int *vector, long nl, long nh)
gboolean *	gpiv_gbolvector (glong nl)
void	gpiv_free_gbolvector (gboolean *vector)
long	gpiv_lmax (long a, long b)
long	gpiv_lmin (long a, long b)
int	gpiv_max (int a, int b)
int	gpiv_min (int a, int b)
gboolean	gpiv_scan_iph (const char PROGNAME, char line, char par_name, char key, int *parameter, gboolean print_par, gboolean flag_par)
gboolean	gpiv_scan_iph_nl (FILE fp_h, const char PROGNAME, char line, char par_name, char key, int parameter, gboolean print_par, gboolean flag_par)
gboolean	gpiv_fscan_iph (const char PROGNAME, char line, char par_name, char key, int parameter, int print_par, FILE fp, gboolean flag_par)
gboolean	gpiv_scan_cph (const char PROGNAME, char line, char par_name, char key, char *parameter, char print_par, int flag_par)
gboolean	gpiv_fscan_cph (const char PROGNAME, char line, char par_name, char key, char parameter, char print_par, FILE fp, int flag_par)
gboolean	gpiv_scan_fph (const char PROGNAME, char line, char par_name, char key, float *parameter, char print_par, int flag_par)
gboolean	gpiv_fscan_fph (const char PROGNAME, char line, char par_name, char key, float parameter, char print_par, FILE fp, int flag_par)
gboolean	gpiv_scan_sph (const char PROGNAME, char line, char par_name, char key, char parameter[], char print_par, int flag_par)
gboolean	gpiv_fscan_sph (const char PROGNAME, char line, char par_name, char key, char parameter[], char print_par, FILE *fp, int flag_par)
char *	gpiv_sort_3 (unsigned long n, float arr[], float arr_2[], float arr_3[])
void	gpiv_histo (GpivPivData data, GpivBinData klass)
void	gpiv_cumhisto (GpivPivData data, GpivBinData klass)
char *	gpiv_histo_gnuplot (char fname_out, char title, const char *GNUPLOT_DISPLAY_COLOR, const int GNUPLOT_DISPLAY_SIZE)
char *	gpiv_piv_gnuplot (char fname, char title, float gnuplot_scale, const char GNUPLOT_DISPLAY_COLOR, const int GNUPLOT_DISPLAY_SIZE, GpivImagePar image_par, GpivEvalPar piv_eval_par, GpivPivData piv_data, const char RCSID)
char *	gpiv_scalar_gnuplot (char fname_out, char title, const char *GNUPLOT_DISPLAY_COLOR, const int GNUPLOT_DISPLAY_SIZE)
void	gpiv_warning (char *message,...)
void	gpiv_error (char *message,...)

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

Functions

Detailed Description

Function Documentation