Main Page | Files | Data Structures | Functions | Global Variables |

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


Field Documentation

number of data in x-direction

Definition at line 260 of file gpiv.h.

number of data in y-direction

Definition at line 261 of file gpiv.h.

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

Definition at line 262 of file gpiv.h.

position of data point in x-direction

Definition at line 265 of file gpiv.h.

position of data point in y-direction

Definition at line 266 of file gpiv.h.

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

Definition at line 267 of file gpiv.h.

particle image displacement in x-direction

Definition at line 269 of file gpiv.h.

particle image displacement in y-direction

Definition at line 270 of file gpiv.h.

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

Definition at line 271 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 273 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 278 of file gpiv.h.

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

Definition at line 281 of file gpiv.h.

total number of valid estimators

Definition at line 283 of file gpiv.h.

mean displacement in x-direction

Definition at line 285 of file gpiv.h.

rms displacement in x-direction

Definition at line 286 of file gpiv.h.

minimum displacement in x-direction

Definition at line 287 of file gpiv.h.

maximum displacement in x-direction

Definition at line 288 of file gpiv.h.

mean displacement in y-direction

Definition at line 290 of file gpiv.h.

rms displacement in y-direction

Definition at line 291 of file gpiv.h.

minimum displacement in y-direction

Definition at line 292 of file gpiv.h.

maximum displacement in y-direction

Definition at line 293 of file gpiv.h.

mean displacement in z-direction (for future use)

Definition at line 295 of file gpiv.h.

rms displacement in z-direction (for future use)

Definition at line 296 of file gpiv.h.

minimum displacement in z-direction (for future use)

Definition at line 297 of file gpiv.h.

maximum displacement in z-direction (for future use)

Definition at line 298 of file gpiv.h.

flag for scaled estimators

Definition at line 301 of file gpiv.h.

flag if scale has been defined

Definition at line 302 of file gpiv.h.

comment on the data

Definition at line 304 of file gpiv.h.


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

Generated on Tue Jul 15 21:08:50 2008 for Libgpiv by doxygen 1.5.6