module for parameters for validating PIV data
More...
Go to the source code of this file.
module for parameters for validating PIV data
SOURCES: lib/valid_par.c
LAST MODIFICATION DATE:
- Id
- gpiv-valid_par.h,v 1.3 2008-09-25 13:19:53 gerber Exp
Definition in file gpiv-valid_par.h.
◆ GPIV_VALIDPAR_KEY
#define GPIV_VALIDPAR_KEY "VALID" |
◆ GPIV_VALIDPAR_MAX__NEIGHBORS
#define GPIV_VALIDPAR_MAX__NEIGHBORS 9 |
Maximum numbers of adjacent neighbours for validation testing and and calculation of substitution.
Definition at line 63 of file gpiv-valid_par.h.
◆ GpivValidPar
◆ 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.
|
Definition at line 70 of file gpiv-valid_par.h.
◆ 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
|
Definition at line 86 of file gpiv-valid_par.h.
◆ gpiv_valid_check_parameters_read()
Checks out if all parameters have been read.
If a parameter has not been read, it will be set to valid_par_default or to its hard-coded default value in case valid_par_default is NULL.
- Parameters
-
[in] | valid_par_default | default validation parameters. If NULL, library default values are used. |
[in] | valid_par | validation parameters |
[out] | valid_par | validation parameters |
- Returns
- NULL on success or error message on failure
◆ gpiv_valid_cp_parameters()
Copies validation parameters.
- Parameters
-
[in] | valid_par | validation parameters to be copied |
- Returns
- GpivValidPar * or NULL on failure
◆ gpiv_valid_default_parameters()
void gpiv_valid_default_parameters |
( |
GpivValidPar * |
valid_par_default, |
|
|
const gboolean |
force |
|
) |
| |
Sets parameters to default values.
- Parameters
-
[in] | force | flag to enforce parameters set to defaults |
[out] | valid_par_default | struct of validation parameters |
- Returns
- void
◆ gpiv_valid_dupl_parameters()
Duplicates validation parameters from valid_par_src to valid_par_dest if valid_par_dest have not been set.
- Parameters
-
[in] | valid_par_src | source validation parameters to be copied |
[out] | valid_par_dest | the copied validation parameters |
- Returns
- void
◆ gpiv_valid_fread_hdf5_parameters()
GpivValidPar* gpiv_valid_fread_hdf5_parameters |
( |
const gchar * |
fname | ) |
|
Reads validation parameters from hdf5 data file.
- Parameters
-
[in] | fname | file name of data file |
- Returns
- GpivValidPar or NULL on failure
◆ gpiv_valid_fwrite_hdf5_parameters()
gchar* gpiv_valid_fwrite_hdf5_parameters |
( |
const gchar * |
fname, |
|
|
const GpivValidPar * |
valid_par |
|
) |
| |
Writes validation parameters to an existing hdf5 data file.
- Parameters
-
[in] | fname | file name of data file |
[in] | valid_par | struct of validation parameters |
- Returns
- NULL on success or error message on failure
◆ gpiv_valid_get_parameters_from_resources()
GpivValidPar* gpiv_valid_get_parameters_from_resources |
( |
const gchar * |
localrc, |
|
|
const gboolean |
verbose |
|
) |
| |
Reads validation parameters from system-wide gpiv.conf and $HOME/.gpivrc.
- Parameters
-
[in] | localrc | resource filename containing parameter at current directory |
[in] | verbose | prints parameter values when read |
- Returns
- GpivValidPar or NULL on failure
◆ gpiv_valid_parameters_set()
void gpiv_valid_parameters_set |
( |
GpivValidPar * |
valid_par, |
|
|
const gboolean |
flag |
|
) |
| |
Defines value of __set members of PivValidPar.
- Parameters
-
[in] | valid_par | validation parameters |
[in] | flag | boolean to define __set value |
[out] | valid_par | struct of validation parameters |
- Returns
- void
◆ gpiv_valid_print_parameters()
void gpiv_valid_print_parameters |
( |
FILE * |
fp, |
|
|
const GpivValidPar * |
valid_par |
|
) |
| |
Prints all validation parameters in ASCII format to fp.
- Parameters
-
[in] | fp | file pointer to printed file. If NULL, fp points to stdout. |
[in] | valid_par | validation parameters |
- Returns
- void
◆ gpiv_valid_read_parameters()
void gpiv_valid_read_parameters |
( |
FILE * |
fp_par, |
|
|
GpivValidPar * |
valid_par, |
|
|
const gboolean |
print_par |
|
) |
| |
Reads validation parameters from file.
- Parameters
-
[in] | fp_par | file pointer to file to be read. If NULL, stdin will be used. |
[in] | print_par | boolean to print parameters to stdout |
[out] | valid_par | validation parameters |
- Returns
- void
◆ gpiv_valid_testadjust_parameters()
gchar* gpiv_valid_testadjust_parameters |
( |
GpivValidPar * |
valid_par | ) |
|
Tests if all validation parameters have been read and have been defined to valid values.
Aplies missing parameters to defaults, as hard-coded in the library and adjusts parameters if necessary.
- Parameters
-
[in] | valid_par | validation parameters |
- Returns
- NULL on success or error message on failure
◆ gpiv_valid_testonly_parameters()
gchar* gpiv_valid_testonly_parameters |
( |
const GpivValidPar * |
valid_par | ) |
|
Tests if all validation parameters have been read and have been defined to valid values.
- Parameters
-
[in] | valid_par | validation parameters |
- Returns
- NULL on success or error message on failure