module for parameters for post-processing of PIV data More...
Go to the source code of this file.
Data Structures | |
struct | __GpivRoi |
Region Of Interest. More... | |
struct | __GpivPostPar |
Parameters for post-processing PIV data. More... | |
Macros | |
#define | GPIV_POSTPAR_KEY "POST" |
Key of post processing parameters. More... | |
Typedefs | |
typedef struct __GpivRoi | GpivRoi |
typedef struct __GpivPostPar | GpivPostPar |
Enumerations | |
enum | GpivOperationManipiv { GPIV_FAST_Y = 0, GPIV_FLIP_X = 1, GPIV_FLIP_Y = 2, GPIV_REVERT = 3, GPIV_ROT90 = 4, GPIV_ROT180 = 5, GPIV_FILTER_BLOCK = 6, GPIV_PASS_BLOCK = 7, GPIV_ADD_XY = 8 } |
Operator to transform (manipulate) PIV data. More... | |
enum | GpivDifferentiation { GPIV_CENTRAL = 0, GPIV_LEAST_SQUARES = 1, GPIV_RICHARDSON = 2, GPIV_CIRCULATION = 3 } |
Differential type. More... | |
enum | GpivOperation { GPIV_VORTICITY = 0, GPIV_S_STRAIN = 1, GPIV_N_STRAIN = 2 } |
Type of derivative operation. More... | |
enum | GpivScaleType { GPIV_SCALE = 0, GPIV_SCALE_INV = 1 } |
Variables for scaling PIV data. More... | |
Functions | |
void | gpiv_post_parameters_set (GpivPostPar *post_par, const gboolean flag) |
Sets flag for post_par __set. More... | |
void | gpiv_post_default_parameters (GpivPostPar *post_par_default, const gboolean force) |
Sets post-processing parameters to default values. More... | |
GpivPostPar * | gpiv_post_get_parameters_from_resources (const gchar *localrc, const gboolean verbose) |
Reads post-processing parameters from localrc, $HOME/.gpivrc and system-wide gpiv.conf. More... | |
void | gpiv_post_read_parameters (FILE *fp_par, GpivPostPar *post_par, const gboolean print_par) |
Reads all parameters for PIV data validation. More... | |
gchar * | gpiv_post_check_parameters_read (GpivPostPar *post_par, const GpivPostPar *post_par_default) |
Checks if all post-processing parameters have been read. More... | |
void | gpiv_post_print_parameters (FILE *fp_par_out, const GpivPostPar *post_par) |
Prints parameters to fp_par_out. More... | |
GpivPostPar * | gpiv_post_fread_hdf5_parameters (const gchar *fname) |
Reads post parameters from hdf5 data file. More... | |
gchar * | gpiv_post_fwrite_hdf5_parameters (const gchar *fname, const GpivPostPar *post_par) |
Writes post parameters to an existing hdf5 data file. More... | |
module for parameters for post-processing of PIV data
SOURCES: lib/post_par.c
LAST MODIFICATION DATE:
Definition in file gpiv-post_par.h.
#define GPIV_POSTPAR_KEY "POST" |
Key of post processing parameters.
Definition at line 55 of file gpiv-post_par.h.
typedef struct __GpivPostPar GpivPostPar |
Definition at line 121 of file gpiv-post_par.h.
Definition at line 108 of file gpiv-post_par.h.
enum GpivDifferentiation |
Differential type.
Enumerator | |
---|---|
GPIV_CENTRAL | Central differential. |
GPIV_LEAST_SQUARES | Least square. |
GPIV_RICHARDSON | Richarchon differential. |
GPIV_CIRCULATION | Circulation method. |
Definition at line 78 of file gpiv-post_par.h.
enum GpivOperation |
Type of derivative operation.
Enumerator | |
---|---|
GPIV_VORTICITY | Vorticity. |
GPIV_S_STRAIN | Shear strain. |
GPIV_N_STRAIN | Normal strain. |
Definition at line 90 of file gpiv-post_par.h.
enum GpivOperationManipiv |
Operator to transform (manipulate) PIV data.
Definition at line 61 of file gpiv-post_par.h.
enum GpivScaleType |
Variables for scaling PIV data.
Enumerator | |
---|---|
GPIV_SCALE | Scaling PIV data. |
GPIV_SCALE_INV | Inverse scaling PIV data. |
Definition at line 101 of file gpiv-post_par.h.
gchar* gpiv_post_check_parameters_read | ( | GpivPostPar * | post_par, |
const GpivPostPar * | post_par_default | ||
) |
Checks if all post-processing parameters have been read.
If a parameter has not been read, it will be set to post_par_default or its hard-coded default value in case post_par_default is NULL.
[in] | post_par | post-processing parameters |
[in] | post_par_default | default post-processing parameters If NULL, library default values are used. |
[out] | post_par | post-processing parameters |
void gpiv_post_default_parameters | ( | GpivPostPar * | post_par_default, |
const gboolean | force | ||
) |
Sets post-processing parameters to default values.
[in] | force | flag to enforce parameters set to defaults |
[out] | post_par_default | default post-processing parameters |
GpivPostPar* gpiv_post_fread_hdf5_parameters | ( | const gchar * | fname | ) |
Reads post parameters from hdf5 data file.
[in] | fname | file name of data file |
gchar* gpiv_post_fwrite_hdf5_parameters | ( | const gchar * | fname, |
const GpivPostPar * | post_par | ||
) |
Writes post parameters to an existing hdf5 data file.
[in] | fname | file name of data file |
[in] | post_par | post-processing parameters |
GpivPostPar* gpiv_post_get_parameters_from_resources | ( | const gchar * | localrc, |
const gboolean | verbose | ||
) |
Reads post-processing parameters from localrc, $HOME/.gpivrc and system-wide gpiv.conf.
[in] | localrc | resource filename containing parameter at current directory |
[in] | verbose | prints parameter values when read |
void gpiv_post_parameters_set | ( | GpivPostPar * | post_par, |
const gboolean | flag | ||
) |
Sets flag for post_par __set.
[in] | post_par | post-processing parameters |
[in] | flag | boolean to set |
void gpiv_post_print_parameters | ( | FILE * | fp_par_out, |
const GpivPostPar * | post_par | ||
) |
Prints parameters to fp_par_out.
[in] | post_par | post-processing parameters |
[in] | fp_par_out | pointer to output file |
void gpiv_post_read_parameters | ( | FILE * | fp_par, |
GpivPostPar * | post_par, | ||
const gboolean | print_par | ||
) |
Reads all parameters for PIV data validation.
[in] | fp_par | pointer to input file |
[in] | print_par | flag to print parameters to stdout |
[out] | post_par | post-processing parameters |