Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-post_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-----------------------------------------------------------------------
28LIBRARY: libgpiv
29SOURCE: post_par.c
30EXTERNAL FUNCTIONS:
31 gpiv_post_parameters_set
32 gpiv_post_default_parameters
33 gpiv_post_get_parameters_from_resources
34
35 gpiv_post_read_parameters
36 gpiv_post_check_parameters_read
37 gpiv_post_fprint_parameters
38 gpiv_post_fread_hdf5_parameters
39 gpiv_post_fwrite_hdf5_parameters
40
41 ------------------------------------------------------------------- */
42
52#ifndef __LIBGPIV_POSTPAR_H__
53#define __LIBGPIV_POSTPAR_H__
54
55#define GPIV_POSTPAR_KEY "POST"
72
73
74
84
85
86
95
96
97
105
106
107
108typedef struct __GpivRoi GpivRoi;
109
113struct __GpivRoi {
114 float x_1;
115 float y_1;
116 float x_2;
117 float y_2;
118};
119
120
122
140 gboolean set;
141 gboolean set__set;
143 float set_dx;
145 gboolean set_dx__set;
147 float set_dy;
149 gboolean set_dy__set;
153 gboolean block__set;
154
155/*
156 * Parameters for spatial average (s-avg)
157 */
159 gboolean subtract__set;
161 float z_off_dx;
162 gboolean z_off_dx__set;
164 float z_off_dy;
165 gboolean z_off_dy__set;
167/*
168 * Parameters for vorticity and strain
169 */
176/*
177 * Parameters for scaling PIV data. Other parameters for scaling are in
178 * __GpivImagePar.
179 */
182};
183
184
185
186
194void
196 const gboolean flag
197 );
198
199
200
208void
210 const gboolean force
211 );
212
213
214
226 const gboolean verbose
227 );
228
229
238void
240 GpivPostPar *post_par,
241 const gboolean print_par
242 );
243
244
245
257gchar *
259 const GpivPostPar *post_par_default
260 );
261
262
263
271void
273 const GpivPostPar *post_par
274 );
275
276
277
286 );
287
288
289
297gchar *
299 const GpivPostPar *post_par
300 );
301
302
303
304#endif /* __LIBGPIV_POSTPAR_H_ */
void gpiv_post_default_parameters(GpivPostPar *post_par_default, const gboolean force)
Sets post-processing parameters to default values.
GpivPostPar * gpiv_post_fread_hdf5_parameters(const gchar *fname)
Reads post parameters from hdf5 data file.
gchar * gpiv_post_check_parameters_read(GpivPostPar *post_par, const GpivPostPar *post_par_default)
Checks if all post-processing parameters have been read.
GpivOperationManipiv
Operator to transform (manipulate) PIV data.
@ GPIV_PASS_BLOCK
passes through
@ GPIV_FLIP_X
flip in x-direction
@ GPIV_REVERT
reverts array indexes
@ GPIV_ROT90
rotates over 90 degrees
@ GPIV_ROT180
rotates over 180 degrees
@ GPIV_FAST_Y
returns fast running y-positions of data
@ GPIV_FILTER_BLOCK
filters out
@ GPIV_FLIP_Y
flip in y-direction
@ GPIV_ADD_XY
adds specified displacement/velocity in x and y direction
GpivPostPar * gpiv_post_get_parameters_from_resources(const gchar *localrc, const gboolean verbose)
Reads post-processing parameters from localrc, $HOME/.gpivrc and system-wide gpiv....
gchar * gpiv_post_fwrite_hdf5_parameters(const gchar *fname, const GpivPostPar *post_par)
Writes post parameters to an existing hdf5 data file.
GpivDifferentiation
Differential type.
@ GPIV_CENTRAL
Central differential.
@ GPIV_CIRCULATION
Circulation method.
@ GPIV_RICHARDSON
Richarchon differential.
@ GPIV_LEAST_SQUARES
Least square.
void gpiv_post_parameters_set(GpivPostPar *post_par, const gboolean flag)
Sets flag for post_par __set.
GpivScaleType
Variables for scaling PIV data.
@ GPIV_SCALE
Scaling PIV data.
@ GPIV_SCALE_INV
Inverse scaling PIV data.
void gpiv_post_read_parameters(FILE *fp_par, GpivPostPar *post_par, const gboolean print_par)
Reads all parameters for PIV data validation.
void gpiv_post_print_parameters(FILE *fp_par_out, const GpivPostPar *post_par)
Prints parameters to fp_par_out.
GpivOperation
Type of derivative operation.
@ GPIV_VORTICITY
Vorticity.
@ GPIV_N_STRAIN
Normal strain.
@ GPIV_S_STRAIN
Shear strain.
Parameters for post-processing PIV data.
float z_off_dy
offset value for vertical PIV estimator
gboolean set__set
flag if set has been defined
gboolean subtract__set
flag if subtract has been defined
enum GpivScaleType scale_type
normal or inverse scaling
int subtract
data type to subtract from estimators NONE (0), mean (1) Zoff_dx and Zoff_dy (2)
gboolean set_dy__set
flag if set_dy has been defined
gboolean set_dx__set
flag if set_dx has been defined
float z_off_dx
offset value for horizontal PIV estimator
gboolean z_off_dx__set
flag if z_off_dx has been defined
int diff_type__set
flag if diff_type has been defined
float set_dx
value of disabled PIV data in horizontal (column-wise) direction
gboolean operator_manipiv__set
flag if operator_manipiv has been defined
gboolean block__set
gboolean scale_type__set
flag if scale_type has been defined
enum GpivOperation operator_vorstra
specify which derivative type from PIV data to calculate
gboolean operator_vorstra__set
flag if operator_vorstra has been defined
GpivRoi * block
Define a rectangular block for enabling / disabling PIV data.
enum GpivDifferentiation diff_type
differential type
enum GpivOperationManipiv operator_manipiv
operator on PIV data
gboolean z_off_dy__set
flag if z_off_dy has been defined
gboolean set
setting of PIV data: enable / disable
float set_dy
value of disabled PIV data in vertical (row-wise) direction
Region Of Interest.
float y_1
lowest y value
float x_1
lowest x value
float x_2
highest x value
float y_2
highest x value

Generated for libgpiv-0.6.1 by doxygen 1.9.8