Main Page | Files | Data Structures | Functions | Global Variables | Deprecated list

/home/gerber/gpiv_all/libgpiv-0.4.0/include/gpiv/valid.h File Reference

module for validating PIV data More...


Data Structures

struct  __GpivLinRegData
struct  __GpivValidPar

Defines

#define GPIV_GRADIENT_THRESHOLD   2.0
#define GPIV_THRESHOLD_DEFAULT   1.2
#define GPIV_VALID_MAX_SWEEP   9
#define GPIV_RESIDU_MAX_NORMMEDIAN   2.0
#define GPIV_VALIDPAR_DEFAULT__AUTO_THRESH   0
#define GPIV_VALIDPAR_DEFAULT__DATA_YIELD   0.95
#define GPIV_VALIDPAR_DEFAULT__RESIDU_MAX   2.0
#define GPIV_VALIDPAR_DEFAULT__RES_STATS   0
#define GPIV_VALIDPAR_DEFAULT__RESIDU_TYPE   2
#define GPIV_VALIDPAR_DEFAULT__SUBST_TYPE   2
#define GPIV_VALIDPAR_DEFAULT__HISTO_TYPE   0
#define GPIV_VALIDPAR_DEFAULT__ARRAY_LENGTH   3
#define GPIV_VALIDPAR_DEFAULT__NEIGHBORS   3
#define GPIV_VALIDPAR_MAX__NEIGHBORS   9

Enumerations

enum  ResiduType { GPIV_VALID_RESIDUTYPE__SNR, GPIV_VALID_RESIDUTYPE__MEDIAN, GPIV_VALID_RESIDUTYPE__NORMMEDIAN }
enum  SubstitutionType { GPIV_VALID_SUBSTYPE__NONE, GPIV_VALID_SUBSTYPE__L_MEAN, GPIV_VALID_SUBSTYPE__MEDIAN, GPIV_VALID_SUBSTYPE__COR_PEAK }

Functions

void gpiv_valid_parameters_logic (GpivValidPar *piv_valid_par, gboolean flag)
void gpiv_valid_default_parameters (GpivValidPar *piv_valid_par_default, gboolean force)
void gpiv_valid_read_parameters (FILE *fp_par, GpivValidPar *piv_valid_par, gboolean print_par)
char * gpiv_valid_check_parameters_read (GpivValidPar *piv_valid_par, GpivValidPar piv_valid_par_default)
void gpiv_valid_test_parameter (GpivValidPar *piv_valid_par)
void gpiv_valid_fprint_parameters (FILE *fp, GpivValidPar piv_valid_par)
char * gpiv_valid_fread_hdf5_parameters (char *fname, GpivValidPar *piv_valid_par)
char * gpiv_valid_fwrite_hdf5_parameters (char *fname, GpivValidPar *piv_valid_par)
void gpiv_valid_residu (GpivPivData in_data, GpivPivData *out_data, GpivValidPar piv_valid_par, gboolean incl_point)
char * gpiv_valid_residu_stats (GpivLinRegData *linreg, GpivPivData *out_data, GpivBinData *klass)
void gpiv_valid_peaklck (GpivPivData in_data, GpivBinData *klass)
char * gpiv_valid_errvec (GpivImagePar image_par, GpivEvalPar piv_eval_par, GpivValidPar piv_valid_par, GpivPivData in_data, GpivPivData *out_data, GpivBinData *klass, GpivLinRegData *linreg, guint16 **img1, guint16 **img2, gboolean interrogate_valid)
void gpiv_valid_gradient (GpivValidPar piv_valid_par, GpivEvalPar piv_eval_par, GpivPivData *piv_data)
void gpiv_cumhisto_eqdatbin_gnuplot (char *fname_out, char *title, const char *GNUPLOT_DISPLAY_COLOR, const int GNUPLOT_DISPLAY_SIZE, GpivLinRegData *linreg)
float gpiv_valid_threshold (GpivEvalPar piv_eval_par, GpivValidPar piv_valid_par, GpivLinRegData linreg)

Detailed Description

module for validating PIV data

SOURCES: lib/valid.c, lib/valid_par.c

LAST MODIFICATION DATE:

