gpiv-valid_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, 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.  




-------------------------------------------------------------------------------
FILENAME:               gpiv-valid_par.h
LIBRARY:                libgpiv
EXTERNAL FUNCTIONS:
SOURCE:                 valid_par.c
                        gpiv_valid_parameters_set
                        gpiv_valid_default_parameters
                        gpiv_valid_get_parameters_from_resources

                        gpiv_valid_read_parameters
                        gpiv_valid_check_parameters_read
                        gpiv_valid_testonly_parameters
                        gpiv_valid_testadjust_parameters
                        gpiv_valid_print_parameters
                        gpiv_valid_fread_hdf5_parameters
                        gpiv_valid_fwrite_hdf5_parameters

                        gpiv_valid_mpi_bcast_validpar

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

#ifndef __LIBGPIV_VALIDPAR_H__
#define __LIBGPIV_VALIDPAR_H__


#define GPIV_VALIDPAR_KEY      "VALID" 
#define GPIV_VALIDPAR_MAX__NEIGHBORS 9 
enum ResiduType {
    GPIV_VALID_RESIDUTYPE__SNR,         
    GPIV_VALID_RESIDUTYPE__MEDIAN,      
    GPIV_VALID_RESIDUTYPE__NORMMEDIAN   
};



enum SubstitutionType {
    GPIV_VALID_SUBSTYPE__NONE,          
    GPIV_VALID_SUBSTYPE__L_MEAN,        
    GPIV_VALID_SUBSTYPE__MEDIAN,        
    GPIV_VALID_SUBSTYPE__COR_PEAK       
};



typedef struct __GpivValidPar GpivValidPar;

 struct __GpivValidPar {
    gfloat data_yield;                 
    gfloat residu_max;                 
    guint neighbors;                    
    enum ResiduType residu_type;       
    enum SubstitutionType subst_type;  
    gint histo_type;                   
    gboolean data_yield__set;          
    gboolean residu_max__set;          
    gboolean neighbors__set;           
    gboolean residu_type__set;         
    gboolean subst_type__set;          
    gboolean histo_type__set;          
};


void
gpiv_valid_parameters_set       (GpivValidPar       *valid_par,
                    const gboolean      flag
                    );



void
gpiv_valid_default_parameters       (GpivValidPar       *valid_par_default,
                    const gboolean      force
                    );



GpivValidPar *
gpiv_valid_get_parameters_from_resources(const gchar        *localrc,
                    const gboolean      verbose
                    );



void 
gpiv_valid_read_parameters      (FILE           *fp_par,
                    GpivValidPar        *valid_par,
                    const gboolean      print_par
                    );



gchar *
gpiv_valid_check_parameters_read    (GpivValidPar           *valid_par,
                    const GpivValidPar  *valid_par_default
                    );





gchar *
gpiv_valid_testonly_parameters          (const GpivValidPar     *valid_par
                    );


gchar *
gpiv_valid_testadjust_parameters    (GpivValidPar       *valid_par
                    );


void 
gpiv_valid_print_parameters     (FILE                   *fp,
                    const GpivValidPar  *valid_par
                    );


GpivValidPar *
gpiv_valid_cp_parameters        (const GpivValidPar *valid_par
                    );


void
gpiv_valid_dupl_parameters      (const GpivValidPar     *valid_par_src, 
                    GpivValidPar        *valid_par_dest
                    );


GpivValidPar *
gpiv_valid_fread_hdf5_parameters        (const gchar        *fname
                    );



gchar *
gpiv_valid_fwrite_hdf5_parameters   (const gchar            *fname, 
                    const GpivValidPar  *valid_par
                    );

#ifdef ENABLE_MPI

void
gpiv_valid_mpi_bcast_validpar       (GpivValidPar       *valid_par
                    );

#endif /* ENABLE_MPI */
#endif /* __LIBGPIV_VALIDPAR_H__ */