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

/home/gerber/gpiv_all/libgpiv-0.4.0/include/gpiv/eval.h File Reference

module for image evaluation More...


Defines

#define GPIV_ZEROPAD_FACT   2
#define GPIV_DIFF_ISI   0
#define GPIV_CUM_RESIDU_MIN   0.25
#define GPIV_MAX_EVAL_SWEEP   10
#define GPIV_SNR_DISABLE   88.0
#define GPIV_DEFORMED_IMG_NAME   "gpiv_defimg"
#define GPIV_EVALPAR_DEFAULT__AUTOKEY   1
#define GPIV_EVALPAR_DEFAULT__INT_GEO   0
#define GPIV_EVALPAR_DEFAULT__COL_START   0
#define GPIV_EVALPAR_DEFAULT__COL_END   255
#define GPIV_EVALPAR_DEFAULT__ROW_START   0
#define GPIV_EVALPAR_DEFAULT__ROW_END   255
#define GPIV_EVALPAR_DEFAULT__INT_LINE_ROW   64
#define GPIV_EVALPAR_DEFAULT__INT_LINE_ROW_START   0
#define GPIV_EVALPAR_DEFAULT__INT_LINE_ROW_END   127
#define GPIV_EVALPAR_DEFAULT__INT_LINE_COL   64
#define GPIV_EVALPAR_DEFAULT__INT_LINE_COL_START   0
#define GPIV_EVALPAR_DEFAULT__INT_LINE_COL_END   127
#define GPIV_EVALPAR_DEFAULT__INT_POINT_COL   64
#define GPIV_EVALPAR_DEFAULT__INT_POINT_ROW   64
#define GPIV_EVALPAR_DEFAULT__INT_SIZE_1   64
#define GPIV_EVALPAR_DEFAULT__INT_SIZE_2   32
#define GPIV_EVALPAR_DEFAULT__INT_SHIFT   16
#define GPIV_EVALPAR_DEFAULT__PRE_SHIFT_COL   0
#define GPIV_EVALPAR_DEFAULT__PRE_SHIFT_ROW   0
#define GPIV_EVALPAR_DEFAULT__AD_INT   0
#define GPIV_EVALPAR_DEFAULT__IFIT   1
#define GPIV_EVALPAR_DEFAULT__PEAK   1
#define GPIV_EVALPAR_DEFAULT__INT_SCHEME   4
#define GPIV_EVALPAR_DEFAULT__OLD_PIV   0
#define GPIV_EVALPAR_DEFAULT__GAUSS_WEIGHT_IA   1
#define GPIV_EVALPAR_DEFAULT__SPOF_FILTER   0

Typedefs

typedef __GpivEvalPar GpivEvalPar
typedef __GpivCovariance Covariance

Enumerations

enum  GpivIFit { GPIV_NONE = 0, GPIV_GAUSS = 1, GPIV_POWER = 2, GPIV_GRAVITY = 3 }
enum  GpivIntGeo { GPIV_AOI = 0, GPIV_LINE_C = 1, GPIV_LINE_R = 2, GPIV_POINT = 3 }
enum  GpivIntScheme { , GPIV_LK_WEIGHT, GPIV_ZERO_OFF_FORWARD, GPIV_ZERO_OFF_CENTRAL, GPIV_IMG_DEFORM }

Functions

