Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-valid.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
29EXTERNAL FUNCTIONS:
30SOURCE: valid_par.c
31 gpiv_valid_parameters_set
32 gpiv_valid_default_parameters
33 gpiv_valid_read_parameters
34 gpiv_valid_check_parameters_read
35 gpiv_valid_test_parameter
36 gpiv_valid_fprint_parameters
37
38SOURCE: valid.c
39 gpiv_valid_residu
40 gpiv_valid_residu_stats
41 gpiv_valid_peaklck
42 gpiv_valid_errvec
43 gpiv_valid_gradient
44 gpiv_cumhisto_eqdatbin_gnuplot
45 gpiv_valid_threshold
46
47 ------------------------------------------------------------------- */
48
59#ifndef __LIBGPIV_VALID_H__
60#define __LIBGPIV_VALID_H__
61
62
63#include <gpiv/gpiv-valid_par.h>
64
65#define GPIV_GRADIENT_THRESHOLD 2.0
66#define GPIV_THRESHOLD_DEFAULT 1.2
67#define GPIV_VALID_MAX_SWEEP 9
68#define GPIV_RESIDU_MAX_NORMMEDIAN 2.0
74
79 double c0;
80 double c1;
81 double cov00;
82 double cov01;
83 double cov11;
84 double sumsq;
85};
86
87
88
98gchar *
100 const GpivValidPar *valid_par,
101 const gboolean incl_point
102 );
103
104
105
118 const guint nbins,
119 GpivLinRegData *linreg
120 );
121
122
123
134 const guint nbins
135 );
136
137
149gchar *
151 const GpivImage *image,
152 const GpivPivPar *piv_par,
153 const GpivValidPar *valid_par,
154 const gboolean interrogate_valid
155 );
156
157
168void
170 GpivPivData *piv_data
171 );
172
173
185void
186gpiv_cumhisto_eqdatbin_gnuplot (const gchar *fname_out,
187 const gchar *title,
188 const gchar *GNUPLOT_DISPLAY_COLOR,
189 const gint GNUPLOT_DISPLAY_SIZE,
190 const GpivLinRegData *linreg
191 );
192
193
203gfloat
205 const GpivValidPar *valid_par,
206 const GpivLinRegData *linreg
207 );
208
209
210
211
212
213#endif /* __LIBGPIV_VALID_H__ */
214
GpivBinData * gpiv_valid_residu_stats(const GpivPivData *piv_data, const guint nbins, GpivLinRegData *linreg)
Calculates cumulative histogram of residus and linear regression fit parameters.
gfloat gpiv_valid_threshold(const GpivPivPar *piv_par, const GpivValidPar *valid_par, const GpivLinRegData *linreg)
Calculates threshold value (residu_max) from residus.
gchar * gpiv_valid_residu(GpivPivData *piv_data, const GpivValidPar *valid_par, const gboolean incl_point)
Calculates residu values (at the inner points) of a PIV data set and applies to snr member of returne...
gchar * gpiv_valid_errvec(GpivPivData *piv_data, const GpivImage *image, const GpivPivPar *piv_par, const GpivValidPar *valid_par, const gboolean interrogate_valid)
Piv data validation function on outliers.
void gpiv_cumhisto_eqdatbin_gnuplot(const gchar *fname_out, const gchar *title, const gchar *GNUPLOT_DISPLAY_COLOR, const gint GNUPLOT_DISPLAY_SIZE, const GpivLinRegData *linreg)
Plots cumulative histogram with an equal number of data.
void gpiv_valid_gradient(const GpivPivPar *piv_par, GpivPivData *piv_data)
Searches vectors in a PIV data set that exceed the maximum gradient (dUxdt/int_size > GPIV_GRADIENT_T...
GpivBinData * gpiv_valid_peaklck(const GpivPivData *piv_data, const guint nbins)
Piv data validation on peak-locking effects.
module for parameters for validating PIV data
Used for making up histograms in bins or klasses.
Definition gpiv.h:348
Piv image header and data.
Definition gpiv-img.h:194
Data structure of linear regression data.
Definition gpiv-valid.h:78
double c1
first order constant
Definition gpiv-valid.h:80
double c0
zero order constant
Definition gpiv-valid.h:79
double cov01
correlation bewteen first and 2nd const.
Definition gpiv-valid.h:82
double sumsq
sum of squared residuals
Definition gpiv-valid.h:84
double cov00
variance of zero order constant
Definition gpiv-valid.h:81
double cov11
variance of zero order constant
Definition gpiv-valid.h:83
Holds the variables of PIV data.
Definition gpiv.h:267
Parameters for PIV evaluation (interrogation) of images.
Piv validation parameters.

Generated for libgpiv-0.6.1 by doxygen 1.9.8