Libpiv API documentation

 Search for 

__GpivPivPar Struct Reference

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

#include <gpiv-piv_par.h>

Data Fields
guint	col_start
gboolean	col_start__set
guint	col_end
gboolean	col_end__set
guint	ifit
gboolean	ifit__set
guint	int_geo
gboolean	int_geo__set
guint	int_line_col
gboolean	int_line_col__set
guint	int_line_col_start
gboolean	int_line_col_start__set
guint	int_line_col_end
gboolean	int_line_col_end__set
guint	int_line_row
gboolean	int_line_row__set
guint	int_line_row_start
gboolean	int_line_row_start__set
guint	int_line_row_end
gboolean	int_line_row_end__set
guint	int_point_col
gboolean	int_point_col__set
guint	int_point_row
gboolean	int_point_row__set
guint	int_size_1
gboolean	int_size_1__set
guint	int_size_2
gboolean	int_size_2__set
gint	int_shift
gboolean	int_shift__set
int	int_deform
gboolean	int_deform__set
gint	peak
gboolean	peak__set
int	pre_shift_col
gboolean	pre_shift_col__set
int	pre_shift_row
gboolean	pre_shift_row__set
int	print_par
gboolean	print_par__set
int	print_piv
gboolean	print_piv__set
guint	row_start
gboolean	row_start__set
guint	row_end
gboolean	row_end__set
int	spline_degree
gboolean	spline_degree__set
enum GpivIntScheme	int_scheme
gboolean	int_scheme__set
gboolean	gauss_weight_ia
gboolean	gauss_weight_ia__set
gboolean	spof_filter
gboolean	spof_filter__set

---

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

guint __GpivPivPar::col_start

first column of image to use for interrogation

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

gboolean __GpivPivPar::col_start__set

flag if col_start has been defined

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

guint __GpivPivPar::col_end

last column in image to use for interrogation

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

gboolean __GpivPivPar::col_end__set

flag if col_end has been defined

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

guint __GpivPivPar::ifit

Type of sub-pixel estimation

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

gboolean __GpivPivPar::ifit__set

flag if ifit has been defined

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

guint __GpivPivPar::int_geo

Interrogation along a line or within an area of interest

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

gboolean __GpivPivPar::int_geo__set

flag if int_geo has been defined

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

guint __GpivPivPar::int_line_col

interrogation along a column

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

gboolean __GpivPivPar::int_line_col__set

flag if int_line_col has been defined

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

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.

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.

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.

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.

guint __GpivPivPar::int_line_row

interrogation along a row

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

gboolean __GpivPivPar::int_line_row__set

flag if int_line_row has been defined

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

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.

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.

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.

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.

guint __GpivPivPar::int_point_col

column of a interrogation area for single point

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

gboolean __GpivPivPar::int_point_col__set

flag if int_point_col has been defined

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

guint __GpivPivPar::int_point_row

row of a interrogation area for single point

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

gboolean __GpivPivPar::int_point_row__set

flag if int_point_row has been defined

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

guint __GpivPivPar::int_size_1

< flag if int_size_1 has been defined first interrogation area size; to be ended with

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

gboolean __GpivPivPar::int_size_1__set

flag if int_size_1 has been defined

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

guint __GpivPivPar::int_size_2

second interrogation area size; to start with

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

gboolean __GpivPivPar::int_size_2__set

flag if int_size_2 has been defined

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

gint __GpivPivPar::int_shift

interrogation area shift

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

gboolean __GpivPivPar::int_shift__set

flag if int_shift has been defined

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

int __GpivPivPar::int_deform

deform image for improved accuracy

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

gboolean __GpivPivPar::int_deform__set

flag if int_deform has been defined

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

gint __GpivPivPar::peak

peak number of correlation function to be used as estimator

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

gboolean __GpivPivPar::peak__set

flag if peak has been defined

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

int __GpivPivPar::pre_shift_col

general pre-shift in horizontal direction (columns)

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

gboolean __GpivPivPar::pre_shift_col__set

flag if pre_shift_col has been defined

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

int __GpivPivPar::pre_shift_row

general pre-shift in vertical direction (rows)

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

gboolean __GpivPivPar::pre_shift_row__set

flag if pre_shift_row has been defined

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

int __GpivPivPar::print_par

print parameters

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

gboolean __GpivPivPar::print_par__set

flag if print_par has been defined

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

int __GpivPivPar::print_piv

print piv data

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

gboolean __GpivPivPar::print_piv__set

flag if print_piv has been defined

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

guint __GpivPivPar::row_start

last row in image to use for interrogation

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

gboolean __GpivPivPar::row_start__set

flag if row_start has been defined

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

guint __GpivPivPar::row_end

first row of image to use for interrogation

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

gboolean __GpivPivPar::row_end__set

flag if row_end has been defined

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

int __GpivPivPar::spline_degree

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

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

gboolean __GpivPivPar::spline_degree__set

flag if spline_degree has been defined

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

enum GpivIntScheme __GpivPivPar::int_scheme

Way to correct on biasing effects with value of GpivIntScheme

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

gboolean __GpivPivPar::int_scheme__set

flag if int_scheme has been defined

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

gboolean __GpivPivPar::gauss_weight_ia

Gaussian weighting to I.A.

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

gboolean __GpivPivPar::gauss_weight_ia__set

flag if gauss_weight_ia has been defined

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

gboolean __GpivPivPar::spof_filter

Symmetric Phase Only filtering of covariance function

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

gboolean __GpivPivPar::spof_filter__set

flag if spof_filter has been defined

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

---

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

• gpiv-piv_par.h

---