void gpiv_piv_default_parameters (GpivEvalPar *piv_eval_par_default, gboolean flag)
void gpiv_piv_parameters_logic (GpivEvalPar *piv_eval_par, gboolean flag)
void gpiv_piv_read_parameters (FILE *fp_par, GpivEvalPar *piv_eval_par, int print_par)
char * gpiv_piv_check_parameters_read (GpivEvalPar *piv_eval_par, GpivEvalPar piv_eval_par_default)
char * gpiv_piv_test_parameters (GpivImagePar *image_par, GpivEvalPar *piv_eval_par)
void gpiv_piv_print_parameters (GpivEvalPar piv_eval_par)
void gpiv_piv_fprint_parameters (FILE *fp_par_out, GpivEvalPar piv_eval_par)
void gpiv_piv_cp_parameters (GpivEvalPar piv_eval_par_src, GpivEvalPar *piv_eval_par_dest, gboolean force, gboolean print_par)
char * gpiv_piv_fread_hdf5_parameters (char *fname, GpivEvalPar *piv_eval_par)
char * gpiv_piv_fwrite_hdf5_parameters (char *fname, GpivEvalPar *piv_eval_par)
char * gpiv_piv_count_pivdata_fromimage (GpivPivData *out_data, GpivImagePar image_par, GpivEvalPar piv_eval_par)
char * gpiv_piv_select_int_point (GpivPivData *out_data, GpivImagePar image_par, GpivEvalPar piv_eval_par)
char * gpiv_piv_interr_reg (int index_y, int index_x, guint16 **img_1, guint16 **img_2, float **int_area_1, float **int_area_2, Covariance *cov, Covariance *w_k, GpivPivData *piv_data, int sweep, int last_sweep, GpivImagePar image_par, GpivEvalPar piv_eval_par)
void gpiv_piv_isizadapt (GpivEvalPar piv_eval_par_src, GpivEvalPar *piv_eval_par_dest, gboolean *isiz_last)
char * gpiv_eval_write_deformed_image (guint16 **img1, guint16 **img2, GpivImagePar image_par)
void gpiv_piv_bounds_cov (Covariance *cov, int int_size_0, GpivImagePar image_par)
void gpiv_piv_weight_kernel_1 (Covariance *w_k)
void gpiv_piv_weight_kernel_lin (Covariance *w_k, int int_size_0)
void gpiv_fread_fftw_wisdom (int dir)
void gpiv_fwrite_fftw_wisdom (int dir)


Detailed Description

module for image evaluation

SOURCES: lib/eval.c, lib/eval_par.c

LAST MODIFICATION DATE:

Id
eval.h,v 1.22 2007-02-16 17:08:15 gerber Exp

Define Documentation

#define GPIV_CUM_RESIDU_MIN   0.25

minimum cumulative residu for convergence

#define GPIV_DEFORMED_IMG_NAME   "gpiv_defimg"

Deformed image to be stored in TMP_DIR

#define GPIV_DIFF_ISI   0

difference between interrogation sizes of first and second image if zero offset has been used

#define GPIV_EVALPAR_DEFAULT__AD_INT   0

Default parameter for ad_int of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__AUTOKEY   1

Default parameter for autokey of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__COL_END   255

Default parameter for col_end of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__COL_START   0

Default parameter for col_start of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__GAUSS_WEIGHT_IA   1

Default parameter for gauss_weight_ia of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__IFIT   1

Default parameter for ifit of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_GEO   0

Default parameter for int_geo of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_LINE_COL   64

Default parameter for int_line_col of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_LINE_COL_END   127

Default parameter for int_line_col_end of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_LINE_COL_START   0

Default parameter for int_line_col_start of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_LINE_ROW   64

Default parameter for int_line_row of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_LINE_ROW_END   127

Default parameter for int_line_row_end of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_LINE_ROW_START   0

Default parameter for int_line_row_start of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_POINT_COL   64

Default parameter for int_line_col_end of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_POINT_ROW   64

Default parameter for int_point_row of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_SCHEME   4

Default parameter for int_scheme of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_SHIFT   16

Default parameter for int_shift of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_SIZE_1   64

Default parameter for int_size_1 of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__INT_SIZE_2   32

Default parameter for int_size_2

#define GPIV_EVALPAR_DEFAULT__OLD_PIV   0

Default parameter for old_piv

#define GPIV_EVALPAR_DEFAULT__PEAK   1

Default parameter for peak of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__PRE_SHIFT_COL   0

Default parameter for pre_shift_col of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__PRE_SHIFT_ROW   0

Default parameter for pre_shift_row of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__ROW_END   255

Default parameter for row_end of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__ROW_START   0

Default parameter for row_start of __GpivEvalPar

#define GPIV_EVALPAR_DEFAULT__SPOF_FILTER   0

Default parameter for spof_filter of __GpivEvalPar

#define GPIV_MAX_EVAL_SWEEP   10

maximum number of evaluation sweeps, starting from zero

#define GPIV_SNR_DISABLE   88.0

snr value for manually disabled estimator

#define GPIV_ZEROPAD_FACT   2

magnification factor of zero-padded int. area


Typedef Documentation

typedef struct __GpivCovariance Covariance

