Libpiv API documentation

 Search for 

__GpivPivData Struct Reference

Holds the variables of PIV data. More...

#include <gpiv.h>

Data Fields
guint	nx
guint	ny
guint	nz
gfloat **	point_x
gfloat **	point_y
gfloat **	point_z
gfloat **	dx
gfloat **	dy
gfloat **	dz
gfloat **	snr
gint **	peak_no
gfloat **	scalar
guint	count
gfloat	mean_dx
gfloat	sdev_dx
gfloat	min_dx
gfloat	max_dx
gfloat	mean_dy
gfloat	sdev_dy
gfloat	min_dy
gfloat	max_dy
gfloat	mean_dz
gfloat	sdev_dz
gfloat	min_dz
gfloat	max_dz
gboolean	scale
gboolean	scale__set
gchar *	comment

---

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

---

Field Documentation

guint __GpivPivData::nx

number of data in x-direction

Definition at line 250 of file gpiv.h.

guint __GpivPivData::ny

number of data in y-direction

Definition at line 251 of file gpiv.h.

guint __GpivPivData::nz

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

Definition at line 252 of file gpiv.h.

gfloat** __GpivPivData::point_x

position of data point in x-direction

Definition at line 255 of file gpiv.h.

gfloat** __GpivPivData::point_y

position of data point in y-direction

Definition at line 256 of file gpiv.h.

gfloat** __GpivPivData::point_z

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

Definition at line 257 of file gpiv.h.

gfloat** __GpivPivData::dx

particle image displacement in x-direction

Definition at line 259 of file gpiv.h.

gfloat** __GpivPivData::dy

particle image displacement in y-direction

Definition at line 260 of file gpiv.h.

gfloat** __GpivPivData::dz

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

Definition at line 261 of file gpiv.h.

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

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

gfloat** __GpivPivData::scalar

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

Definition at line 271 of file gpiv.h.

guint __GpivPivData::count

total number of valid estimators

Definition at line 273 of file gpiv.h.

gfloat __GpivPivData::mean_dx

mean displacement in x-direction

Definition at line 275 of file gpiv.h.

gfloat __GpivPivData::sdev_dx

rms displacement in x-direction

Definition at line 276 of file gpiv.h.

gfloat __GpivPivData::min_dx

minimum displacement in x-direction

Definition at line 277 of file gpiv.h.

gfloat __GpivPivData::max_dx

maximum displacement in x-direction

Definition at line 278 of file gpiv.h.

gfloat __GpivPivData::mean_dy

mean displacement in y-direction

Definition at line 280 of file gpiv.h.

gfloat __GpivPivData::sdev_dy

rms displacement in y-direction

Definition at line 281 of file gpiv.h.

gfloat __GpivPivData::min_dy

minimum displacement in y-direction

Definition at line 282 of file gpiv.h.

gfloat __GpivPivData::max_dy

maximum displacement in y-direction

Definition at line 283 of file gpiv.h.

gfloat __GpivPivData::mean_dz

mean displacement in z-direction (for future use)

Definition at line 285 of file gpiv.h.

gfloat __GpivPivData::sdev_dz

rms displacement in z-direction (for future use)

Definition at line 286 of file gpiv.h.

gfloat __GpivPivData::min_dz

minimum displacement in z-direction (for future use)

Definition at line 287 of file gpiv.h.

gfloat __GpivPivData::max_dz

maximum displacement in z-direction (for future use)

Definition at line 288 of file gpiv.h.

gboolean __GpivPivData::scale

flag for scaled estimators

Definition at line 291 of file gpiv.h.

gboolean __GpivPivData::scale__set

flag if scale has been defined

Definition at line 292 of file gpiv.h.

gchar* __GpivPivData::comment

comment on the data

Definition at line 294 of file gpiv.h.

---

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

• gpiv.h

---