Libpiv API documentation

 Search for 

gpiv.h File Reference

main header of libgpiv More...

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <math.h>
#include <gsl/gsl_fit.h>
#include <assert.h>
#include <time.h>
#include <fftw3.h>
#include <hdf5.h>
#include <glib-2.0/glib.h>
#include <png.h>
#include <gpiv/gpiv-img.h>
#include <gpiv/gpiv-img_utils.h>
#include <gpiv/gpiv-imgproc.h>
#include <gpiv/gpiv-piv.h>
#include <gpiv/gpiv-piv_par.h>
#include <gpiv/gpiv-piv_utils.h>
#include <gpiv/gpiv-valid.h>
#include <gpiv/gpiv-valid_par.h>
#include <gpiv/gpiv-post.h>
#include <gpiv/gpiv-post_par.h>
#include <gpiv/gpiv-post_utils.h>
#include <gpiv/gpiv-io.h>
#include <gpiv/gpiv-utils.h>
#include <gpiv/gpiv-utils_alloc.h>

Go to the source code of this file.

Data Structures
struct	__GpivPivData
	Holds the variables of PIV data. More...
struct	__GpivScalarData
	Holds scalar data, mostly derived from __GpivPivData. More...
struct	__GpivBinData
	Used for making up histograms in bins or klasses. More...
Defines
#define	USE_FFTW3
#define	LIBNAME   "LIBGPIV"
#define	GPIV_SYSTEM_RSC_FILE   "gpiv.conf"
#define	GPIV_HOME_RSC_FILE   ".gpivrc"
#define	GPIV_NIMG_MAX   40
#define	GPIV_MAX_CHARS   80
#define	GPIV_MAX_LINES   6400
#define	GPIV_MAX_LINES_C   20
#define	GPIV_MAX_IMG_SIZE   2000
#define	GPIV_MAX_IMG_DEPTH   16
#define	GPIV_MIN_INTERR_SIZE   4
#define	GPIV_MAX_INTERR_SIZE   128
#define	GPIV_NBINS_MAX   100
#define	GPIV_NBINS_DEFAULT   10
#define	GPIV_SNR_NAN   99.0
#define	IA_GAUSS_WEIGHTING
#define	SPOF_FILTERING
#define	SYSTEM_RSC_DIR   "/etc"
Typedefs
typedef __GpivPivData	GpivPivData
typedef __GpivScalarData	GpivScalarData
typedef __GpivBinData	GpivBinData

---

Detailed Description

main header of libgpiv

FILENAME: gpiv.h

LAST MODIFICATION DATE:

Id

gpiv.h,v 1.23 2007-06-06 16:59:02 gerber Exp

Definition in file gpiv.h.

---

Define Documentation

#define GPIV_HOME_RSC_FILE   ".gpivrc"

home parameter resources file

Definition at line 214 of file gpiv.h.

#define GPIV_MAX_CHARS   80

Maximum number of characters on a line

Definition at line 216 of file gpiv.h.

#define GPIV_MAX_IMG_DEPTH   16

Maximum image depth (in bits)

Definition at line 220 of file gpiv.h.

#define GPIV_MAX_IMG_SIZE   2000

Maximum size of image

Definition at line 219 of file gpiv.h.

#define GPIV_MAX_INTERR_SIZE   128

Maximum size of interrogation area

Definition at line 222 of file gpiv.h.

#define GPIV_MAX_LINES   6400

Maximum number of lines in a datafile

Definition at line 217 of file gpiv.h.

#define GPIV_MAX_LINES_C   20

Maximum number of comment lines in a datafile

Definition at line 218 of file gpiv.h.

#define GPIV_MIN_INTERR_SIZE   4

Minimum size of interrogation area

Definition at line 221 of file gpiv.h.

#define GPIV_NBINS_DEFAULT   10

Default number of nbins

Definition at line 224 of file gpiv.h.

#define GPIV_NBINS_MAX   100

maximum bins for histogram

Definition at line 223 of file gpiv.h.

#define GPIV_NIMG_MAX   40

maximum number of images to be retrieved

Definition at line 215 of file gpiv.h.

#define GPIV_SNR_NAN   99.0

snr value for disabled estimator (tested on isnan)

Definition at line 225 of file gpiv.h.

#define GPIV_SYSTEM_RSC_FILE   "gpiv.conf"

System wide parameter resources file

Definition at line 213 of file gpiv.h.

#define IA_GAUSS_WEIGHTING

Gaus filtering of interrogation area

Definition at line 227 of file gpiv.h.

#define LIBNAME   "LIBGPIV"

Library name

Definition at line 212 of file gpiv.h.

#define SPOF_FILTERING

Symmetric Phase Only filtering

Definition at line 228 of file gpiv.h.

#define SYSTEM_RSC_DIR   "/etc"

System wide resource directory

Definition at line 232 of file gpiv.h.

#define USE_FFTW3

Definition at line 210 of file gpiv.h.

---

Typedef Documentation

typedef struct __GpivBinData GpivBinData

Definition at line 322 of file gpiv.h.

typedef struct __GpivPivData GpivPivData

Definition at line 240 of file gpiv.h.

typedef struct __GpivScalarData GpivScalarData

Definition at line 298 of file gpiv.h.

---