Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-valid_par.h
Go to the documentation of this file.
1 /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */
2 
3 /*
4  libgpiv - library for Particle Image Velocimetry
5 
6  Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Gerber van der Graaf
7 
8  This file is part of libgpiv.
9 
10  Libgpiv is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2, or (at your option)
13  any later version.
14 
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with this program; if not, write to the Free Software Foundation,
22  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 
24 
25 
26 
27 -------------------------------------------------------------------------------
28 FILENAME: gpiv-valid_par.h
29 LIBRARY: libgpiv
30 EXTERNAL FUNCTIONS:
31 SOURCE: valid_par.c
32  gpiv_valid_parameters_set
33  gpiv_valid_default_parameters
34  gpiv_valid_get_parameters_from_resources
35 
36  gpiv_valid_read_parameters
37  gpiv_valid_check_parameters_read
38  gpiv_valid_testonly_parameters
39  gpiv_valid_testadjust_parameters
40  gpiv_valid_print_parameters
41  gpiv_valid_fread_hdf5_parameters
42  gpiv_valid_fwrite_hdf5_parameters
43 
44  gpiv_valid_mpi_bcast_validpar
45 
46  --------------------------------------------------------------------------- */
47 
58 #ifndef __LIBGPIV_VALIDPAR_H__
59 #define __LIBGPIV_VALIDPAR_H__
60 
61 
62 #define GPIV_VALIDPAR_KEY "VALID"
63 #define GPIV_VALIDPAR_MAX__NEIGHBORS 9
70 enum ResiduType {
79 };
80 
81 
82 
91 };
92 
93 
94 
96 
103  struct __GpivValidPar {
104  gfloat data_yield;
107  gfloat residu_max;
108  guint neighbors;
111  gint histo_type;
113  gboolean data_yield__set;
114  gboolean residu_max__set;
115  gboolean neighbors__set;
116  gboolean residu_type__set;
117  gboolean subst_type__set;
118  gboolean histo_type__set;
119 };
120 
121 
130 void
132  const gboolean flag
133  );
134 
135 
136 
144 void
145 gpiv_valid_default_parameters (GpivValidPar *valid_par_default,
146  const gboolean force
147  );
148 
149 
150 
159 GpivValidPar *
160 gpiv_valid_get_parameters_from_resources(const gchar *localrc,
161  const gboolean verbose
162  );
163 
164 
165 
175 void
176 gpiv_valid_read_parameters (FILE *fp_par,
177  GpivValidPar *valid_par,
178  const gboolean print_par
179  );
180 
181 
182 
194 gchar *
196  const GpivValidPar *valid_par_default
197  );
198 
199 
200 
201 
202 
210 gchar *
212  );
213 
214 
223 gchar *
225  );
226 
227 
236 void
238  const GpivValidPar *valid_par
239  );
240 
241 
248 GpivValidPar *
249 gpiv_valid_cp_parameters (const GpivValidPar *valid_par
250  );
251 
252 
261 void
262 gpiv_valid_dupl_parameters (const GpivValidPar *valid_par_src,
263  GpivValidPar *valid_par_dest
264  );
265 
266 
273 GpivValidPar *
274 gpiv_valid_fread_hdf5_parameters (const gchar *fname
275  );
276 
277 
278 
286 gchar *
287 gpiv_valid_fwrite_hdf5_parameters (const gchar *fname,
288  const GpivValidPar *valid_par
289  );
290 
291 #ifdef ENABLE_MPI
292 
298 void
299 gpiv_valid_mpi_bcast_validpar (GpivValidPar *valid_par
300  );
301 
302 #endif /* ENABLE_MPI */
303 #endif /* __LIBGPIV_VALIDPAR_H__ */
304 
Piv validation parameters.
enum SubstitutionType subst_type
use substitution type
gfloat data_yield
data yield ( from particle image concentration, out-of plane flow, velocity gradient within interroga...
GpivValidPar * gpiv_valid_get_parameters_from_resources(const gchar *localrc, const gboolean verbose)
Reads validation parameters from system-wide gpiv.conf and $HOME/.gpivrc.
use location of next highest correlation peak as estimator
gchar * gpiv_valid_check_parameters_read(GpivValidPar *valid_par, const GpivValidPar *valid_par_default)
Checks out if all parameters have been read.
substitute by local mean value
void gpiv_valid_print_parameters(FILE *fp, const GpivValidPar *valid_par)
Prints all validation parameters in ASCII format to fp.
Signal to noise ratio.
void gpiv_valid_parameters_set(GpivValidPar *valid_par, const gboolean flag)
Defines value of __set members of PivValidPar.
gfloat residu_max
maximum residu value
GpivValidPar * gpiv_valid_fread_hdf5_parameters(const gchar *fname)
Reads validation parameters from hdf5 data file.
SubstitutionType
Erroneous vector substituted by type.
void gpiv_valid_dupl_parameters(const GpivValidPar *valid_par_src, GpivValidPar *valid_par_dest)
Duplicates validation parameters from valid_par_src to valid_par_dest if valid_par_dest have not been...
normalized median, obtained from the ratio between datapoint under investigation and median velocity ...
gboolean neighbors__set
flag if neighbors has been defined
GpivValidPar * gpiv_valid_cp_parameters(const GpivValidPar *valid_par)
Copies validation parameters.
gchar * gpiv_valid_testonly_parameters(const GpivValidPar *valid_par)
Tests if all validation parameters have been read and have been defined to valid values.
void gpiv_valid_read_parameters(FILE *fp_par, GpivValidPar *valid_par, const gboolean print_par)
Reads validation parameters from file.
gboolean data_yield__set
flag if data_yield has been defined
gboolean residu_type__set
flag if residu_type has been defined
ResiduType
Type of residu to detect outliers.
no value, point will be disabled by setting __GpivPivData peak_nr to -1
gchar * gpiv_valid_testadjust_parameters(GpivValidPar *valid_par)
Tests if all validation parameters have been read and have been defined to valid values.
gboolean histo_type__set
flag if histo_type has been defined
gboolean residu_max__set
flag if residu_max has been defined
enum ResiduType residu_type
use residu type
median value of NxN surrounding estimators
gint histo_type
use histogram type
guint neighbors
number of neighbouring estimators
gchar * gpiv_valid_fwrite_hdf5_parameters(const gchar *fname, const GpivValidPar *valid_par)
Writes validation parameters to an existing hdf5 data file.
substitute by median value from surroundings
gboolean subst_type__set
flag if subst_type has been defined
void gpiv_valid_default_parameters(GpivValidPar *valid_par_default, const gboolean force)
Sets parameters to default values.

Generated for libgpiv-0.6.1 by doxygen 1.8.13