Covariance and derived data to fold into an array

typedef struct __GpivEvalPar GpivEvalPar

PIV evaluation parameters needed for interrogation


Enumeration Type Documentation

enum GpivIFit

Type of sub-pixel estimation

Enumerator:
GPIV_NONE  No fitting
GPIV_GAUSS  Gauss fitting
GPIV_POWER  Power fitting
GPIV_GRAVITY  Plain gravity fitting

enum GpivIntGeo

Interrogation geometry: within an area of interest, along a line or at a single point

Enumerator:
GPIV_AOI  Area of interst
GPIV_LINE_C  Along column line
GPIV_LINE_R  Along row line
GPIV_POINT  At single point

enum GpivIntScheme

PIV interrogation scheme

Enumerator:
GPIV_LK_WEIGHT  Linear kernel weighting if Interrogation Area's
GPIV_ZERO_OFF_FORWARD  classical zero ofsetting
GPIV_ZERO_OFF_CENTRAL  zero ofsetting using central differential scheme
GPIV_IMG_DEFORM  image deformation


Function Documentation

char* gpiv_eval_write_deformed_image ( guint16 **  img1,
guint16 **  img2,
GpivImagePar  image_par 
)

Stores deformed image to file system with pre defined name to TMPDIR and prints message to stdout

Parameters:
[in] img1 first image of PIV image pair
[in] img2 second image of PIV image pair
[in] image_par pointer to image parameter structure for header
Returns:
char * to NULL on success or *err_msg on failure

void gpiv_fread_fftw_wisdom ( int  dir  ) 

Reads fftw wisdoms from file and stores into a (public) string

Parameters:
[in] dir direction of fft; forward (+1) or inverse (-1)
Returns:
void

void gpiv_fwrite_fftw_wisdom ( int  dir  ) 

Writes fftw wisdoms to a file

Parameters:
[in] dir direction of fft; forward (+1) or inverse (-1)
Returns:
void

void gpiv_piv_bounds_cov ( Covariance cov,
int  int_size_0,
GpivImagePar  image_par 
)

Calculate boundaries of covariance data array

Parameters:
[in] int_size_0 zero-padded interrogation size
[in] image_par structure of image parameters
[out] cov Structure containing covariance data and boundaries
Returns:
void

char* gpiv_piv_check_parameters_read ( GpivEvalPar piv_eval_par,
GpivEvalPar  piv_eval_par_default 
)

Checks out if all parameters have been read. If a parameter has not been read, it will set to the default value.

Parameters:
[in] piv_eval_par_default default parameters
[out] piv_eval_par PIV evaluation parameters
Returns:
NULL on success or *err_msg on failure

char* gpiv_piv_count_pivdata_fromimage ( GpivPivData out_data,
GpivImagePar  image_par,
GpivEvalPar  piv_eval_par 
)

Calculates the number of interrogation areas from the image sizes, pre-shift and area of interest

Parameters:
[in] image_par structure of image parameters
[in] piv_eval_par structure of piv evaluation parameters
[out] out_data output piv data from image analysis
Returns:
NULL on success or *err_msg on failure

void gpiv_piv_cp_parameters ( GpivEvalPar  piv_eval_par_src,
GpivEvalPar piv_eval_par_dest,
gboolean  force,
gboolean  print_par 
)

Copies piv parameters from src to dest

Parameters:
[in] piv_eval_par_src source piv parameters
[in] force flag to force the copying, even if destination already exists
[in] print_par verbose output. Not implemented, yet.
[out] piv_eval_par_dest destination piv parameters
Returns:
void

void gpiv_piv_default_parameters ( GpivEvalPar piv_eval_par_default,
gboolean  flag 
)

Sets default parameter values

Parameters:
[in] flag flag to enforce parameters set to defaults
[out] piv_eval_par_default structure of piv evaluation parameters
Returns:
void

void gpiv_piv_fprint_parameters ( FILE *  fp_par_out,
GpivEvalPar  piv_eval_par 
)

Prints parameters to fp_par_out

Parameters:
[in] fp_par_out 
[in] piv_eval_par PIV evaluation parameters
Returns:
void

char* gpiv_piv_fread_hdf5_parameters ( char *  fname,
GpivEvalPar piv_eval_par 
)

Reads piv parameters from hdf5 data file

