Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-piv_utils.h File Reference

utilities module for GpivPivData structure More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void gpiv_null_pivdata (GpivPivData *piv_data)
 Sets all elements of piv_data structure to NULL. More...
 
GpivPivDatagpiv_alloc_pivdata (const guint nx, const guint ny)
 Allocates memory for GpivPivData. More...
 
gchar * gpiv_check_alloc_pivdata (const GpivPivData *piv_data)
 Checks if piv_data have been allocated. More...
 
void gpiv_free_pivdata (GpivPivData *piv_data)
 Frees memory for GpivPivData. More...
 
gchar * gpiv_0_pivdata (const GpivPivData *piv_data)
 Sets estimators, snr and peak_nr of piv_data to 0 or 0.0. More...
 
GpivPivDatagpiv_cp_pivdata (const GpivPivData *piv_data)
 Returns a copy of piv_data. More...
 
gchar * gpiv_ovwrt_pivdata (const GpivPivData *piv_data_in, const GpivPivData *piv_data_out)
 Overwrites piv_data_out with piv_data_in. More...
 
gchar * gpiv_add_dxdy_pivdata (const GpivPivData *piv_data_in, GpivPivData *piv_data_out)
 Adds displacements (dx, dy), snr and peak_nr from piv_data_in to piv_data_out. More...
 
gchar * gpiv_sum_dxdy_pivdata (const GpivPivData *piv_data, gfloat *sum)
 Adds all displacements in order to calculate residuals The structure will have to be allocated before (with gpiv_alloc_pivdata). More...
 
gchar * gpiv_piv_gnuplot (const gchar *title, const gfloat gnuplot_scale, const gchar *GNUPLOT_DISPLAY_COLOR, const guint GNUPLOT_DISPLAY_SIZE, const GpivImagePar *image_par, const GpivPivPar *piv_par, const GpivPivData *piv_data)
 Plots piv data as vectors on screen with gnuplot. More...
 
GpivCovgpiv_alloc_cov (const guint int_size0, const gboolean x_corr)
 Allocates memory for GpivCov. More...
 
void gpiv_free_cov (GpivCov *cov)
 Frees memory for GpivCov. More...
 

Detailed Description

utilities module for GpivPivData structure

SOURCES: lib/piv_utils.c

LAST MODIFICATION DATE:

Id
gpiv-piv_utils.h,v 1.2 2008-09-25 13:19:53 gerber Exp

Definition in file gpiv-piv_utils.h.

Function Documentation

◆ gpiv_0_pivdata()

gchar* gpiv_0_pivdata ( const GpivPivData piv_data)

Sets estimators, snr and peak_nr of piv_data to 0 or 0.0.

The structure will have to be allocated before (with gpiv_alloc_pivdata).

Parameters
[in]piv_dataPIV data
Returns
NULL on success or error message on failure

◆ gpiv_add_dxdy_pivdata()

gchar* gpiv_add_dxdy_pivdata ( const GpivPivData piv_data_in,
GpivPivData piv_data_out 
)

Adds displacements (dx, dy), snr and peak_nr from piv_data_in to piv_data_out.

Both structures will have to be allocated before (with gpiv_alloc_pivdata).

Parameters
[in]piv_data_inInput PIV data structure
[out]piv_data_outOutput PIV data structure
Returns
NULL on success or error message on failure

◆ gpiv_alloc_cov()

GpivCov* gpiv_alloc_cov ( const guint  int_size0,
const gboolean  x_corr 
)

Allocates memory for GpivCov.

Parameters
[in]int_size0size of zere-padded interrogation area
[in]x_corrtwo frame image / cross correlation
Returns
covariance on success or NULL on failure

◆ gpiv_alloc_pivdata()

GpivPivData* gpiv_alloc_pivdata ( const guint  nx,
const guint  ny 
)

Allocates memory for GpivPivData.

Parameters
[in]nxnumber of nx (column-wise data dimension)
[in]nynumber of ny (row-wise data dimension)
Returns
piv_data on success or NULL on failure

◆ gpiv_check_alloc_pivdata()

gchar* gpiv_check_alloc_pivdata ( const GpivPivData piv_data)

Checks if piv_data have been allocated.

Parameters
[in]piv_dataPIV data set to be checked if allocated
Returns
NULL on success or error message on failure

◆ gpiv_cp_pivdata()

GpivPivData* gpiv_cp_pivdata ( const GpivPivData piv_data)

Returns a copy of piv_data.

Piv_data_in will have to be allocated with gpiv_alloc_pivdata and the returned datawill have to be freed with gpiv_free_pivdata.

Parameters
[in]piv_dataInput PIV data
Returns
GpivPivData on success or NULL on failure

◆ gpiv_free_cov()

void gpiv_free_cov ( GpivCov cov)

Frees memory for GpivCov.

Parameters
[in]covCovariance structure
Returns
void

◆ gpiv_free_pivdata()

void gpiv_free_pivdata ( GpivPivData piv_data)

Frees memory for GpivPivData.

Parameters
[in]piv_dataPIV data structure
[out]piv_dataNULL pointer to point_x, point_y, dx, dy, snr and peak_no
Returns
void

◆ gpiv_null_pivdata()

void gpiv_null_pivdata ( GpivPivData piv_data)

Sets all elements of piv_data structure to NULL.

Parameters
[in]piv_dataInput PIV data structure
[out]piv_dataOutput PIV data structure
Returns
void

◆ gpiv_ovwrt_pivdata()

gchar* gpiv_ovwrt_pivdata ( const GpivPivData piv_data_in,
const GpivPivData piv_data_out 
)

Overwrites piv_data_out with piv_data_in.

Both PIV data sets will have to be allocated with gpiv_alloc_pivdata and must be of equal sizes.

Parameters
[in]piv_data_inInput PIV data
[in]piv_data_outOutput PIV data
Returns
NULL on success or error message on failure

◆ gpiv_piv_gnuplot()

gchar* gpiv_piv_gnuplot ( const gchar *  title,
const gfloat  gnuplot_scale,
const gchar *  GNUPLOT_DISPLAY_COLOR,
const guint  GNUPLOT_DISPLAY_SIZE,
const GpivImagePar image_par,
const GpivPivPar piv_par,
const GpivPivData piv_data 
)

Plots piv data as vectors on screen with gnuplot.

Parameters
[in]titletitle of plot
[in]gnuplot_scalevector scale
[in]GNUPLOT_DISPLAY_COLORdisplay color of window containing graph
[in]GNUPLOT_DISPLAY_SIZEdisplay size of window containing graph
[in]image_parimage parameters
[in]piv_parpiv evaluation parameters
[in]piv_datapiv data
Returns
NULL on success or error message on failure

◆ gpiv_sum_dxdy_pivdata()

gchar* gpiv_sum_dxdy_pivdata ( const GpivPivData piv_data,
gfloat *  sum 
)

Adds all displacements in order to calculate residuals The structure will have to be allocated before (with gpiv_alloc_pivdata).

Parameters
[in]piv_dataPIV data structure
[out]sumresulting sum
Returns
NULL on success or error message on failure

Generated for libgpiv-0.6.1 by doxygen 1.8.13