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-------------------------------------------------------------------------------
28FILENAME: gpiv-valid_par.h
29LIBRARY: libgpiv
30EXTERNAL FUNCTIONS:
31SOURCE: 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
80
81
82
92
93
94
96
120
121
130void
132 const gboolean flag
133 );
134
135
136
144void
146 const gboolean force
147 );
148
149
150
161 const gboolean verbose
162 );
163
164
165
175void
177 GpivValidPar *valid_par,
178 const gboolean print_par
179 );
180
181
182
194gchar *
196 const GpivValidPar *valid_par_default
197 );
198
199
200
201
202
210gchar *
212 );
213
214
223gchar *
225 );
226
227
236void
238 const GpivValidPar *valid_par
239 );
240
241
250 );
251
252
261void
263 GpivValidPar *valid_par_dest
264 );
265
266
275 );
276
277
278
286gchar *
288 const GpivValidPar *valid_par
289 );
290
291#ifdef ENABLE_MPI
298void
299gpiv_valid_mpi_bcast_validpar (GpivValidPar *valid_par
300 );
301
302#endif /* ENABLE_MPI */
303#endif /* __LIBGPIV_VALIDPAR_H__ */
304
void gpiv_valid_print_parameters(FILE *fp, const GpivValidPar *valid_par)
Prints all validation parameters in ASCII format to fp.
void gpiv_valid_parameters_set(GpivValidPar *valid_par, const gboolean flag)
Defines value of __set members of PivValidPar.
GpivValidPar * gpiv_valid_get_parameters_from_resources(const gchar *localrc, const gboolean verbose)
Reads validation parameters from system-wide gpiv.conf and $HOME/.gpivrc.
gchar * gpiv_valid_check_parameters_read(GpivValidPar *valid_par, const GpivValidPar *valid_par_default)
Checks out if all parameters have been read.
SubstitutionType
Erroneous vector substituted by type.
@ GPIV_VALID_SUBSTYPE__NONE
no value, point will be disabled by setting __GpivPivData peak_nr to -1
@ GPIV_VALID_SUBSTYPE__COR_PEAK
use location of next highest correlation peak as estimator
@ GPIV_VALID_SUBSTYPE__MEDIAN
substitute by median value from surroundings
@ GPIV_VALID_SUBSTYPE__L_MEAN
substitute by local mean value
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...
GpivValidPar * gpiv_valid_fread_hdf5_parameters(const gchar *fname)
Reads validation parameters from hdf5 data file.
void gpiv_valid_default_parameters(GpivValidPar *valid_par_default, const gboolean force)
Sets parameters to default values.
ResiduType
Type of residu to detect outliers.
@ GPIV_VALID_RESIDUTYPE__MEDIAN
median value of NxN surrounding estimators
@ GPIV_VALID_RESIDUTYPE__SNR
Signal to noise ratio.
@ GPIV_VALID_RESIDUTYPE__NORMMEDIAN
normalized median, obtained from the ratio between datapoint under investigation and median velocity ...
gchar * gpiv_valid_testadjust_parameters(GpivValidPar *valid_par)
Tests if all validation parameters have been read and have been defined to valid values.
GpivValidPar * gpiv_valid_cp_parameters(const GpivValidPar *valid_par)
Copies validation parameters.
void gpiv_valid_read_parameters(FILE *fp_par, GpivValidPar *valid_par, const gboolean print_par)
Reads validation parameters from file.
gchar * gpiv_valid_testonly_parameters(const GpivValidPar *valid_par)
Tests if all validation parameters have been read and have been defined to valid values.
gchar * gpiv_valid_fwrite_hdf5_parameters(const gchar *fname, const GpivValidPar *valid_par)
Writes validation parameters to an existing hdf5 data file.
Piv validation parameters.
gboolean histo_type__set
flag if histo_type has been defined
gfloat residu_max
maximum residu value
gboolean residu_max__set
flag if residu_max has been defined
enum ResiduType residu_type
use residu type
gboolean subst_type__set
flag if subst_type has been defined
guint neighbors
number of neighbouring estimators
gboolean residu_type__set
flag if residu_type has been defined
gboolean neighbors__set
flag if neighbors has been defined
enum SubstitutionType subst_type
use substitution type
gfloat data_yield
data yield ( from particle image concentration, out-of plane flow, velocity gradient within interroga...
gboolean data_yield__set
flag if data_yield has been defined
gint histo_type
use histogram type

Generated for libgpiv-0.6.1 by doxygen 1.9.8