Main Page | Files | Data Structures | Functions | Global Variables |
__GpivPivData Struct Reference

Holds the variables of PIV data. More...

#include <include/gpiv.h>

Data Fields

guint nx
 number of data in x-direction More...
 
guint ny
 number of data in y-direction More...
 
guint nz
 number of data in z-direction (for future use) More...
 
gfloat ** point_x
 position of data point in x-direction More...
 
gfloat ** point_y
 position of data point in y-direction More...
 
gfloat ** point_z
 position of data point in z-direction (for future use) More...
 
gfloat ** dx
 particle image displacement in x-direction More...
 
gfloat ** dy
 particle image displacement in y-direction More...
 
gfloat ** dz
 particle image displacement in z-direction (for future use) More...
 
gfloat ** snr
 signal to noise ratio. More...
 
gint ** peak_no
 Nth-highest covariance peak number. More...
 
gfloat ** scalar
 scalar value that might represent vorticity , shear strain or normal strain, for example More...
 
guint count
 total number of valid estimators More...
 
gfloat mean_dx
 mean displacement in x-direction More...
 
gfloat sdev_dx
 rms displacement in x-direction More...
 
gfloat min_dx
 minimum displacement in x-direction More...
 
gfloat max_dx
 maximum displacement in x-direction More...
 
gfloat mean_dy
 mean displacement in y-direction More...
 
gfloat sdev_dy
 rms displacement in y-direction More...
 
gfloat min_dy
 minimum displacement in y-direction More...
 
gfloat max_dy
 maximum displacement in y-direction More...
 
gfloat mean_dz
 mean displacement in z-direction (for future use) More...
 
gfloat sdev_dz
 rms displacement in z-direction (for future use) More...
 
gfloat min_dz
 minimum displacement in z-direction (for future use) More...
 
gfloat max_dz
 maximum displacement in z-direction (for future use) More...
 
gboolean scale
 flag for scaled estimators More...
 
gboolean scale__set
 flag if scale has been defined More...
 
gchar * comment
 comment on the data More...
 

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 267 of file gpiv.h.

Field Documentation

◆ comment

gchar* __GpivPivData::comment

comment on the data

Definition at line 312 of file gpiv.h.

◆ count

guint __GpivPivData::count

total number of valid estimators

Definition at line 291 of file gpiv.h.

◆ dx

gfloat** __GpivPivData::dx

particle image displacement in x-direction

Definition at line 277 of file gpiv.h.

◆ dy

gfloat** __GpivPivData::dy

particle image displacement in y-direction

Definition at line 278 of file gpiv.h.

◆ dz

gfloat** __GpivPivData::dz

particle image displacement in z-direction (for future use)

Definition at line 279 of file gpiv.h.

◆ max_dx

gfloat __GpivPivData::max_dx

maximum displacement in x-direction

Definition at line 296 of file gpiv.h.

◆ max_dy

gfloat __GpivPivData::max_dy

maximum displacement in y-direction

Definition at line 301 of file gpiv.h.

◆ max_dz

gfloat __GpivPivData::max_dz

maximum displacement in z-direction (for future use)

Definition at line 306 of file gpiv.h.

◆ mean_dx

gfloat __GpivPivData::mean_dx

mean displacement in x-direction

Definition at line 293 of file gpiv.h.

◆ mean_dy

gfloat __GpivPivData::mean_dy

mean displacement in y-direction

Definition at line 298 of file gpiv.h.

◆ mean_dz

gfloat __GpivPivData::mean_dz

mean displacement in z-direction (for future use)

Definition at line 303 of file gpiv.h.

◆ min_dx

gfloat __GpivPivData::min_dx

minimum displacement in x-direction

Definition at line 295 of file gpiv.h.

◆ min_dy

gfloat __GpivPivData::min_dy

minimum displacement in y-direction

Definition at line 300 of file gpiv.h.

◆ min_dz

gfloat __GpivPivData::min_dz

minimum displacement in z-direction (for future use)

Definition at line 305 of file gpiv.h.

◆ nx

guint __GpivPivData::nx

number of data in x-direction

Definition at line 268 of file gpiv.h.

◆ ny

guint __GpivPivData::ny

number of data in y-direction

Definition at line 269 of file gpiv.h.

◆ nz

guint __GpivPivData::nz

number of data in z-direction (for future use)

Definition at line 270 of file gpiv.h.

◆ peak_no

gint** __GpivPivData::peak_no

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 286 of file gpiv.h.

◆ point_x

gfloat** __GpivPivData::point_x

position of data point in x-direction

Definition at line 273 of file gpiv.h.

◆ point_y

gfloat** __GpivPivData::point_y

position of data point in y-direction

Definition at line 274 of file gpiv.h.

◆ point_z

gfloat** __GpivPivData::point_z

position of data point in z-direction (for future use)

Definition at line 275 of file gpiv.h.

◆ scalar

gfloat** __GpivPivData::scalar

scalar value that might represent vorticity , shear strain or normal strain, for example

Definition at line 289 of file gpiv.h.

◆ scale

gboolean __GpivPivData::scale

flag for scaled estimators

Definition at line 309 of file gpiv.h.

◆ scale__set

gboolean __GpivPivData::scale__set

flag if scale has been defined

Definition at line 310 of file gpiv.h.

◆ sdev_dx

gfloat __GpivPivData::sdev_dx

rms displacement in x-direction

Definition at line 294 of file gpiv.h.

◆ sdev_dy

gfloat __GpivPivData::sdev_dy

rms displacement in y-direction

Definition at line 299 of file gpiv.h.

◆ sdev_dz

gfloat __GpivPivData::sdev_dz

rms displacement in z-direction (for future use)

Definition at line 304 of file gpiv.h.

◆ snr

gfloat** __GpivPivData::snr

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 281 of file gpiv.h.


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

Generated for libgpiv-0.6.1 by doxygen 1.8.13