module for parameters for validating PIV data More...
Go to the source code of this file.
Data Structures | |
struct | __GpivValidPar |
Piv validation parameters. More... | |
Defines | |
#define | GPIV_VALIDPAR_KEY "VALID" |
Key of validation processing parameters. | |
#define | GPIV_VALIDPAR_MAX__NEIGHBORS 9 |
Maximum numbers of adjacent neighbours for validation testing and and calculation of substitution. | |
Typedefs | |
typedef struct __GpivValidPar | GpivValidPar |
Enumerations | |
enum | ResiduType { GPIV_VALID_RESIDUTYPE__SNR, GPIV_VALID_RESIDUTYPE__MEDIAN, GPIV_VALID_RESIDUTYPE__NORMMEDIAN } |
Type of residu to detect outliers. More... | |
enum | SubstitutionType { GPIV_VALID_SUBSTYPE__NONE, GPIV_VALID_SUBSTYPE__L_MEAN, GPIV_VALID_SUBSTYPE__MEDIAN, GPIV_VALID_SUBSTYPE__COR_PEAK } |
Erroneous vector substituted by type. More... | |
Functions | |
void | gpiv_valid_parameters_set (GpivValidPar *valid_par, const gboolean flag) |
Defines value of __set members of PivValidPar. | |
void | gpiv_valid_default_parameters (GpivValidPar *valid_par_default, const gboolean force) |
Sets parameters to default values. | |
GpivValidPar * | gpiv_valid_get_parameters_from_resources (const gchar *localrc, const gboolean verbose) |
Reads validation parameters from system-wide gpiv.conf and $HOME/.gpivrc. | |
void | gpiv_valid_read_parameters (FILE *fp_par, GpivValidPar *valid_par, const gboolean print_par) |
Reads validation parameters from file. | |
gchar * | gpiv_valid_check_parameters_read (GpivValidPar *valid_par, const GpivValidPar *valid_par_default) |
Checks out if all parameters have been read. | |
gchar * | gpiv_valid_testonly_parameters (const GpivValidPar *valid_par) |
Tests if all validation parameters have been read and have been defined to valid values. | |
gchar * | gpiv_valid_testadjust_parameters (GpivValidPar *valid_par) |
Tests if all validation parameters have been read and have been defined to valid values. | |
void | gpiv_valid_print_parameters (FILE *fp, const GpivValidPar *valid_par) |
Prints all validation parameters in ASCII format to fp. | |
GpivValidPar * | gpiv_valid_cp_parameters (const GpivValidPar *valid_par) |
Copies validation parameters. | |
void | gpiv_valid_dupl_parameters (const GpivValidPar *valid_par_src, GpivValidPar *valid_par_dest) |
Duplicates validation parameters from valid_par_src to valid_par_dest if valid_par_dest have not been set. | |
GpivValidPar * | gpiv_valid_fread_hdf5_parameters (const gchar *fname) |
Reads validation parameters from hdf5 data file. | |
gchar * | gpiv_valid_fwrite_hdf5_parameters (const gchar *fname, const GpivValidPar *valid_par) |
Writes validation parameters to an existing hdf5 data file. |
module for parameters for validating PIV data
SOURCES: lib/valid_par.c
LAST MODIFICATION DATE:
Definition in file gpiv-valid_par.h.
#define GPIV_VALIDPAR_KEY "VALID" |
Key of validation processing parameters.
Definition at line 62 of file gpiv-valid_par.h.
#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.
typedef struct __GpivValidPar GpivValidPar |
Definition at line 95 of file gpiv-valid_par.h.
enum ResiduType |
Type of residu to detect outliers.
Definition at line 70 of file gpiv-valid_par.h.
enum SubstitutionType |
Erroneous vector substituted by type.
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.
gchar* gpiv_valid_check_parameters_read | ( | GpivValidPar * | valid_par, |
const GpivValidPar * | valid_par_default | ||
) |
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.
[in] | valid_par_default | default validation parameters. If NULL, library default values are used. |
[in] | valid_par | validation parameters |
[out] | valid_par | validation parameters |
GpivValidPar* gpiv_valid_cp_parameters | ( | const GpivValidPar * | valid_par | ) |
Copies validation parameters.
[in] | valid_par | validation parameters to be copied |
void gpiv_valid_default_parameters | ( | GpivValidPar * | valid_par_default, |
const gboolean | force | ||
) |
Sets parameters to default values.
[in] | force | flag to enforce parameters set to defaults |
[out] | valid_par_default | struct of validation parameters |
void gpiv_valid_dupl_parameters | ( | const GpivValidPar * | valid_par_src, |
GpivValidPar * | valid_par_dest | ||
) |
Duplicates validation parameters from valid_par_src to valid_par_dest if valid_par_dest have not been set.
[in] | valid_par_src | source validation parameters to be copied |
[out] | valid_par_dest | the copied validation parameters |
GpivValidPar* gpiv_valid_fread_hdf5_parameters | ( | const gchar * | fname | ) |
Reads validation parameters from hdf5 data file.
[in] | fname | file name of data file |
gchar* gpiv_valid_fwrite_hdf5_parameters | ( | const gchar * | fname, |
const GpivValidPar * | valid_par | ||
) |
Writes validation parameters to an existing hdf5 data file.
[in] | fname | file name of data file |
[in] | valid_par | struct of validation parameters |
GpivValidPar* gpiv_valid_get_parameters_from_resources | ( | const gchar * | localrc, |
const gboolean | verbose | ||
) |
Reads validation parameters from system-wide gpiv.conf and $HOME/.gpivrc.
[in] | localrc | resource filename containing parameter at current directory |
[in] | verbose | prints parameter values when read |
void gpiv_valid_parameters_set | ( | GpivValidPar * | valid_par, |
const gboolean | flag | ||
) |
Defines value of __set members of PivValidPar.
[in] | valid_par | validation parameters |
[in] | flag | boolean to define __set value |
[out] | valid_par | struct of validation parameters |
void gpiv_valid_print_parameters | ( | FILE * | fp, |
const GpivValidPar * | valid_par | ||
) |
Prints all validation parameters in ASCII format to fp.
[in] | fp | file pointer to printed file. If NULL, fp points to stdout. |
[in] | valid_par | validation parameters |
void gpiv_valid_read_parameters | ( | FILE * | fp_par, |
GpivValidPar * | valid_par, | ||
const gboolean | print_par | ||
) |
Reads validation parameters from file.
[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 |
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.
[in] | valid_par | validation 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.
[in] | valid_par | validation parameters |