Libpiv API documentation

 Search for 

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



------------------------------------------------------------------------------
FILENAME:                piv_par.c
LIBRARY:                 libgpiv
EXTERNAL FUNCTIONS:      
                         gpiv_piv_parameters_set
                         gpiv_piv_default_parameters
                         gpiv_piv_get_parameters_from_resources

                         gpiv_piv_read_parameters
                         gpiv_piv_check_parameters_read
                         gpiv_piv_test_parameters
                         gpiv_piv_print_parameters
                         gpiv_piv_cp_parameters
                         gpiv_piv_cp_undef_parameters
                         gpiv_piv_fread_hdf5_parameters
                         gpiv_piv_fwrite_hdf5_parameters

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

#ifndef __LIBGPIV_PIVPAR_H__
#define __LIBGPIV_PIVPAR_H__

/*-----------------------------------------------------------------------------
 * Parameters for Piv evaluation
 */

#define GPIV_PIVPAR_KEY                      "PIV"           
enum GpivIntScheme {
    GPIV_NO_CORR,
    GPIV_LK_WEIGHT,              
    GPIV_ZERO_OFF_FORWARD,       
    GPIV_ZERO_OFF_CENTRAL,       
    GPIV_IMG_DEFORM              
};


typedef struct __GpivPivPar GpivPivPar;

struct __GpivPivPar {
    guint col_start;                    
    gboolean col_start__set;            
    guint col_end;                      
    gboolean col_end__set;              
    guint ifit;                         
    gboolean ifit__set;                 
    guint int_geo;                      
    gboolean int_geo__set;              
    guint int_line_col;                 
    gboolean int_line_col__set;         
    guint int_line_col_start;           
    gboolean int_line_col_start__set;   
    guint int_line_col_end;             
    gboolean int_line_col_end__set;     
    guint int_line_row;                 
    gboolean int_line_row__set;         
    guint int_line_row_start;           
    gboolean int_line_row_start__set;   
    guint int_line_row_end;             
    gboolean int_line_row_end__set;     
    guint int_point_col;                
    gboolean int_point_col__set;        
    guint int_point_row;                
    gboolean int_point_row__set;        
/*     gboolean int_size;  */               
    guint int_size_1;                   
    gboolean int_size_1__set;           
    guint int_size_2;                   
    gboolean int_size_2__set;           
    gint int_shift;                     
    gboolean int_shift__set;            
    int int_deform;                     
    gboolean int_deform__set;           
    gint peak;                          
    gboolean peak__set;                 
    int pre_shift_col;                  
    gboolean pre_shift_col__set;        
    int pre_shift_row;                  
    gboolean pre_shift_row__set;        
    int print_par;                      
    gboolean print_par__set;            
    int print_piv;                      
    gboolean print_piv__set;            
    guint row_start;                    
    gboolean row_start__set;            
    guint row_end;                      
    gboolean row_end__set;              
    int spline_degree;                  
    gboolean spline_degree__set;        
    enum GpivIntScheme int_scheme;      
    gboolean int_scheme__set;           
    gboolean gauss_weight_ia;           
    gboolean gauss_weight_ia__set;      
    gboolean spof_filter;               
    gboolean spof_filter__set;          
};


/*
 * Function prototypes
 */

void
gpiv_piv_default_parameters             (GpivPivPar             *piv_par_default,
                                        const gboolean          force
                                        );



GpivPivPar *
gpiv_piv_get_parameters_from_resources  (const gchar            *localrc,
                                         const gboolean         verbose
                                         );



void
gpiv_piv_parameters_set                 (GpivPivPar             *piv_par,
                                        const gboolean          flag
                                        );



void 
gpiv_piv_read_parameters                (FILE                   *fp, 
                                        GpivPivPar              *piv_par,
                                        const gboolean          verbose
                                        );



gchar *
gpiv_piv_check_parameters_read          (GpivPivPar             *piv_par,
                                        const GpivPivPar        *piv_par_default
                                        );



gchar *
gpiv_piv_testonly_parameters            (const GpivImagePar     *image_par, 
                                        const GpivPivPar        *piv_par
                                        );



gchar *
gpiv_piv_testadjust_parameters          (const GpivImagePar     *image_par, 
                                        GpivPivPar              *piv_par
                                        );



void 
gpiv_piv_print_parameters               (FILE                   *fp,
                                        const GpivPivPar        *piv_par
                                        );

GpivPivPar *
gpiv_piv_cp_parameters                  (const GpivPivPar       *piv_par
                                        );


void
gpiv_piv_cp_undef_parameters            (const GpivPivPar       *piv_par_src, 
                                        GpivPivPar              *piv_par_dest
                                        );


GpivPivPar *
gpiv_piv_fread_hdf5_parameters          (const gchar            *fname
                                        );


gchar *
gpiv_piv_fwrite_hdf5_parameters         (const gchar            *fname,
                                         const GpivPivPar       *piv_par 
                                         );



#endif /* __LIBGPIV_PIVPAR_H__ */

---