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

Parameters for PIV evaluation (interrogation) of images. More...

#include <include/gpiv/gpiv-piv_par.h>

Data Fields

guint col_start
 first column of image to use for interrogation More...
 
gboolean col_start__set
 flag if col_start has been defined More...
 
guint col_end
 last column in image to use for interrogation More...
 
gboolean col_end__set
 flag if col_end has been defined More...
 
guint ifit
 Type of sub-pixel estimation. More...
 
gboolean ifit__set
 flag if ifit has been defined More...
 
guint int_geo
 Interrogation along a line or within an area of interest. More...
 
gboolean int_geo__set
 flag if int_geo has been defined More...
 
guint int_line_col
 interrogation along a column More...
 
gboolean int_line_col__set
 flag if int_line_col has been defined More...
 
guint int_line_col_start
 first column of image to use for interrogation along a line More...
 
gboolean int_line_col_start__set
 flag if int_line_col_start has been defined More...
 
guint int_line_col_end
 last column of image to use for interrogation along a line More...
 
gboolean int_line_col_end__set
 flag if int_line_col_end has been defined More...
 
guint int_line_row
 interrogation along a row More...
 
gboolean int_line_row__set
 flag if int_line_row has been defined More...
 
guint int_line_row_start
 first row of image to use for interrogation along a column More...
 
gboolean int_line_row_start__set
 flag if int_line_row_start has been defined More...
 
guint int_line_row_end
 first row of image to use for interrogation along a column More...
 
gboolean int_line_row_end__set
 flag if int_line_row_end has been defined More...
 
guint int_point_col
 column of a interrogation area for single point More...
 
gboolean int_point_col__set
 flag if int_point_col has been defined More...
 
guint int_point_row
 row of a interrogation area for single point More...
 
gboolean int_point_row__set
 flag if int_point_row has been defined More...
 
guint int_size_f
 final interrogation area size; to be ended with More...
 
gboolean int_size_f__set
 flag if int_size_i has been defined More...
 
guint int_size_i
 initial interrogation area size; to start with More...
 
gboolean int_size_i__set
 flag if int_size_f has been defined More...
 
gint int_shift
 interrogation area shift More...
 
gboolean int_shift__set
 flag if int_shift has been defined More...
 
int int_deform
 deform image for improved accuracy More...
 
gboolean int_deform__set
 flag if int_deform has been defined More...
 
gint peak
 peak number of correlation function to be used as estimator More...
 
gboolean peak__set
 flag if peak has been defined More...
 
int pre_shift_col
 general pre-shift in horizontal direction (columns) More...
 
gboolean pre_shift_col__set
 flag if pre_shift_col has been defined More...
 
int pre_shift_row
 general pre-shift in vertical direction (rows) More...
 
gboolean pre_shift_row__set
 flag if pre_shift_row has been defined More...
 
int print_par
 print parameters More...
 
gboolean print_par__set
 flag if print_par has been defined More...
 
int print_piv
 print piv data More...
 
gboolean print_piv__set
 flag if print_piv has been defined More...
 
guint row_start
 last row in image to use for interrogation More...
 
gboolean row_start__set
 flag if row_start has been defined More...
 
guint row_end
 first row of image to use for interrogation More...
 
gboolean row_end__set
 flag if row_end has been defined More...
 
int spline_degree
 degree of b-splines to be used for image data interpolation More...
 
gboolean spline_degree__set
 flag if spline_degree has been defined More...
 
enum GpivIntScheme int_scheme
 Way to correct on biasing effects with value of GpivIntScheme. More...
 
gboolean int_scheme__set
 flag if int_scheme has been defined More...
 
gboolean gauss_weight_ia
 Gaussian weighting to I.A. More...
 
gboolean gauss_weight_ia__set
 flag if gauss_weight_ia has been defined More...
 
gboolean spof_filter
 Symmetric Phase Only filtering of covariance function. More...
 
gboolean spof_filter__set
 flag if spof_filter has been defined More...
 

Detailed Description

Parameters for PIV evaluation (interrogation) of images.

These parameters are needed by the functions for interrogating a PIV image-pair, like: interrogation schemes, sub-pixel interpolation methods, Area of Interest. The parameters might be loaded from the configuration resources, with gpiv_scan_resourcefiles(), gpiv_scan_parameter() or with gpiv_piv_read_parameters().

Definition at line 91 of file gpiv-piv_par.h.

Field Documentation

◆ col_end

