Libpiv API documentation

 Search for 

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

main header of libgpiv More...

#include <stdlib.h>
#include <stdio.h>
#include <math.h>
#include <gsl/gsl_fit.h>
#include <assert.h>
#include <time.h>
#include <fftw.h>
#include <rfftw.h>
#include <hdf5.h>
#include <glib.h>
#include <png.h>
#include <gpiv/img.h>
#include <gpiv/imgproc.h>
#include <gpiv/eval.h>
#include <gpiv/eval_speed.h>
#include <gpiv/valid.h>
#include <gpiv/post.h>
#include <gpiv/io.h>
#include <gpiv/utils.h>

Data Structures
struct	__GpivPivData
struct	__GpivScalarData
struct	__GpivBinData
Defines
#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"

---

Detailed Description

main header of libgpiv

FILENAME: gpiv.h

LAST MODIFICATION DATE:

Id

gpiv.h,v 1.22 2007-02-16 17:08:15 gerber Exp

---

Define Documentation

#define GPIV_HOME_RSC_FILE   ".gpivrc"

home parameter resources file

#define GPIV_MAX_CHARS   80

Maximum number of characters on a line

#define GPIV_MAX_IMG_DEPTH   16

Maximum image depth (in bits)

#define GPIV_MAX_IMG_SIZE   2000

Maximum size of image

#define GPIV_MAX_INTERR_SIZE   128

Maximum size of interrogation area

#define GPIV_MAX_LINES   6400

Maximum number of lines in a datafile

#define GPIV_MAX_LINES_C   20

Maximum number of comment lines in a datafile

#define GPIV_MIN_INTERR_SIZE   4

Minimum size of interrogation area

#define GPIV_NBINS_DEFAULT   10

Default number of nbins

#define GPIV_NBINS_MAX   100

maximum bins for histogram

#define GPIV_NIMG_MAX   40

maximum number of images to be retrieved

#define GPIV_SNR_NAN   99.0

snr value for disabled estimator (tested on isnan)

#define GPIV_SYSTEM_RSC_FILE   "gpiv.conf"

System wide parameter resources file

#define IA_GAUSS_WEIGHTING

Gaus filtering of interrogation area

#define LIBNAME   "LIBGPIV"

Library name

#define SPOF_FILTERING

Symmetric Phase Only filtering

#define SYSTEM_RSC_DIR   "/etc"

System wide resource directory

---