Libpiv API documentation

 Search for 

__GpivValidPar Struct Reference

Piv validation parameters. More...

#include <gpiv-valid_par.h>

Data Fields
gfloat	data_yield
gfloat	residu_max
guint	neighbors
enum ResiduType	residu_type
enum SubstitutionType	subst_type
gint	histo_type
gboolean	data_yield__set
gboolean	residu_max__set
gboolean	neighbors__set
gboolean	residu_type__set
gboolean	subst_type__set
gboolean	histo_type__set

---

Detailed Description

Piv validation parameters.

The parameters might be loaded from the configuration resources, with gpiv_scan_resourcefiles() or with gpiv_scan_parameter().

Definition at line 101 of file gpiv-valid_par.h.

---

Field Documentation

gfloat __GpivValidPar::data_yield

data yield ( from particle image concentration, out-of plane flow, velocity gradient within interrogation area. ref: Keane and Adrian 1992)

Definition at line 102 of file gpiv-valid_par.h.

gfloat __GpivValidPar::residu_max

maximum residu value

Definition at line 105 of file gpiv-valid_par.h.

guint __GpivValidPar::neighbors

number of neighbouring estimators

Definition at line 106 of file gpiv-valid_par.h.

enum ResiduType __GpivValidPar::residu_type

use residu type

Definition at line 107 of file gpiv-valid_par.h.

enum SubstitutionType __GpivValidPar::subst_type

use substitution type

Definition at line 108 of file gpiv-valid_par.h.

gint __GpivValidPar::histo_type

use histogram type

Definition at line 109 of file gpiv-valid_par.h.

gboolean __GpivValidPar::data_yield__set

flag if data_yield has been defined

Definition at line 111 of file gpiv-valid_par.h.

gboolean __GpivValidPar::residu_max__set

flag if residu_max has been defined

Definition at line 112 of file gpiv-valid_par.h.

gboolean __GpivValidPar::neighbors__set

flag if neighbors has been defined

Definition at line 113 of file gpiv-valid_par.h.

gboolean __GpivValidPar::residu_type__set

flag if residu_type has been defined

Definition at line 114 of file gpiv-valid_par.h.

gboolean __GpivValidPar::subst_type__set

flag if subst_type has been defined

Definition at line 115 of file gpiv-valid_par.h.

gboolean __GpivValidPar::histo_type__set

flag if histo_type has been defined

Definition at line 116 of file gpiv-valid_par.h.

---

The documentation for this struct was generated from the following file:

• gpiv-valid_par.h

---