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------------------------------------------------------------------------------
27FILENAME: piv_par.c
28LIBRARY: libgpiv
29EXTERNAL 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"
75
76
80typedef struct __GpivPivPar GpivPivPar;
81
173
174
175/*
176 * Function prototypes
177 */
178
188void
190 const gboolean force
191 );
192
193
194
205 const gboolean verbose
206 );
207
208
209
217void
219 const gboolean flag
220 );
221
222
223
233void
235 GpivPivPar *piv_par,
236 const gboolean verbose
237 );
238
239
240
251gchar *
253 const GpivPivPar *piv_par_default
254 );
255
256
257
266gchar *
268 const GpivPivPar *piv_par
269 );
270
271
272
282gchar *
284 GpivPivPar *piv_par
285 );
286
287
288
297void
299 const GpivPivPar *piv_par
300 );
301
310 );
311
312
321void
323 GpivPivPar *piv_par_dest
324 );
325
326
335 );
336
337
345gchar *
347 const GpivPivPar *piv_par
348 );
349
350
351#ifdef ENABLE_MPI
358gchar *
359gpiv_piv_mpi_bcast_pivpar (GpivPivPar *piv_par);
360#endif /* ENABLE_MPI */
361#endif /* __LIBGPIV_PIVPAR_H__ */
gchar * gpiv_piv_check_parameters_read(GpivPivPar *piv_par, const GpivPivPar *piv_par_default)
void gpiv_piv_default_parameters(GpivPivPar *piv_par_default, const gboolean force)
Sets default parameter values.
GpivPivPar * gpiv_piv_get_parameters_from_resources(const gchar *localrc, const gboolean verbose)
Reads piv parameters from system-wide gpiv.conf and $HOME/.gpivrc.
GpivIntScheme
PIV interrogation scheme.
@ GPIV_NO_CORR
@ GPIV_IMG_DEFORM
image deformation
@ GPIV_LK_WEIGHT
Linear kernel weighting if Interrogation Area's.
@ GPIV_ZERO_OFF_FORWARD
classical zero ofsetting
@ GPIV_ZERO_OFF_CENTRAL
zero ofsetting using central differential scheme
void gpiv_piv_read_parameters(FILE *fp, GpivPivPar *piv_par, const gboolean verbose)
Reads all parameters for PIV evaluation.
gchar * gpiv_piv_fwrite_hdf5_parameters(const gchar *fname, const GpivPivPar *piv_par)
Writes piv parameters from hdf5 data file.
gchar * gpiv_piv_testadjust_parameters(const GpivImagePar *image_par, GpivPivPar *piv_par)
Tests if all piv parameters have been read and have been defined to valid values.
void gpiv_piv_print_parameters(FILE *fp, const GpivPivPar *piv_par)
Prints parameters to fp.
gchar * gpiv_piv_testonly_parameters(const GpivImagePar *image_par, const GpivPivPar *piv_par)
Tests all piv parameters if have been read and have been defined to valid values.
void gpiv_piv_parameters_set(GpivPivPar *piv_par, const gboolean flag)
Sets flags for all piv_par__set.
void gpiv_piv_cp_undef_parameters(const GpivPivPar *piv_par_src, GpivPivPar *piv_par_dest)
Copies piv parameters from piv_par_src to piv_par_dest if piv_par_dest have not been set.
GpivPivPar * gpiv_piv_fread_hdf5_parameters(const gchar *fname)
Reads piv parameters from hdf5 data file.
GpivPivPar * gpiv_piv_cp_parameters(const GpivPivPar *piv_par)
Copies piv parameters.
Image parameters or header info.
Definition gpiv-img.h:122
Parameters for PIV evaluation (interrogation) of images.
gboolean int_point_col__set
flag if int_point_col has been defined
gboolean print_piv__set
flag if print_piv has been defined
gboolean int_line_col_start__set
flag if int_line_col_start has been defined
gboolean int_line_row__set
flag if int_line_row has been defined
guint col_end
last column in image to use for interrogation
gboolean peak__set
flag if peak has been defined
int spline_degree
degree of b-splines to be used for image data interpolation
gboolean int_line_row_start__set
flag if int_line_row_start has been defined
gboolean ifit__set
flag if ifit has been defined
guint int_line_col
interrogation along a column
guint int_point_row
row of a interrogation area for single point
guint row_end
first row of image to use for interrogation
gboolean col_start__set
flag if col_start has been defined
gboolean col_end__set
flag if col_end has been defined
gboolean int_point_row__set
flag if int_point_row has been defined
gboolean pre_shift_row__set
flag if pre_shift_row has been defined
guint int_point_col
column of a interrogation area for single point
gboolean print_par__set
flag if print_par has been defined
gboolean row_end__set
flag if row_end has been defined
gboolean int_geo__set
flag if int_geo has been defined
gboolean int_size_f__set
flag if int_size_i has been defined
gboolean pre_shift_col__set
flag if pre_shift_col has been defined
guint int_line_row_start
first row of image to use for interrogation along a column
gboolean int_line_col_end__set
flag if int_line_col_end has been defined
gint peak
peak number of correlation function to be used as estimator
guint int_line_row
interrogation along a row
gboolean int_deform__set
flag if int_deform has been defined
gboolean int_shift__set
flag if int_shift has been defined
gboolean spline_degree__set
flag if spline_degree has been defined
gboolean int_scheme__set
flag if int_scheme has been defined
guint ifit
Type of sub-pixel estimation.
guint col_start
first column of image to use for interrogation
gboolean spof_filter__set
flag if spof_filter has been defined
gboolean spof_filter
Symmetric Phase Only filtering of covariance function.
int print_par
print parameters
enum GpivIntScheme int_scheme
Way to correct on biasing effects with value of GpivIntScheme.
guint int_line_col_end
last column of image to use for interrogation along a line
int print_piv
print piv data
gboolean row_start__set
flag if row_start has been defined
gint int_shift
interrogation area shift
int int_deform
deform image for improved accuracy
gboolean gauss_weight_ia__set
flag if gauss_weight_ia has been defined
guint int_line_col_start
first column of image to use for interrogation along a line
gboolean int_line_col__set
flag if int_line_col has been defined
int pre_shift_row
general pre-shift in vertical direction (rows)
guint int_size_f
final interrogation area size; to be ended with
int pre_shift_col
general pre-shift in horizontal direction (columns)
guint int_geo
Interrogation along a line or within an area of interest.
gboolean int_line_row_end__set
flag if int_line_row_end has been defined
guint row_start
last row in image to use for interrogation
gboolean gauss_weight_ia
Gaussian weighting to I.A.
guint int_size_i
initial interrogation area size; to start with
guint int_line_row_end
first row of image to use for interrogation along a column
gboolean int_size_i__set
flag if int_size_f has been defined

Generated for libgpiv-0.6.1 by doxygen 1.9.8