Id
valid.h,v 1.19 2007-01-29 11:53:54 gerber Exp

Define Documentation

#define GPIV_GRADIENT_THRESHOLD   2.0

Default threshold of displacement gradient

#define GPIV_RESIDU_MAX_NORMMEDIAN   2.0

residu threshold if normalized median is used

#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_VALIDPAR_DEFAULT__ARRAY_LENGTH   3

Default parameter for array_length of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__AUTO_THRESH   0

Default parameter for auto_thresh of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__DATA_YIELD   0.95

Default parameter for data_yield of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__HISTO_TYPE   0

default parameter for histo_type of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__NEIGHBORS   3

Default parameter for neighbors of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__RES_STATS   0

Default parameter for res_stats of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__RESIDU_MAX   2.0

Default parameter for residu_max of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__RESIDU_TYPE   2

Default parameter for residu_type of __GpivValidPar

#define GPIV_VALIDPAR_DEFAULT__SUBST_TYPE   2

Default parameter for subst_type of __GpivValidPar

#define GPIV_VALIDPAR_MAX__NEIGHBORS   9

Maximum numbers of adjacent neighbours for validation testing and and calculation of substitution

Enumeration Type Documentation

enum ResiduType

Type of residu to detect outliers

Enumerator:
GPIV_VALID_RESIDUTYPE__SNR  Signal to noise ratio
GPIV_VALID_RESIDUTYPE__MEDIAN  median value of NxN surrounding estimators
GPIV_VALID_RESIDUTYPE__NORMMEDIAN  normalized median, obtained from the ratio between datapoint under investigation and median velocity (from 3x3 array, excluding current point) and median residu. Ref. Westerweel, Scarano, Exp. in Fluids, 39 (2005), pp1096-1100.

enum SubstitutionType

Erroneous vector substituted by type

Enumerator:
GPIV_VALID_SUBSTYPE__NONE  no value, point will be disabled by setting __GpivPivData peak_nr to -1
GPIV_VALID_SUBSTYPE__L_MEAN  substitute by local mean value
GPIV_VALID_SUBSTYPE__MEDIAN  substitute by median value from surroundings
GPIV_VALID_SUBSTYPE__COR_PEAK  use location of next highest correlation peak as estimator

Function Documentation

void gpiv_cumhisto_eqdatbin_gnuplot ( char *  fname_out,
char *  title,
const char *  GNUPLOT_DISPLAY_COLOR,
const int  GNUPLOT_DISPLAY_SIZE,
GpivLinRegData *  linreg 
)

Plots cumulative histogram with an equal number of date per bin of klass on screen with gnuplot

Parameters:
[in] fname_out output file name
[in] title title of plot
[in] GNUPLOT_DISPLAY_COLOR color of gnuplot display
[in] GNUPLOT_DISPLAY_SIZE size of gnuplot display
[in] linreg linear regression data
Returns:
void

char* gpiv_valid_check_parameters_read ( GpivValidPar *  piv_valid_par,
GpivValidPar  piv_valid_par_default 
)

Checks out if all parameters have been read

Parameters:
[in] piv_valid_par struct of validation parameters
[in] piv_valid_par_default struct of validation parameters
[out] piv_valid_par struct of validation parameters
Returns:
NULL on success or *err_msg on failure

void gpiv_valid_default_parameters ( GpivValidPar *  piv_valid_par_default,
gboolean  force 
)

Sets parameters to default values

Parameters:
[in] force flag to enforce parameters set to defaults
[out] piv_valid_par_default struct of validation parameters
Returns:
void

char* gpiv_valid_errvec ( GpivImagePar  image_par,
GpivEvalPar  piv_eval_par,
GpivValidPar  piv_valid_par,
GpivPivData  in_data,
GpivPivData *  out_data,
GpivBinData *  klass,
GpivLinRegData *  linreg,
guint16 **  img1,
guint16 **  img2,
gboolean  interrogate_valid 
)

Piv data validation function on outliers

