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