Libpiv API documentation

 Search for 

gpiv-io.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:                io.c
LIBRARY:                 libgpiv:
EXTERNAL FUNCTIONS:      gpiv_io_make_fname
                         gpiv_read_header

                         gpiv_fread_image
                         gpiv_read_image
                         gpiv_write_image

                         gpiv_find_pivdata_origin
                         gpiv_read_pivdata
                         gpiv_read_pivdata_fastx
                         gpiv_write_pivdata
                         gpiv_fread_scdata
                         gpiv_write_scdata

                         gpiv_fwrite_griddata
                         gpiv_print_histo
                         gpiv_print_cumhisto_eqdatbin
                         gpiv_fprint_cumhisto_eqdatbin

                         gpiv_fread_raw_image
                         gpiv_read_raw_image
                         gpiv_fwrite_raw_image
                         gpiv_write_raw_image

                         gpiv_read_png_image
                         gpiv_write_png_image

                         gpiv_fcreate_hdf5
                         gpiv_fread_hdf5_image
                         gpiv_fwrite_hdf5_image
                         gpiv_fread_hdf5_parameters
                         gpiv_fwrite_hdf5_parameters
                         gpiv_fread_hdf5_position
                         gpiv_fwrite_hdf5_position
                         gpiv_fwrite_hdf5_piv_position
                         gpiv_fread_hdf5_pivdata
                         gpiv_fwrite_hdf5_pivdata
                         gpiv_fread_hdf5_scdata
                         gpiv_fwrite_hdf5_scdata
                         gpiv_fread_hdf5_histo
                         gpiv_fwrite_hdf5_histo

                         gpiv_fread_davis_image
                         gpiv_read_davis_image

LAST MODIFICATION DATE:  $Id: io.h,v 1.17 2007-06-06 16:59:02 gerber Exp $
 --------------------------------------------------------------- */

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

#ifndef __LIBGPIV_IO_H__
#define __LIBGPIV_IO_H__



#define GPIV_PIV_FMT "%4.0f %4.0f %12.3f %12.3f %12.3f %2d\n"   
#define GPIV_PIV_S_FMT "%-12.5f %-12.5f %-12.5f  %-12.5f  %-6.2f     %-2d\n"    
#define GPIV_SCALAR_FMT "%4.0f %4.0f %12.3f     %2d\n"          
#define GPIV_SCALAR_S_FMT "%-12.3f %-12.3f %-12.3f     %-2d\n"  
#define GPIV_EXT_HEADER        ".h"            
#define GPIV_EXT_RAW_IMAGE     ".r"            
#define GPIV_EXT_PNG_IMAGE     ".png"          
#define GPIV_EXT_PNG_IMAGE_UPCASE ".PNG"       
#define GPIV_EXT_PNG_IMAGE_PROC "_proc.png"    
#define GPIV_EXT_PGM_IMAGE     ".pgm"          
#define GPIV_EXT_PGM_IMAGE_UPCASE ".PGM"       
#define GPIV_EXT_RAW_IMAGE_PROC "_proc.r"      
#define GPIV_EXT_PAR           ".par"          
#define GPIV_EXT_TA            ".ta"           
#define GPIV_EXT_SUBSTR        ".substr"       
#define GPIV_EXT_GPIV          ".gpi"          
#define GPIV_EXT_GPIV_UPCASE   ".GPI"          
#define GPIV_EXT_PIV           ".piv"          
#define GPIV_EXT_DAVIS         ".img"          
#define GPIV_EXT_DAVIS_UPCASE  ".IMG"          
#define GPIV_EXT_COV           ".cov"          
#define GPIV_EXT_INT           ".int"          
#define GPIV_EXT_OLD           ".old.piv"      
#define GPIV_EXT_ERR_PIV       ".err.piv"      
#define GPIV_EXT_ERR_STAT      ".stat"         
#define GPIV_EXT_PLK           ".plk"          
#define GPIV_EXT_UVHISTO       ".pdf"          
#define GPIV_EXT_VOR           ".vor"          
#define GPIV_EXT_NSTR          ".nstr"         
#define GPIV_EXT_SSTR          ".sstr"         
#define GPIV_EXT_MANI          ".ma.piv"               
#define GPIV_EXT_SA            ".sa.piv"       
#define GPIV_EXT_SC            ".sc.piv"       
/* #define HD5_IMAGE_INT */                          /* Use integer for image data in HDF5 format */
#define GPIV_DAVIS_IMG_DEPTH   12              
#define GPIV_IMG_PARAM_RESOURCES 
enum GpivDataFormat { 
    GPIV_RR = 1, 
    GPIV_DAV = 2 
} pdf;



void 
gpiv_io_make_fname                      (const gchar            *fname_base,
                                        const gchar             *EXT,
                                        gchar                   *fname_out
                                        );