guint __GpivPivPar::col_end

last column in image to use for interrogation

Definition at line 95 of file gpiv-piv_par.h.

◆ col_end__set

gboolean __GpivPivPar::col_end__set

flag if col_end has been defined

Definition at line 96 of file gpiv-piv_par.h.

◆ col_start

guint __GpivPivPar::col_start

first column of image to use for interrogation

Definition at line 92 of file gpiv-piv_par.h.

◆ col_start__set

gboolean __GpivPivPar::col_start__set

flag if col_start has been defined

Definition at line 93 of file gpiv-piv_par.h.

◆ gauss_weight_ia

gboolean __GpivPivPar::gauss_weight_ia

Gaussian weighting to I.A.

Definition at line 167 of file gpiv-piv_par.h.

◆ gauss_weight_ia__set

gboolean __GpivPivPar::gauss_weight_ia__set

flag if gauss_weight_ia has been defined

Definition at line 168 of file gpiv-piv_par.h.

◆ ifit

guint __GpivPivPar::ifit

Type of sub-pixel estimation.

Definition at line 98 of file gpiv-piv_par.h.

◆ ifit__set

gboolean __GpivPivPar::ifit__set

flag if ifit has been defined

Definition at line 99 of file gpiv-piv_par.h.

◆ int_deform

int __GpivPivPar::int_deform

deform image for improved accuracy

Definition at line 137 of file gpiv-piv_par.h.

◆ int_deform__set

gboolean __GpivPivPar::int_deform__set

flag if int_deform has been defined

Definition at line 138 of file gpiv-piv_par.h.

◆ int_geo

guint __GpivPivPar::int_geo

Interrogation along a line or within an area of interest.

Definition at line 101 of file gpiv-piv_par.h.

◆ int_geo__set

gboolean __GpivPivPar::int_geo__set

flag if int_geo has been defined

Definition at line 102 of file gpiv-piv_par.h.

◆ int_line_col

guint __GpivPivPar::int_line_col

interrogation along a column

Definition at line 104 of file gpiv-piv_par.h.

◆ int_line_col__set

gboolean __GpivPivPar::int_line_col__set

flag if int_line_col has been defined

Definition at line 105 of file gpiv-piv_par.h.

◆ int_line_col_end

guint __GpivPivPar::int_line_col_end

last column of image to use for interrogation along a line

Definition at line 110 of file gpiv-piv_par.h.

◆ int_line_col_end__set

gboolean __GpivPivPar::int_line_col_end__set

flag if int_line_col_end has been defined

Definition at line 111 of file gpiv-piv_par.h.

◆ int_line_col_start

guint __GpivPivPar::int_line_col_start

first column of image to use for interrogation along a line

Definition at line 107 of file gpiv-piv_par.h.

◆ int_line_col_start__set

gboolean __GpivPivPar::int_line_col_start__set

flag if int_line_col_start has been defined

Definition at line 108 of file gpiv-piv_par.h.

◆ int_line_row

guint __GpivPivPar::int_line_row

interrogation along a row

Definition at line 113 of file gpiv-piv_par.h.

◆ int_line_row__set

gboolean __GpivPivPar::int_line_row__set

flag if int_line_row has been defined

Definition at line 114 of file gpiv-piv_par.h.

◆ int_line_row_end

guint __GpivPivPar::int_line_row_end

first row of image to use for interrogation along a column

Definition at line 119 of file gpiv-piv_par.h.

◆ int_line_row_end__set

gboolean __GpivPivPar::int_line_row_end__set

flag if int_line_row_end has been defined

Definition at line 120 of file gpiv-piv_par.h.

◆ int_line_row_start

guint __GpivPivPar::int_line_row_start

first row of image to use for interrogation along a column

Definition at line 116 of file gpiv-piv_par.h.

◆ int_line_row_start__set

gboolean __GpivPivPar::int_line_row_start__set

flag if int_line_row_start has been defined

Definition at line 117 of file gpiv-piv_par.h.

◆ int_point_col

guint __GpivPivPar::int_point_col

column of a interrogation area for single point

Definition at line 122 of file gpiv-piv_par.h.

◆ int_point_col__set

gboolean __GpivPivPar::int_point_col__set

flag if int_point_col has been defined

Definition at line 123 of file gpiv-piv_par.h.

◆ int_point_row

guint __GpivPivPar::int_point_row

row of a interrogation area for single point

Definition at line 125 of file gpiv-piv_par.h.

◆ int_point_row__set

gboolean __GpivPivPar::int_point_row__set

flag if int_point_row has been defined

Definition at line 126 of file gpiv-piv_par.h.

◆ int_scheme

enum GpivIntScheme __GpivPivPar::int_scheme

Way to correct on biasing effects with value of GpivIntScheme.

Definition at line 164 of file gpiv-piv_par.h.

◆ int_scheme__set

gboolean __GpivPivPar::int_scheme__set

flag if int_scheme has been defined

Definition at line 165 of file gpiv-piv_par.h.

◆ int_shift

gint __GpivPivPar::int_shift

interrogation area shift

Definition at line 134 of file gpiv-piv_par.h.

◆ int_shift__set

gboolean __GpivPivPar::int_shift__set

flag if int_shift has been defined

Definition at line 135 of file gpiv-piv_par.h.

◆ int_size_f

guint __GpivPivPar::int_size_f

final interrogation area size; to be ended with

Definition at line 128 of file gpiv-piv_par.h.

◆ int_size_f__set

gboolean __GpivPivPar::int_size_f__set

flag if int_size_i has been defined

Definition at line 129 of file gpiv-piv_par.h.

◆ int_size_i

guint __GpivPivPar::int_size_i

initial interrogation area size; to start with

Definition at line 131 of file gpiv-piv_par.h.

◆ int_size_i__set

gboolean __GpivPivPar::int_size_i__set

flag if int_size_f has been defined

Definition at line 132 of file gpiv-piv_par.h.

◆ peak

gint __GpivPivPar::peak

peak number of correlation function to be used as estimator

Definition at line 140 of file gpiv-piv_par.h.

◆ peak__set

gboolean __GpivPivPar::peak__set

flag if peak has been defined

Definition at line 141 of file gpiv-piv_par.h.

◆ pre_shift_col

int __GpivPivPar::pre_shift_col

general pre-shift in horizontal direction (columns)

Definition at line 143 of file gpiv-piv_par.h.

◆ pre_shift_col__set

gboolean __GpivPivPar::pre_shift_col__set

flag if pre_shift_col has been defined

Definition at line 144 of file gpiv-piv_par.h.

◆ pre_shift_row

int __GpivPivPar::pre_shift_row

general pre-shift in vertical direction (rows)

Definition at line 146 of file gpiv-piv_par.h.

◆ pre_shift_row__set

gboolean __GpivPivPar::pre_shift_row__set

flag if pre_shift_row has been defined

Definition at line 147 of file gpiv-piv_par.h.

◆ print_par

int __GpivPivPar::print_par

print parameters

Definition at line 149 of file gpiv-piv_par.h.

◆ print_par__set

gboolean __GpivPivPar::print_par__set

flag if print_par has been defined

Definition at line 150 of file gpiv-piv_par.h.

◆ print_piv

int __GpivPivPar::print_piv

print piv data

Definition at line 152 of file gpiv-piv_par.h.

◆ print_piv__set

gboolean __GpivPivPar::print_piv__set

flag if print_piv has been defined

Definition at line 153 of file gpiv-piv_par.h.

◆ row_end

guint __GpivPivPar::row_end

first row of image to use for interrogation

Definition at line 158 of file gpiv-piv_par.h.

◆ row_end__set

gboolean __GpivPivPar::row_end__set

flag if row_end has been defined

Definition at line 159 of file gpiv-piv_par.h.

◆ row_start

guint __GpivPivPar::row_start

last row in image to use for interrogation

Definition at line 155 of file gpiv-piv_par.h.

◆ row_start__set

gboolean __GpivPivPar::row_start__set

flag if row_start has been defined

Definition at line 156 of file gpiv-piv_par.h.

◆ spline_degree

int __GpivPivPar::spline_degree

degree of b-splines to be used for image data interpolation

Definition at line 161 of file gpiv-piv_par.h.

◆ spline_degree__set

gboolean __GpivPivPar::spline_degree__set

flag if spline_degree has been defined

Definition at line 162 of file gpiv-piv_par.h.

◆ spof_filter

gboolean __GpivPivPar::spof_filter

Symmetric Phase Only filtering of covariance function.

Definition at line 170 of file gpiv-piv_par.h.

◆ spof_filter__set

gboolean __GpivPivPar::spof_filter__set

flag if spof_filter has been defined

Definition at line 171 of file gpiv-piv_par.h.


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

Generated for libgpiv-0.6.1 by doxygen 1.8.13