include/gpiv/gpiv-img.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, 2005, 2006, 2007, 2008 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:
EXTERNAL FUNCTIONS:
                         gpiv_img_parameters_set
                         gpiv_img_get_parameters

                         gpiv_img_read_header
             gpiv_img_check_header_read
             gpiv_img_check_header_required_read
             gpiv_img_check_header_scale_read
             gpiv_img_test_header
             gpiv_img_print_header
             gpiv_img_fprint_header
             gpiv_img_print_parameters
             gpiv_img_fprint_parameters
                         gpiv_img_cp_parameters
                         gpiv_img_ovwrt_parameters
             gpiv_img_fread_hdf5_parameters
             gpiv_img_fwrite_hdf5_parameters
                         gpiv_img_fread_davis_parameters
             
-----------------------------------------------------------------------------*/

#ifndef __LIBGPIV_IMG_H__
#define __LIBGPIV_IMG_H__



#define GPIV_IMGPAR_DEFAULT__DEPTH     8    
#define GPIV_IMGPAR_DEFAULT__NCOLUMNS  256  
#define GPIV_IMGPAR_DEFAULT__NROWS     256  
#define GPIV_IMGPAR_DEFAULT__X_CORR    1    
#define GPIV_IMGPAR_DEFAULT__S_SCALE   1.0  
#define GPIV_IMGPAR_DEFAULT__T_SCALE   1.0  
#define GPIV_IMGPAR_DEFAULT__Z_OFF_X   0.0  
#define GPIV_IMGPAR_DEFAULT__Z_OFF_Y   0.0  
#define GPIV_IMGPAR_DEFAULT__TITLE     ""   
#define GPIV_IMGPAR_DEFAULT__CREATION_DATE ""   
#define GPIV_IMGPAR_DEFAULT__LOCATION  ""   
#define GPIV_IMGPAR_DEFAULT__AUTHOR    ""   
#define GPIV_IMGPAR_DEFAULT__SOFTWARE  "gpiv / gpiv_rr"      
#define GPIV_IMGPAR_DEFAULT__SOURCE    ""   
#define GPIV_IMGPAR_DEFAULT__USERTEXT  ""   
#define GPIV_IMGPAR_DEFAULT__WARNING   ""   
#define GPIV_IMGPAR_DEFAULT__DISCLAIMER "See The GNU General Public License (GPL)"      
#define GPIV_IMGPAR_DEFAULT__COMMENT   ""   
#define GPIV_IMGPAR_DEFAULT__COPYRIGHT ""   
#define GPIV_IMGPAR_DEFAULT__EMAIL     ""   
#define GPIV_IMGPAR_DEFAULT__URL       ""   
#define GPIV_IMGPAR_KEY                "IMG"        
#define GPIV_IMGPAR_KEY__DEPTH         "depth"          
#define GPIV_IMGPAR_KEY__NCOLUMNS      "ncolumns"       
#define GPIV_IMGPAR_KEY__NROWS         "nrows"          
#define GPIV_IMGPAR_KEY__X_CORR        "x_corr"         
#define GPIV_IMGPAR_KEY__S_SCALE       "s_scale"        
#define GPIV_IMGPAR_KEY__T_SCALE       "t_scale"        
#define GPIV_IMGPAR_KEY__Z_OFF_X       "zoff_x"         
#define GPIV_IMGPAR_KEY__Z_OFF_Y       "zoff_y"         
#define GPIV_IMGPAR_KEY__TITLE         "title"          
#define GPIV_IMGPAR_KEY__CREATION_DATE "creation_date"  
#define GPIV_IMGPAR_KEY__LOCATION      "location"       
#define GPIV_IMGPAR_KEY__AUTHOR        "author"         
#define GPIV_IMGPAR_KEY__SOFTWARE      "software"       
#define GPIV_IMGPAR_KEY__SOURCE        "source"         
#define GPIV_IMGPAR_KEY__USERTEXT      "usertext"       
#define GPIV_IMGPAR_KEY__WARNING       "warning"        
#define GPIV_IMGPAR_KEY__DISCLAIMER    "disclaimer"     
#define GPIV_IMGPAR_KEY__COMMENT       "comment"        
#define GPIV_IMGPAR_KEY__COPYRIGHT     "copyright"      
#define GPIV_IMGPAR_KEY__EMAIL         "email"          
#define GPIV_IMGPAR_KEY__URL           "url"            
typedef struct __GpivImagePar GpivImagePar;

struct __GpivImagePar {
    guint depth;                        
    gboolean depth__set;                
    guint ncolumns;                     
    gboolean ncolumns__set;             
    guint nrows;                        
    gboolean nrows__set;                
    gboolean x_corr;                    
    gboolean x_corr__set;               
    gfloat s_scale;                     
    gboolean s_scale__set;              
    gfloat t_scale;                     
    gboolean t_scale__set;              
    gfloat z_off_x;                     
    gboolean z_off_x__set;              
    gfloat z_off_y;                     
    gboolean z_off_y__set;              
    gchar title[GPIV_MAX_CHARS];        
    gboolean title__set;                
    gchar creation_date[GPIV_MAX_CHARS];
    gboolean creation_date__set;        
    gchar location[GPIV_MAX_CHARS];     
    gboolean location__set;             
    gchar author[GPIV_MAX_CHARS];       
    gboolean author__set;               
    gchar software[GPIV_MAX_CHARS];     
    gboolean software__set;             
    gchar source[GPIV_MAX_CHARS];       
    gboolean source__set;               
    gchar usertext[GPIV_MAX_CHARS];     
    gboolean usertext__set;             
    gchar warning[GPIV_MAX_CHARS];      
    gboolean warning__set;              
    gchar disclaimer[GPIV_MAX_CHARS];   
    gboolean disclaimer__set;           
    gchar comment[GPIV_MAX_CHARS];      
    gboolean comment__set;              
    gchar copyright[GPIV_MAX_CHARS];    
    gboolean copyright__set;            
    gchar email[GPIV_MAX_CHARS];        
    gboolean email__set;                
    gchar url[GPIV_MAX_CHARS];          
    gboolean url__set;                  
};


typedef struct __GpivImage GpivImage;
struct __GpivImage {
    GpivImagePar *header;              
    guint16 **frame1;                  
    guint16 **frame2;                  
};


/*
 * Function prototypes
 */

void
gpiv_img_parameters_set (GpivImagePar   *image_par,
                         const gboolean flag
                         );



GpivImagePar *
gpiv_img_get_parameters_from_resources  (const gchar        *localrc,
                                         const gboolean     verbose
                                         );


void
gpiv_img_default_parameters     (GpivImagePar       *image_par,
                    const gboolean      force
                    );



void
gpiv_img_read_header            (FILE           *fp,
                    GpivImagePar        *image_par,
                    const gboolean      include_key,
                    const gboolean      verbose,
                    FILE            *fp_par_out
                    );



gchar *
gpiv_img_check_header_read      (const GpivImagePar     *image_par
                    );



gchar *
gpiv_img_check_header_required_read     (const GpivImagePar     *image_par
                    );



gchar *
gpiv_img_check_header_scale_read        (const GpivImagePar     *image_par
                    );


gchar *
gpiv_img_test_header            (const GpivImagePar *image_par
                    );


void 
gpiv_img_print_header           (FILE           *fp,
                    const GpivImagePar  *image_par
                    );


void 
gpiv_img_fprint_header          (const gchar        *fname,
                    const GpivImagePar  *image_par
                    );


GpivImagePar *
gpiv_img_cp_parameters          (const GpivImagePar *image_par
                    );


void
gpiv_img_ovwrt_parameters       (const GpivImagePar *image_par_src,
                    GpivImagePar        *image_par_dest
                    );


void
gpiv_img_print_parameters       (FILE                   *fp, 
                    const GpivImagePar  *image_par
                    );


void 
gpiv_img_fprint_parameters      (const gchar            *fname,
                    const GpivImagePar  *image_par
                    );


GpivImagePar *
gpiv_img_fread_hdf5_parameters      (const gchar        *fname
                    );


gchar *
gpiv_img_fwrite_hdf5_parameters     (const gchar            *fname,
                    const GpivImagePar  *image_par
                    );



gchar *
gpiv_img_fread_davis_parameters     (const gchar        *fname,
                    GpivImagePar        *image_par
                    );

#ifdef ENABLE_MPI

void
gpiv_img_mpi_bcast_imgpar       (GpivImagePar       *image_par
                    );

#endif /* ENABLE_MPI */
#endif /* __LIBGPIV_IMG_H__ */