__GpivPivData Struct Reference
Holds the variables of PIV data.
More...
#include <include/gpiv.h>
Data Fields |
guint | nx |
| number of data in x-direction
|
guint | ny |
| number of data in y-direction
|
guint | nz |
| number of data in z-direction (for future use)
|
gfloat ** | point_x |
| position of data point in x-direction
|
gfloat ** | point_y |
| position of data point in y-direction
|
gfloat ** | point_z |
| position of data point in z-direction (for future use)
|
gfloat ** | dx |
| particle image displacement in x-direction
|
gfloat ** | dy |
| particle image displacement in y-direction
|
gfloat ** | dz |
| particle image displacement in z-direction (for future use)
|
gfloat ** | snr |
| signal to noise ratio.
|
gint ** | peak_no |
| Nth-highest covariance peak number.
|
gfloat ** | scalar |
| scalar value that might represent vorticity , shear strain or normal strain, for example
|
guint | count |
| total number of valid estimators
|
gfloat | mean_dx |
| mean displacement in x-direction
|
gfloat | sdev_dx |
| rms displacement in x-direction
|
gfloat | min_dx |
| minimum displacement in x-direction
|
gfloat | max_dx |
| maximum displacement in x-direction
|
gfloat | mean_dy |
| mean displacement in y-direction
|
gfloat | sdev_dy |
| rms displacement in y-direction
|
gfloat | min_dy |
| minimum displacement in y-direction
|
gfloat | max_dy |
| maximum displacement in y-direction
|
gfloat | mean_dz |
| mean displacement in z-direction (for future use)
|
gfloat | sdev_dz |
| rms displacement in z-direction (for future use)
|
gfloat | min_dz |
| minimum displacement in z-direction (for future use)
|
gfloat | max_dz |
| maximum displacement in z-direction (for future use)
|
gboolean | scale |
| flag for scaled estimators
|
gboolean | scale__set |
| flag if scale has been defined
|
gchar * | comment |
| comment on the data
|
Detailed Description
Holds the variables of PIV data.
This structure is primarly intended for locations, (PIV) estimators (i.e. particle image displacements) and some stastistics, like mean, minimum, maximum and standard deviation or rms values. But might be used for any vectorial quantity. Quantities in z-direction have not yet been implemented by the library functions, though.
Definition at line 266 of file gpiv.h.
Field Documentation
comment on the data
Definition at line 311 of file gpiv.h.
total number of valid estimators
Definition at line 290 of file gpiv.h.
particle image displacement in x-direction
Definition at line 276 of file gpiv.h.
particle image displacement in y-direction
Definition at line 277 of file gpiv.h.
particle image displacement in z-direction (for future use)
Definition at line 278 of file gpiv.h.
maximum displacement in x-direction
Definition at line 295 of file gpiv.h.
maximum displacement in y-direction
Definition at line 300 of file gpiv.h.
maximum displacement in z-direction (for future use)
Definition at line 305 of file gpiv.h.
mean displacement in x-direction
Definition at line 292 of file gpiv.h.
mean displacement in y-direction
Definition at line 297 of file gpiv.h.
mean displacement in z-direction (for future use)
Definition at line 302 of file gpiv.h.
minimum displacement in x-direction
Definition at line 294 of file gpiv.h.
minimum displacement in y-direction
Definition at line 299 of file gpiv.h.
minimum displacement in z-direction (for future use)
Definition at line 304 of file gpiv.h.
number of data in x-direction
Definition at line 267 of file gpiv.h.
number of data in y-direction
Definition at line 268 of file gpiv.h.
number of data in z-direction (for future use)
Definition at line 269 of file gpiv.h.
Nth-highest covariance peak number.
Will mostly be 1 (first highest peak of covariance function. Set to 0 in case the estimator has been substituted during validation. If < 0 the data has been disabled.
Definition at line 285 of file gpiv.h.
position of data point in x-direction
Definition at line 272 of file gpiv.h.
position of data point in y-direction
Definition at line 273 of file gpiv.h.
position of data point in z-direction (for future use)
Definition at line 274 of file gpiv.h.
scalar value that might represent vorticity , shear strain or normal strain, for example
Definition at line 288 of file gpiv.h.
flag for scaled estimators
Definition at line 308 of file gpiv.h.
flag if scale has been defined
Definition at line 309 of file gpiv.h.
rms displacement in x-direction
Definition at line 293 of file gpiv.h.
rms displacement in y-direction
Definition at line 298 of file gpiv.h.
rms displacement in z-direction (for future use)
Definition at line 303 of file gpiv.h.
signal to noise ratio.
The value has been defined as the ratio between the first and second highest covariance peak, In case validation takes place (during iterative interrogation or during a validation step after image interrogation), the snr value is used as the residual value between actual and surrounding estimators
Definition at line 280 of file gpiv.h.
The documentation for this struct was generated from the following file: