Libpiv API documentation

 Search for 

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




-----------------------------------------------------------------------
LIBRARY:                libgpiv
SOURCE:                 post_par.c
EXTERNAL FUNCTIONS:
                        gpiv_post_parameters_set
                        gpiv_post_default_parameters
                        gpiv_post_get_parameters_from_resources

                        gpiv_post_read_parameters
                        gpiv_post_check_parameters_read
                        gpiv_post_fprint_parameters
                        gpiv_post_fread_hdf5_parameters
                        gpiv_post_fwrite_hdf5_parameters

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

#ifndef __LIBGPIV_POSTPAR_H__
#define __LIBGPIV_POSTPAR_H__

#define GPIV_POSTPAR_KEY                       "POST"        
enum GpivOperationManipiv {
    GPIV_FAST_Y = 0,           
    GPIV_FLIP_X = 1,           
    GPIV_FLIP_Y = 2,           
    GPIV_REVERT = 3,           
    GPIV_ROT90 = 4,            
    GPIV_ROT180 = 5,           
    GPIV_FILTER_BLOCK = 6,     
    GPIV_PASS_BLOCK = 7,       
    GPIV_ADD_XY = 8            
} OPERATOR_MANIPIV;



enum GpivDifferentiation {
    GPIV_CENTRAL = 0,          
    GPIV_LEAST_SQUARES = 1,    
    GPIV_RICHARDSON = 2,       
    GPIV_CIRCULATION = 3       
};



enum GpivOperation {
    GPIV_VORTICITY = 0,        
    GPIV_S_STRAIN = 1,         
    GPIV_N_STRAIN = 2          
};



enum GpivScaleType {
    GPIV_SCALE = 0,            
    GPIV_SCALE_INV = 1         
} GPIV_SCALE_TYPE;



typedef struct __GpivRoi GpivRoi;

struct __GpivRoi {
    float x_1;                  
    float y_1;                  
    float x_2;                  
    float y_2;                  
};


typedef struct __GpivPostPar GpivPostPar;

struct __GpivPostPar {
    enum GpivOperationManipiv operator_manipiv; 
    gboolean operator_manipiv__set;                
    gboolean set;              
    gboolean set__set;         
    float set_dx;              
    gboolean set_dx__set;      
    float set_dy;              
    gboolean set_dy__set;      
    GpivRoi *block;            
    gboolean block__set;

/*
 * Parameters for spatial average (s-avg)
 */
    int subtract;              
    gboolean subtract__set;    
    float z_off_dx;            
    gboolean z_off_dx__set;    
    float z_off_dy;            
    gboolean z_off_dy__set;    
/*
 * Parameters for vorticity and strain
 */
    enum GpivDifferentiation diff_type;  
    enum GpivOperation operator_vorstra; 
    int diff_type__set;             
    gboolean operator_vorstra__set; 
/*
 * Parameters for scaling PIV data. Other parameters for scaling are in 
 * __GpivImagePar.
 */
    enum GpivScaleType scale_type;   
    gboolean scale_type__set; 
};




void
gpiv_post_parameters_set                (GpivPostPar            *post_par,
                                        const gboolean          flag
                                        );



void
gpiv_post_default_parameters            (GpivPostPar            *post_par_default,
                                        const gboolean          force
                                        );



GpivPostPar *
gpiv_post_get_parameters_from_resources (const gchar            *localrc,
                                         const gboolean         verbose
                                         );


void 
gpiv_post_read_parameters               (FILE                   *fp_par, 
                                        GpivPostPar             *post_par,
                                        const gboolean          print_par
                                        );



gchar *
gpiv_post_check_parameters_read         (GpivPostPar            *post_par,
                                        const GpivPostPar       *post_par_default
                                        );



void 
gpiv_post_print_parameters              (FILE                   *fp_par_out,
                                        const GpivPostPar       *post_par
                                        );



GpivPostPar *
gpiv_post_fread_hdf5_parameters         (const gchar            *fname
                                        );



gchar *
gpiv_post_fwrite_hdf5_parameters        (const gchar            *fname, 
                                        const GpivPostPar       *post_par 
                                        );



#endif /* __LIBGPIV_POSTPAR_H_ */

---