Lib Gpiv API documentation
Go to the documentation of this file.
58 #ifndef __LIBGPIV_VALIDPAR_H__
59 #define __LIBGPIV_VALIDPAR_H__
62 #define GPIV_VALIDPAR_KEY "VALID"
63 #define GPIV_VALIDPAR_MAX__NEIGHBORS 9
161 const gboolean verbose
178 const gboolean print_par
gchar * gpiv_valid_testonly_parameters(const GpivValidPar *valid_par)
Tests if all validation parameters have been read and have been defined to valid values.
gint histo_type
use histogram type
guint neighbors
number of neighbouring estimators
gboolean residu_type__set
flag if residu_type has been defined
gboolean neighbors__set
flag if neighbors has been defined
@ GPIV_VALID_RESIDUTYPE__MEDIAN
median value of NxN surrounding estimators
GpivValidPar * gpiv_valid_cp_parameters(const GpivValidPar *valid_par)
Copies 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.
@ GPIV_VALID_SUBSTYPE__NONE
no value, point will be disabled by setting __GpivPivData peak_nr to -1
gfloat data_yield
data yield ( from particle image concentration, out-of plane flow, velocity gradient within interroga...
gchar * gpiv_valid_fwrite_hdf5_parameters(const gchar *fname, const GpivValidPar *valid_par)
Writes validation parameters to an existing hdf5 data file.
ResiduType
Type of residu to detect outliers.
@ GPIV_VALID_SUBSTYPE__MEDIAN
substitute by median value from surroundings
void gpiv_valid_read_parameters(FILE *fp_par, GpivValidPar *valid_par, const gboolean print_par)
Reads validation parameters from file.
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.
gboolean subst_type__set
flag if subst_type has been defined
Piv validation parameters.
@ GPIV_VALID_RESIDUTYPE__SNR
Signal to noise ratio.
@ GPIV_VALID_SUBSTYPE__COR_PEAK
use location of next highest correlation peak as estimator
enum ResiduType residu_type
use residu type
enum SubstitutionType subst_type
use substitution type
gboolean residu_max__set
flag if residu_max has been defined
void gpiv_valid_parameters_set(GpivValidPar *valid_par, const gboolean flag)
Defines value of __set members of PivValidPar.
gboolean histo_type__set
flag if histo_type has been defined
GpivValidPar * gpiv_valid_fread_hdf5_parameters(const gchar *fname)
Reads validation parameters from hdf5 data file.
SubstitutionType
Erroneous vector substituted by type.
@ GPIV_VALID_SUBSTYPE__L_MEAN
substitute by local mean value
gchar * gpiv_valid_check_parameters_read(GpivValidPar *valid_par, const GpivValidPar *valid_par_default)
Checks out if all parameters have been read.
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...
gboolean data_yield__set
flag if data_yield has been defined
void gpiv_valid_print_parameters(FILE *fp, const GpivValidPar *valid_par)
Prints all validation parameters in ASCII format to fp.
@ GPIV_VALID_RESIDUTYPE__NORMMEDIAN
normalized median, obtained from the ratio between datapoint under investigation and median velocity ...
gfloat residu_max
maximum residu value
Generated for libgpiv-0.6.1 by
1.8.17