Parameters:
[in] image_par struct of image parameters
[in] piv_eval_par struct of piv image evaluation parameters
[in] piv_valid_par struct of validation parameters
[in] in_data input piv data
[in] klass histogram data
[in] linreg linear regression data
[in] img1 first image of PIV image pair
[in] img2 second image of PIV image pair
[in] interrogate_valid validation during (iterative) interrogation process
[out] out_data output piv data
Returns:
NULL on success or *err_msg on failure

void gpiv_valid_fprint_parameters ( FILE *  fp,
GpivValidPar  piv_valid_par 
)

Prints all validation parameters to fp ASCII file

Parameters:
[in] fp file pointer to printed file
[in] piv_valid_par struct of validation parameters
Returns:
void

char* gpiv_valid_fread_hdf5_parameters ( char *  fname,
GpivValidPar *  piv_valid_par 
)

Reads validation parameters from hdf5 data file

Parameters:
[in] fname file name of data file
[out] piv_valid_par struct of validation parameters
Returns:
NULL on success or *err_msg on failure

char* gpiv_valid_fwrite_hdf5_parameters ( char *  fname,
GpivValidPar *  piv_valid_par 
)

Writes validation parameters to an existing hdf5 data file

Parameters:
[in] fname file name of data file
[in] piv_valid_par struct of validation parameters
Returns:
NULL on success or *err_msg on failure

void gpiv_valid_gradient ( GpivValidPar  piv_valid_par,
GpivEvalPar  piv_eval_par,
GpivPivData *  piv_data 
)

Searches vectors in a PIV data set that exceed the maximum gradient (dUxdt/int_size > 0.05)

Parameters:
[in] piv_valid_par struct of validation parameters
[in] piv_eval_par struct of piv image evaluation parameters
[in] piv_data PIV data struct
[out] piv_data PIV dataset containing peak_no = -1 for exceeded maxima
Returns:
void

void gpiv_valid_parameters_logic ( GpivValidPar *  piv_valid_par,
gboolean  flag 
)

Sets flag for piv_valid_par_logic

Parameters:
[in] piv_valid_par struct of validation parameters
[in] flag boolean to define parameter flag
[out] piv_valid_par struct of validation parameters
Returns:
void

void gpiv_valid_peaklck ( GpivPivData  in_data,
GpivBinData *  klass 
)

Piv data evaluation function on peak-locking effects

Parameters:
[in] in_data input piv data
[in] klass struct containing number of bins for histogram
Returns:
void

void gpiv_valid_read_parameters ( FILE *  fp_par,
GpivValidPar *  piv_valid_par,
gboolean  print_par 
)

Reads validation parameters from file

Parameters:
[in] fp_par file pointer to file to be read
[in] print_par boolean to print parameters to stdout
[out] piv_valid_par struct of validation parameters
Returns:
void

void gpiv_valid_residu ( GpivPivData  in_data,
GpivPivData *  out_data,
GpivValidPar  piv_valid_par,
gboolean  incl_point 
)

Calculates residu values and apply to snr member of out_data structure

PROTOTYPE LOCATATION valid.h

Parameters:
[in] in_data piv dataset
[in] piv_valid_par validation parameters
[in] incl_point flag to include data point under investigation
[out] out_data piv dataset containing residu values in snr
Returns:
void

char* gpiv_valid_residu_stats ( GpivLinRegData *  linreg,
GpivPivData *  out_data,
GpivBinData *  klass 
)

Calculates cumulative histogram of residus

Parameters:
[in] linreg linear regression data structure
[in] klass histogram data
[out] out_data piv dataset containing residu values in snr
Returns:
void

void gpiv_valid_test_parameter ( GpivValidPar *  piv_valid_par  ) 

Tests if all validation parameters have been loaded

Parameters:
[in] piv_valid_par struct of validation parameters
Returns:
void

float gpiv_valid_threshold ( GpivEvalPar  piv_eval_par,
GpivValidPar  piv_valid_par,
GpivLinRegData  linreg 
)

Calculates threshold value (residu_max) from residus. Will need int_size_1 from the GpivEvalPar struct

Parameters:
[in] piv_eval_par struct of piv image evaluation parameters
[in] piv_valid_par struct of validation parameters
[in] linreg linear regression data
Returns:
threshold value

Generated on Sat Mar 31 19:30:54 2007 by  doxygen 1.5.1