Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-valid.h File Reference

module for validating PIV data More...

Include dependency graph for gpiv-valid.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  __GpivLinRegData
 Data structure of linear regression data. More...
 

Macros

#define GPIV_GRADIENT_THRESHOLD   2.0
 Default threshold of displacement gradient. More...
 
#define GPIV_THRESHOLD_DEFAULT   1.2
 Default residu threshold. More...
 
#define GPIV_VALID_MAX_SWEEP   9
 maximum number of validation sweeps, starting from zero More...
 
#define GPIV_RESIDU_MAX_NORMMEDIAN   2.0
 residu threshold if normalized median is used More...
 

Typedefs

typedef struct __GpivLinRegData GpivLinRegData
 

Functions

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 returned GpivPivData. More...
 
GpivBinDatagpiv_valid_residu_stats (const GpivPivData *piv_data, const guint nbins, GpivLinRegData *linreg)
 Calculates cumulative histogram of residus and linear regression fit parameters. More...
 
GpivBinDatagpiv_valid_peaklck (const GpivPivData *piv_data, const guint nbins)
 Piv data validation on peak-locking effects. More...
 
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. More...
 
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_THRESHOLD) More...
 
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. More...
 
gfloat gpiv_valid_threshold (const GpivPivPar *piv_par, const GpivValidPar *valid_par, const GpivLinRegData *linreg)
 Calculates threshold value (residu_max) from residus. More...
 

Detailed Description

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

Definition in file gpiv-valid.h.

Macro Definition Documentation

◆ GPIV_GRADIENT_THRESHOLD

#define GPIV_GRADIENT_THRESHOLD   2.0

Default threshold of displacement gradient.

Definition at line 65 of file gpiv-valid.h.

◆ GPIV_RESIDU_MAX_NORMMEDIAN

#define GPIV_RESIDU_MAX_NORMMEDIAN   2.0

residu threshold if normalized median is used

Definition at line 68 of file gpiv-valid.h.

◆ GPIV_THRESHOLD_DEFAULT

#define GPIV_THRESHOLD_DEFAULT   1.2

Default residu threshold.

Definition at line 66 of file gpiv-valid.h.

◆ GPIV_VALID_MAX_SWEEP

#define GPIV_VALID_MAX_SWEEP   9

maximum number of validation sweeps, starting from zero

Definition at line 67 of file gpiv-valid.h.

Typedef Documentation

◆ GpivLinRegData

Definition at line 73 of file gpiv-valid.h.

Function Documentation

◆ gpiv_cumhisto_eqdatbin_gnuplot()

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.

per bin of klass on screen with gnuplot

Parameters
[in]fname_outoutput file name
[in]titletitle of plot
[in]GNUPLOT_DISPLAY_COLORcolor of gnuplot display
[in]GNUPLOT_DISPLAY_SIZEsize of gnuplot display
[in]linreglinear regression data
Returns
void

◆ gpiv_valid_errvec()

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.

Parameters
[in]imagestruct of image containing parameters and frames
[in]piv_parstruct of piv image evaluation parameters
[in]valid_parstruct of validation parameters
[in]piv_datapiv data, will be corrected for outliers
[in]interrogate_validvalidation during (iterative) interrogation process
Returns
NULL or error message on failure

◆ gpiv_valid_gradient()

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_THRESHOLD)

Parameters
[in]piv_parstruct of piv parameters
[in]piv_dataPIV data set
[out]piv_dataPIV data set containing peak_no = -1 for exceeded maxima
Returns
void

◆ gpiv_valid_peaklck()

GpivBinData* gpiv_valid_peaklck ( const GpivPivData piv_data,
const guint  nbins 
)

Piv data validation on peak-locking effects.

Parameters
[in]piv_datainput piv data
[in]nbinsnumber of bins that klass will contain
Returns
GpivBinData on success or NULL on failure

◆ gpiv_valid_residu()

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 returned GpivPivData.

Parameters
[in]piv_datapiv dataset
[in]valid_parvalidation parameters
[in]incl_pointflag to include data point under investigation
Returns
NULL on success or error message on failure

◆ gpiv_valid_residu_stats()

GpivBinData* gpiv_valid_residu_stats ( const GpivPivData piv_data,
const guint  nbins,
GpivLinRegData linreg 
)

Calculates cumulative histogram of residus and linear regression fit parameters.

Parameters
[out]linreglinear regression data structure
[in]piv_datapiv dataset containing residu values in snr
[in]nbinsnumber of points to be used for regression
Returns
GpivBinData containing cumulative histogram or NULL on failure

◆ gpiv_valid_threshold()

gfloat gpiv_valid_threshold ( const GpivPivPar piv_par,
const GpivValidPar valid_par,
const GpivLinRegData linreg 
)

Calculates threshold value (residu_max) from residus.

Will need int_size_f from the GpivPivPar struct

Parameters
[in]piv_parpiv image evaluation parameters
[in]valid_parvalidation parameters
[in]linreglinear regression data
Returns
threshold value

Generated for libgpiv-0.6.1 by doxygen 1.8.13