/usr/include/gpiv/gpiv-valid.h is in libgpiv3-dev 0.6.1-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */
/*
libgpiv - library for Particle Image Velocimetry
Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Gerber van der Graaf
This file is part of libgpiv.
Libgpiv is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-----------------------------------------------------------------------
LIBRARY: libgpiv
EXTERNAL FUNCTIONS:
SOURCE: valid_par.c
gpiv_valid_parameters_set
gpiv_valid_default_parameters
gpiv_valid_read_parameters
gpiv_valid_check_parameters_read
gpiv_valid_test_parameter
gpiv_valid_fprint_parameters
SOURCE: valid.c
gpiv_valid_residu
gpiv_valid_residu_stats
gpiv_valid_peaklck
gpiv_valid_errvec
gpiv_valid_gradient
gpiv_cumhisto_eqdatbin_gnuplot
gpiv_valid_threshold
------------------------------------------------------------------- */
/*!
\file gpiv-valid.h
\brief module for validating PIV data
SOURCES: lib/valid.c, lib/valid_par.c
LAST MODIFICATION DATE: $Id: gpiv-valid.h,v 1.2 2008-04-09 06:10:28 gerber Exp $
*/
#ifndef __LIBGPIV_VALID_H__
#define __LIBGPIV_VALID_H__
#include <gpiv/gpiv-valid_par.h>
#define GPIV_GRADIENT_THRESHOLD 2.0 /**< Default threshold of displacement gradient */
#define GPIV_THRESHOLD_DEFAULT 1.2 /**< Default residu threshold */
#define GPIV_VALID_MAX_SWEEP 9 /**< maximum number of validation sweeps, starting from zero */
#define GPIV_RESIDU_MAX_NORMMEDIAN 2.0 /**< residu threshold if normalized median is used */
typedef struct __GpivLinRegData GpivLinRegData;
/*!
* \brief Data structure of linear regression data
*/
struct __GpivLinRegData {
double c0; /**< zero order constant */
double c1; /**< first order constant */
double cov00; /**< variance of zero order constant */
double cov01; /**< correlation bewteen first and 2nd const. */
double cov11; /**< variance of zero order constant */
double sumsq; /**< sum of squared residuals */
};
/**
* Calculates residu values (at the inner points) of a PIV data set
* and applies to snr member of returned GpivPivData
*
* @param[in] piv_data piv dataset
* @param[in] valid_par validation parameters
* @param[in] incl_point flag to include data point under investigation
* @return NULL on success or error message on failure
*/
gchar *
gpiv_valid_residu (GpivPivData *piv_data,
const GpivValidPar *valid_par,
const gboolean incl_point
);
/**
* Calculates cumulative histogram of residus and linear regression fit
* parameters
*
* @param[out] linreg linear regression data structure
* @param[in] piv_data piv dataset containing residu values in snr
* @param[in] nbins number of points to be used for regression
* @return GpivBinData containing cumulative histogram or
* NULL on failure
*/
GpivBinData *
gpiv_valid_residu_stats (const GpivPivData *piv_data,
const guint nbins,
GpivLinRegData *linreg
);
/**
* Piv data validation on peak-locking effects
*
* @param[in] piv_data input piv data
* @param[in] nbins number of bins that klass will contain
* @return GpivBinData on success or NULL on failure
*
*/
GpivBinData *
gpiv_valid_peaklck (const GpivPivData *piv_data,
const guint nbins
);
/**
* Piv data validation function on outliers
*
* @param[in] image struct of image containing parameters and frames
* @param[in] piv_par struct of piv image evaluation parameters
* @param[in] valid_par struct of validation parameters
* @param[in] piv_data piv data, will be corrected for outliers
* @param[in] interrogate_valid validation during (iterative) interrogation
* process
* @return NULL or error message on failure
*/
gchar *
gpiv_valid_errvec (GpivPivData *piv_data,
const GpivImage *image,
const GpivPivPar *piv_par,
const GpivValidPar *valid_par,
const gboolean interrogate_valid
);
/**
* Searches vectors in a PIV data set that exceed the maximum gradient
* (dUxdt/int_size > GPIV_GRADIENT_THRESHOLD)
*
* @param[in] piv_par struct of piv parameters
* @param[in] piv_data PIV data set
*
* @param[out] piv_data PIV data set containing peak_no = -1 for exceeded maxima
* @return void
*/
void
gpiv_valid_gradient (const GpivPivPar *piv_par,
GpivPivData *piv_data
);
/**
* Plots cumulative histogram with an equal number of data.
* per bin of klass on screen with gnuplot
*
* @param[in] fname_out output file name
* @param[in] title title of plot
* @param[in] GNUPLOT_DISPLAY_COLOR color of gnuplot display
* @param[in] GNUPLOT_DISPLAY_SIZE size of gnuplot display
* @param[in] linreg linear regression data
* @return void
*/
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
);
/**
* Calculates threshold value (residu_max) from residus.
* Will need int_size_f from the GpivPivPar struct
*
* @param[in] piv_par piv image evaluation parameters
* @param[in] valid_par validation parameters
* @param[in] linreg linear regression data
* @return threshold value
*/
gfloat
gpiv_valid_threshold (const GpivPivPar *piv_par,
const GpivValidPar *valid_par,
const GpivLinRegData *linreg
);
#endif /* __LIBGPIV_VALID_H__ */
|