Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-piv_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 FILENAME: piv_par.c
28 LIBRARY: libgpiv
29 EXTERNAL FUNCTIONS:
30  gpiv_piv_parameters_set
31  gpiv_piv_default_parameters
32  gpiv_piv_get_parameters_from_resources
33 
34  gpiv_piv_read_parameters
35  gpiv_piv_check_parameters_read
36  gpiv_piv_test_parameters
37  gpiv_piv_print_parameters
38  gpiv_piv_cp_parameters
39  gpiv_piv_cp_undef_parameters
40  gpiv_piv_fread_hdf5_parameters
41  gpiv_piv_fwrite_hdf5_parameters
42 
43 --------------------------------------------------------------------- */
44 
55 #ifndef __LIBGPIV_PIVPAR_H__
56 #define __LIBGPIV_PIVPAR_H__
57 
58 /*-----------------------------------------------------------------------------
59  * Parameters for Piv evaluation
60  */
61 
62 #define GPIV_PIVPAR_KEY "PIV"
68 enum GpivIntScheme {
74 };
75 
76 
80 typedef struct __GpivPivPar GpivPivPar;
81 
91 struct __GpivPivPar {
92  guint col_start;
93  gboolean col_start__set;
95  guint col_end;
96  gboolean col_end__set;
98  guint ifit;
99  gboolean ifit__set;
101  guint int_geo;
102  gboolean int_geo__set;
104  guint int_line_col;
105  gboolean int_line_col__set;
113  guint int_line_row;
114  gboolean int_line_row__set;
128  guint int_size_f;
129  gboolean int_size_f__set;
131  guint int_size_i;
132  gboolean int_size_i__set;
134  gint int_shift;
135  gboolean int_shift__set;
138  gboolean int_deform__set;
140  gint peak;
141  gboolean peak__set;
149  int print_par;
150  gboolean print_par__set;
152  int print_piv;
153  gboolean print_piv__set;
155  guint row_start;
156  gboolean row_start__set;
158  guint row_end;
159  gboolean row_end__set;
165  gboolean int_scheme__set;
167  gboolean gauss_weight_ia;
170  gboolean spof_filter;
171  gboolean spof_filter__set;
172 };
173 
174 
175 /*
176  * Function prototypes
177  */
178 
188 void
189 gpiv_piv_default_parameters (GpivPivPar *piv_par_default,
190  const gboolean force
191  );
192 
193 
194 
203 GpivPivPar *
204 gpiv_piv_get_parameters_from_resources (const gchar *localrc,
205  const gboolean verbose
206  );
207 
208 
209 
217 void
219  const gboolean flag
220  );
221 
222 
223 
233 void
234 gpiv_piv_read_parameters (FILE *fp,
235  GpivPivPar *piv_par,
236  const gboolean verbose
237  );
238 
239 
240 
251 gchar *
253  const GpivPivPar *piv_par_default
254  );
255 
256 
257 
266 gchar *
267 gpiv_piv_testonly_parameters (const GpivImagePar *image_par,
268  const GpivPivPar *piv_par
269  );
270 
271 
272 
282 gchar *
284  GpivPivPar *piv_par
285  );
286 
287 
288 
297 void
298 gpiv_piv_print_parameters (FILE *fp,
299  const GpivPivPar *piv_par
300  );
301 
308 GpivPivPar *
309 gpiv_piv_cp_parameters (const GpivPivPar *piv_par
310  );
311 
312 
321 void
322 gpiv_piv_cp_undef_parameters (const GpivPivPar *piv_par_src,
323  GpivPivPar *piv_par_dest
324  );
325 
326 
333 GpivPivPar *
334 gpiv_piv_fread_hdf5_parameters (const gchar *fname
335  );
336 
337 
345 gchar *
346 gpiv_piv_fwrite_hdf5_parameters (const gchar *fname,
347  const GpivPivPar *piv_par
348  );
349 
350 
351 #ifdef ENABLE_MPI
352 
358 gchar *
359 gpiv_piv_mpi_bcast_pivpar (GpivPivPar *piv_par);
360 #endif /* ENABLE_MPI */
361 #endif /* __LIBGPIV_PIVPAR_H__ */

Generated on Thu Mar 20 2014 09:01:34 for libgpiv-0.6.1 by doxygen 1.8.1.2