Libpiv API documentation

 Search for 

gpiv-piv.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.  

-------------------------------------------------------------------------------
LIBRARY:                libgpiv

SOURCE:                 piv.c

EXTERNAL FUNCTIONS:
                        gpiv_piv_count_pivdata_fromimage
                        gpiv_piv_select_int_point
                        gpiv_piv_interrogate_img
                        gpiv_piv_interrogate_ia
                        gpiv_piv_isizadapt
                        gpiv_piv_write_deformed_image
                        gpiv_piv_weight_kernel_lin
                        gpiv_fread_fftw_wisdom
                        gpiv_fwrite_fftw_wisdom


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

#ifndef __LIBGPIV_PIV_H__
#define __LIBGPIV_PIVL_H__


#include <gpiv/gpiv-piv_par.h>
#include <gpiv/gpiv-valid_par.h>



#define GPIV_ZEROPAD_FACT 2     
#define GPIV_DIFF_ISI  0        
#define GPIV_CUM_RESIDU_MIN 0.25 
#define GPIV_MAX_PIV_SWEEP 10   
#define GPIV_SNR_DISABLE 88.0    
#define GPIV_DEFORMED_IMG_NAME "gpiv_defimg" 
#define GPIV_LOGFILE "gpiv.log"  
#define CMPR_FACT 2            
#define GPIV_SHIFT_FACTOR 3    
enum GpivIFit {
    GPIV_NONE = 0,     
    GPIV_GAUSS = 1,    
    GPIV_POWER = 2,    
    GPIV_GRAVITY = 3   
};



enum GpivIntGeo {
    GPIV_AOI = 0,      
    GPIV_LINE_C = 1,   
    GPIV_LINE_R = 2,   
    GPIV_POINT = 3     
};



typedef struct __GpivCovariance GpivCov;
struct __GpivCovariance {       
    float **z;                  
    float min;                  
    float max;                  
    long top_x;                 
    long top_y;                 
    float subtop_x;             
    float subtop_y;             
    float snr;                  
    int z_rnl;                  
    int z_rnh;                  
    int z_rpl;                  
    int z_rph;                  
    int z_cnl;                  
    int z_cnh;                  
    int z_cpl;                  
    int z_cph;                  
    int z_rl;                   
    int z_rh;                   
    int z_cl;                   
    int z_ch;                   
};



/*-----------------------------------------------------------------------------
 * Function prototypes
 */



gchar *
gpiv_piv_count_pivdata_fromimage        (const GpivImagePar     *image_par,
                                         const GpivPivPar       *piv_par,
                                         guint                  *nx,
                                         guint                  *ny
                                         );


GpivPivData *
gpiv_piv_interrogate_img                (const GpivImage        *image,
                                        const GpivPivPar        *piv_par,
                                        const GpivValidPar      *valid_par,
                                        const gboolean          verbose
                                        );
 

gchar *
gpiv_piv_interrogate_ia                 (const guint           index_y,
                                        const guint            index_x,
                                        const GpivImage        *image,
                                        const GpivPivPar       *piv_par,
                                        const guint            sweep,
                                        const guint            last_sweep,
                                        gfloat                 **int_area_1,
                                        gfloat                 **int_area_2,
                                        GpivCov                *cov,
                                        GpivPivData            *piv_data
                                        );



void
gpiv_piv_isizadapt                      (const GpivPivPar       *piv_par_src,
                                        GpivPivPar              *piv_par_dest,
                                        gboolean                *isiz_last
                                        );



gchar *
gpiv_piv_write_deformed_image           (GpivImage              *image
                                        );




void
gpiv_fread_fftw_wisdom                  (const gint             dir
                                        );



void 
gpiv_fwrite_fftw_wisdom                 (const gint             dir
                                        );


gchar *
gpiv_piv_dxdy_at_new_grid               (const GpivPivData      *piv_data_src,
                                        GpivPivData             *piv_data_dest
                                        );



gchar *
gpiv_piv_shift_grid                     (GpivPivData            *piv_data
                                        );



GpivPivData *
gpiv_piv_gridgen                        (const guint            nx,
                                        const guint             ny,
                                        const GpivImagePar      *image_par,
                                        const GpivPivPar        *piv_par
                                        );



GpivPivData *
gpiv_piv_gridadapt                      (const GpivImagePar     *image_par, 
                                        const GpivPivPar        *piv_par_src,
                                        GpivPivPar              *piv_par_dest,
                                        const GpivPivData       *piv_data,
                                        const guint             sweep, 
                                        gboolean                *grid_last
                                        );


#endif /* __LIBGPIV_PIV_H__ */

---