Libpiv API documentation

 Search for 

gpiv.h

Go to the documentation of this file.

/* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */

/*-----------------------------------------------------------------------------

   libgpiv - library for Particle Image Velocimetry

   Copyright (C) 2002, 2003, 2004 Gerber van der Graaf

   This file is part of libgpiv.

   Libgpiv is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  

-----------------------------------------------------------------------------*/

#ifndef __LIBGPIV_H__
#define __LIBGPIV_H__

/*
 * Includes external library headers to be used in Libgpiv
 */
#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>

#ifdef ENABLE_CAM
#include <libraw1394/raw1394.h>
#include <libdc1394/dc1394_control.h>
#endif /* ENABLE_CAM */

#ifdef ENABLE_TRIG
#include <rtai.h>
#include <fcntl.h>
#endif /* ENABLE_TRIG */


/*
 * General macro definitions
 */

#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                  
#ifndef SYSTEM_RSC_DIR
#define SYSTEM_RSC_DIR "/etc"   
#endif  /* SYSTEM_RSC_DIR */


/*
 * Data structure declarations
 */

typedef struct __GpivPivData GpivPivData;
struct __GpivPivData {
    guint nx;                   
    guint ny;                   
    guint nz;                   
    gfloat **point_x;           
    gfloat **point_y;           
    gfloat **point_z;           
    gfloat **dx;                
    gfloat **dy;                
    gfloat **dz;                
    gfloat **snr;               
    gint **peak_no;             
    gfloat **scalar;            
    guint count;                
    gfloat mean_dx;             
    gfloat sdev_dx;             
    gfloat min_dx;              
    gfloat max_dx;              
    gfloat mean_dy;             
    gfloat sdev_dy;             
    gfloat min_dy;              
    gfloat max_dy;              
    gfloat mean_dz;             
    gfloat sdev_dz;             
    gfloat min_dz;              
    gfloat max_dz;              
    gboolean scale;             
    gboolean scale__set;        
    gchar *comment;             
};


typedef struct __GpivScalarData GpivScalarData;
struct __GpivScalarData {
    guint nx;                   
    guint ny;                   
    gfloat **point_x;           
    gfloat **point_y;           
    gfloat **scalar;            
    gint **flag;                
    gboolean scale;             
    gboolean scale__set;        
    gchar *comment;             
};


typedef struct __GpivBinData GpivBinData;

struct __GpivBinData {
    guint nbins;                
    guint *count;               
    gfloat *bound;              
    gfloat *centre;             
    gfloat min;                 
    gfloat max;                 
    gchar *comment;             
};


/*
 * Includes Libgpiv library headers
 */

#ifdef ENABLE_CAM
#include <gpiv/gpiv-cam.h>
#endif /* ENABLE_CAM */

#ifdef ENABLE_TRIG
#include <gpiv/gpiv-trig.h>
#endif /* ENABLE_TRIG */

#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>


#ifdef GPIV_ENABLE_DEPRECATED
#include <gpiv/back_intface.h>
#endif


#endif /* __LIBGPIV_H__ */

---