Lib
piv API documentation
Main Page
|
Files
|
Data Structures
|
Functions
|
Global Variables
|
Main Page
Data Structures
Files
File List
Globals
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 {
71
GPIV_VALID_RESIDUTYPE__SNR
,
72
GPIV_VALID_RESIDUTYPE__MEDIAN
,
73
GPIV_VALID_RESIDUTYPE__NORMMEDIAN
79
};
80
81
82
86
enum
SubstitutionType
{
87
GPIV_VALID_SUBSTYPE__NONE
,
88
GPIV_VALID_SUBSTYPE__L_MEAN
,
89
GPIV_VALID_SUBSTYPE__MEDIAN
,
90
GPIV_VALID_SUBSTYPE__COR_PEAK
91
};
92
93
94
95
typedef
struct
__GpivValidPar
GpivValidPar
;
96
103
struct
__GpivValidPar
{
104
gfloat
data_yield
;
107
gfloat
residu_max
;
108
guint
neighbors
;
109
enum
ResiduType
residu_type
;
110
enum
SubstitutionType
subst_type
;
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
131
gpiv_valid_parameters_set
(
GpivValidPar
*valid_par,
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 *
195
gpiv_valid_check_parameters_read
(
GpivValidPar
*valid_par,
196
const
GpivValidPar
*valid_par_default
197
);
198
199
200
201
202
210
gchar *
211
gpiv_valid_testonly_parameters
(
const
GpivValidPar
*valid_par
212
);
213
214
223
gchar *
224
gpiv_valid_testadjust_parameters
(
GpivValidPar
*valid_par
225
);
226
227
236
void
237
gpiv_valid_print_parameters
(FILE *fp,
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
Generated on Thu Mar 20 2014 09:01:34 for libgpiv-0.6.1 by
1.8.1.2