GpivImage *
gpiv_read_image                         (FILE                   *fp
                                        );



GpivImage *
gpiv_fread_image                        (const gchar            *fname
                                        );



enum GpivDataFormat
gpiv_find_pivdata_origin                (const gchar            line[GPIV_MAX_CHARS]
                                        );      



GpivPivData *
gpiv_fread_pivdata                      (const gchar            *fname
                                        );



gchar *
gpiv_fwrite_pivdata                     (const gchar            *fname,
                                        GpivPivData             *piv_data,
                                        const gboolean          free
                                        );



GpivPivData *
gpiv_read_pivdata                       (FILE                   *fp
                                        );



GpivPivData *
gpiv_read_pivdata_fastx                 (FILE                   *fp
                                        );



gchar *
gpiv_write_pivdata                      (FILE                   *fp,
                                        GpivPivData             *piv_data,
                                        const gboolean          free
                                        );



GpivScalarData *
gpiv_fread_scdata                       (const gchar            *fname
                                        );



gchar *
gpiv_fwrite_scdata                      (const gchar            *fname,
                                        GpivScalarData          *scalar_data,
                                        const gboolean          free
                                        );



GpivScalarData *
gpiv_read_scdata                        (FILE                   *fp
                                        );



gchar *
gpiv_write_scdata                       (FILE                   *fp,
                                        GpivScalarData          *scalar_data,
                                        const gboolean          free
                                        );



gchar *
gpiv_write_sc_griddata                  (FILE                   *fp,
                                        GpivScalarData          *scalar_data,
                                        const gboolean          free
                                        );



gchar *
gpiv_write_sc_mtvgriddata               (FILE                   *fp, 
                                        GpivScalarData          *scalar_data, 
                                        const gboolean          free
                                        );


gchar *
gpiv_print_histo                        (FILE                   *fp, 
                                        GpivBinData             *bin_data, 
                                        const gboolean          free
                                        );


gchar *
gpiv_print_cumhisto_eqdatbin            (FILE                   *fp,
                                        GpivBinData             *klass,
                                        const gboolean          free
                                        );


GpivImage *
gpiv_read_raw_image                     (FILE                   *fp
                                        );


GpivImage *
gpiv_fread_raw_image                    (const gchar            *fname
                                        );


gchar *
gpiv_write_raw_image                    (FILE                   *fp,
                                        GpivImage               *gpiv_image
                                        );


gchar *
gpiv_fwrite_raw_image                   (const gchar            *fname,
                                        GpivImage               *gpiv_image
                                        );


GpivImage *
gpiv_read_png_image                     (FILE                   *fp
                                        );


gchar *
gpiv_write_png_image                    (FILE                   *fp,
                                        GpivImage               *gpiv_image,
                                        const gboolean          free
                                        );


gchar *
gpiv_fcreate_hdf5                       (const gchar            *fname
                                        );


gchar *
gpiv_fread_hdf5_parameters              (const gchar            *fname,
                                        const gchar             *par_key,
                                        void                    *pstruct
                                        );


GpivImage *
gpiv_fread_hdf5_image                   (const gchar            *fname
                                        );


gchar *
gpiv_fwrite_hdf5_image                  (const gchar            *fname, 
                                        GpivImage               *image,
                                        const gboolean          free
                                        );


gchar *
gpiv_fwrite_hdf5_parameters             (const gchar            *fname,
                                        const gchar             *par_key,
                                        void                    *pstruct
                                        );


GpivPivData *
gpiv_fread_hdf5_pivdata                 (const gchar            *fname,
                                        const gchar             *DATA_KEY
                                        );


gchar *
gpiv_fwrite_hdf5_pivdata                (const gchar            *fname, 
                                        GpivPivData             *piv_data, 
                                        const gchar             *DATA_KEY,
                                        const gboolean          free
                                        );


GpivScalarData *
gpiv_fread_hdf5_scdata                  (const gchar            *fname,
                                        const gchar             *DATA_KEY
                                        );


gchar *
gpiv_fwrite_hdf5_scdata                 (const gchar            *fname, 
                                        GpivScalarData          *scalar_data, 
                                        const gchar             *DATA_KEY,
                                        const gboolean          free
                                        );


gchar *
gpiv_fread_hdf5_histo                   (const gchar            *fname, 
                                        GpivBinData             *klass, 
                                        const gchar             *DATA_KEY
                         );


gchar *
gpiv_fwrite_hdf5_histo                  (const gchar            *fname, 
                                        const GpivBinData      *klass, 
                                        const gchar            *DATA_KEY
                                        );


GpivImage *
gpiv_read_davis_image                   (FILE                   *fp
                                        );


#endif /* __LIBGPIV_IO_H__ */

---