Parameters:
[in] fname input filename
[out] piv_eval_par 
Returns:
NULL on success or *err_msg on failure

char* gpiv_piv_fwrite_hdf5_parameters ( char *  fname,
GpivEvalPar piv_eval_par 
)

Writes piv parameters from hdf5 data file

Parameters:
[in] fname output filename
[out] piv_eval_par parameters
Returns:
NULL on success or *err_msg on failure

char* gpiv_piv_interr_reg ( int  index_y,
int  index_x,
guint16 **  img_1,
guint16 **  img_2,
float **  int_area_1,
float **  int_area_2,
Covariance cov,
Covariance w_k,
GpivPivData piv_data,
int  sweep,
int  last_sweep,
GpivImagePar  image_par,
GpivEvalPar  piv_eval_par 
)

Interrogates an individual region

Parameters:
[in] index_y y-index of interrogation area position
[in] index_x x-index of interrogation area position
[in] img_1 (binary) image data of first piv image
[in] img_2 (binary) image data of second piv image
[in] int_area_1 first interrogation area
[in] int_area_2 second interrogation area
[in] cov structure containing covariance data
[in] w_k structure containing weight kerel data
[in] sweep sweep number of iterative process
[in] last_sweep flag for last sweep
[in] image_par structure of image parameters
[in] piv_eval_par structure of piv evaluation parameters
[out] piv_data output piv data from image analysis
Returns:
char * to NULL on success or *err_msg on failure

void gpiv_piv_isizadapt ( GpivEvalPar  piv_eval_par_src,
GpivEvalPar piv_eval_par_dest,
gboolean *  isiz_last 
)

Adjusts interrogation area sizes. For each interrogation sweep, (dest) int_size2 is halved, until it reaches (src) int_size_1. Then, isiz_last is set TRUE, which will avoid changing the interrogation sizes in next calls.

Parameters:
[in] piv_eval_par_src original parameters
[out] piv_eval_par_dest actual parameters, to be modified during sweeps
[out] isiz_last flag for last interrogation sweep
Returns:
void

void gpiv_piv_parameters_logic ( GpivEvalPar piv_eval_par,
gboolean  flag 
)

Sets flags for all piv_eval_par_logic

Parameters:
[in] flag true (1) or false (0)
[out] piv_eval_par PIV evaluation parameters
Returns:
void

void gpiv_piv_print_parameters ( GpivEvalPar  piv_eval_par  ) 

Prints parameters to stdout

Parameters:
[in] piv_eval_par PIV evaluation parameters
Returns:
void

void gpiv_piv_read_parameters ( FILE *  fp_par,
GpivEvalPar piv_eval_par,
int  print_par 
)

Reads all parameters for PIV evaluation

Parameters:
[in] fp_par file pointer to parameter file
[in] print_par flag to print parametrs to stdout
[out] piv_eval_par 
Returns:
NULL on success or *err_msg on failure

char* gpiv_piv_select_int_point ( GpivPivData out_data,
GpivImagePar  image_par,
GpivEvalPar  piv_eval_par 
)

Calculates the positions of interrogation areas to be analysed

Parameters:
[in] image_par structure of image parameters
[in] piv_eval_par structure of piv evaluation parameters
[out] out_data output piv data from image analysis
Returns:
NULL on success or *err_msg on failure
Deprecated:
Substituted by gpiv_piv_gridgen

char* gpiv_piv_test_parameters ( GpivImagePar image_par,
GpivEvalPar piv_eval_par 
)

Tests parameters on valid values and initializing derived variables

Parameters:
[in] image_par image parameters
[in] piv_eval_par PIV evaluation parameters
[out] piv_eval_par 
Returns:
NULL on success or *err_msg on failure

void gpiv_piv_weight_kernel_1 ( Covariance w_k  ) 

Sets weight values for covariance data to one

Parameters:
[in] w_k zero-padded interrogation size
Returns:
void

void gpiv_piv_weight_kernel_lin ( Covariance w_k,
int  int_size_0 
)

Calculates linear weight kernel values for covariance data

Parameters:
[out] w_k Structure containing weighting data
[out] int_size_0 zero-padded interrogation size
Returns:
void


Generated on Sat Mar 31 19:30:53 2007 by  doxygen 1.5.1