Go to the source code of this file.
Data Structures | |
struct | __GpivPivPar |
Parameters for PIV evaluation (interrogation) of images. More... | |
Defines | |
#define | GPIV_PIVPAR_KEY "PIV" |
Typedefs | |
typedef struct __GpivPivPar | GpivPivPar |
Enumerations | |
enum | GpivIntScheme { GPIV_NO_CORR, GPIV_LK_WEIGHT, GPIV_ZERO_OFF_FORWARD, GPIV_ZERO_OFF_CENTRAL, GPIV_IMG_DEFORM } |
Functions | |
void | gpiv_piv_default_parameters (GpivPivPar *piv_par_default, const gboolean force) |
GpivPivPar * | gpiv_piv_get_parameters_from_resources (const gchar *localrc, const gboolean verbose) |
void | gpiv_piv_parameters_set (GpivPivPar *piv_par, const gboolean flag) |
void | gpiv_piv_read_parameters (FILE *fp, GpivPivPar *piv_par, const gboolean verbose) |
gchar * | gpiv_piv_check_parameters_read (GpivPivPar *piv_par, const GpivPivPar *piv_par_default) |
gchar * | gpiv_piv_testonly_parameters (const GpivImagePar *image_par, const GpivPivPar *piv_par) |
gchar * | gpiv_piv_testadjust_parameters (const GpivImagePar *image_par, GpivPivPar *piv_par) |
void | gpiv_piv_print_parameters (FILE *fp, const GpivPivPar *piv_par) |
GpivPivPar * | gpiv_piv_cp_parameters (const GpivPivPar *piv_par) |
void | gpiv_piv_cp_undef_parameters (const GpivPivPar *piv_par_src, GpivPivPar *piv_par_dest) |
GpivPivPar * | gpiv_piv_fread_hdf5_parameters (const gchar *fname) |
gchar * | gpiv_piv_fwrite_hdf5_parameters (const gchar *fname, const GpivPivPar *piv_par) |
SOURCES: lib/piv_par.c
LAST MODIFICATION DATE:
Definition in file gpiv-piv_par.h.
#define GPIV_PIVPAR_KEY "PIV" |
Key of evaluation parameters
Definition at line 62 of file gpiv-piv_par.h.
typedef struct __GpivPivPar GpivPivPar |
Image evaluation or interrogation parameters for obtaining PIV estimators
Definition at line 80 of file gpiv-piv_par.h.
enum GpivIntScheme |
PIV interrogation scheme
Definition at line 68 of file gpiv-piv_par.h.
gchar* gpiv_piv_check_parameters_read | ( | GpivPivPar * | piv_par, | |
const GpivPivPar * | piv_par_default | |||
) |
Checks if all PIV parameters have been read. If a parameter has not been read, it will be set to piv_par_default or to its hard-coded default value in case piv_par_default is NULL.
[in] | piv_par_default | default parameters. If NULL, library default values are used. |
[out] | piv_par | PIV evaluation parameters |
GpivPivPar* gpiv_piv_cp_parameters | ( | const GpivPivPar * | piv_par | ) |
Copies piv parameters.
[in] | piv_par | piv parameters to be copied |
void gpiv_piv_cp_undef_parameters | ( | const GpivPivPar * | piv_par_src, | |
GpivPivPar * | piv_par_dest | |||
) |
Copies piv parameters from piv_par_src to piv_par_dest if piv_par_dest have not been set.
[in] | piv_par_src | piv parameters to be copied |
[out] | piv_par_dest | the copied piv parameters |
void gpiv_piv_default_parameters | ( | GpivPivPar * | piv_par_default, | |
const gboolean | force | |||
) |
Sets default parameter values.
[in] | force | flag to enforce parameters set to defaults |
[out] | piv_par_default | structure of piv evaluation parameters |
GpivPivPar* gpiv_piv_fread_hdf5_parameters | ( | const gchar * | fname | ) |
Reads piv parameters from hdf5 data file.
[in] | fname | input filename |
gchar* gpiv_piv_fwrite_hdf5_parameters | ( | const gchar * | fname, | |
const GpivPivPar * | piv_par | |||
) |
Writes piv parameters from hdf5 data file
[in] | fname | output filename |
[out] | piv_par | PIV evaluation parameters |
GpivPivPar* gpiv_piv_get_parameters_from_resources | ( | const gchar * | localrc, | |
const gboolean | verbose | |||
) |
Reads piv parameters from system-wide gpiv.conf and $HOME/.gpivrc.
[in] | localrc | resource filename containing parameter at current directory |
[in] | verbose | prints parameter values when read |
void gpiv_piv_parameters_set | ( | GpivPivPar * | piv_par, | |
const gboolean | flag | |||
) |
Sets flags for all piv_par__set.
[in] | flag | true (1) or false (0) |
[out] | piv_par | PIV evaluation parameters |
void gpiv_piv_print_parameters | ( | FILE * | fp, | |
const GpivPivPar * | piv_par | |||
) |
Prints parameters to fp.
[in] | fp | file pointer for output. If NULL, stdout will be used. |
[in] | piv_par | PIV evaluation parameters |
void gpiv_piv_read_parameters | ( | FILE * | fp, | |
GpivPivPar * | piv_par, | |||
const gboolean | verbose | |||
) |
Reads all parameters for PIV evaluation.
[in] | fp | file pointer to parameter file. If NULL, stdin will be used. |
[in] | verbose | flag to print parameters to stdout |
[out] | piv_par | PIV evaluation parameters |
gchar* gpiv_piv_testadjust_parameters | ( | const GpivImagePar * | image_par, | |
GpivPivPar * | piv_par | |||
) |
Tests if all piv parameters have been read and have been defined to valid values. Aplies missing parameters to defaults, as hard-coded in the library and adjusts parameters if necessary.
[in] | image_par | image parameters |
[in] | piv_par | PIV parameters |
gchar* gpiv_piv_testonly_parameters | ( | const GpivImagePar * | image_par, | |
const GpivPivPar * | piv_par | |||
) |
Tests all piv parameters if have been read and have been defined to valid values.
[in] | image_par | image parameters |
[in] | piv_par | PIV evaluation parameters |