Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-piv_par.h File Reference

module for parameters for image evaluation More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

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

Macros

#define GPIV_PIVPAR_KEY   "PIV"
 Key of evaluation parameters. More...
 

Typedefs

typedef struct __GpivPivPar GpivPivPar
 Image evaluation or interrogation parameters for obtaining PIV estimators. More...
 

Enumerations

enum  GpivIntScheme {
  GPIV_NO_CORR, GPIV_LK_WEIGHT, GPIV_ZERO_OFF_FORWARD, GPIV_ZERO_OFF_CENTRAL,
  GPIV_IMG_DEFORM
}
 PIV interrogation scheme. More...
 

Functions

void gpiv_piv_default_parameters (GpivPivPar *piv_par_default, const gboolean force)
 Sets default parameter values. More...
 
GpivPivPargpiv_piv_get_parameters_from_resources (const gchar *localrc, const gboolean verbose)
 Reads piv parameters from system-wide gpiv.conf and $HOME/.gpivrc. More...
 
void gpiv_piv_parameters_set (GpivPivPar *piv_par, const gboolean flag)
 Sets flags for all piv_par__set. More...
 
void gpiv_piv_read_parameters (FILE *fp, GpivPivPar *piv_par, const gboolean verbose)
 Reads all parameters for PIV evaluation. More...
 
gchar * gpiv_piv_check_parameters_read (GpivPivPar *piv_par, const GpivPivPar *piv_par_default)
 Checks if all PIV parameters have been read. More...
 
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. More...
 
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. More...
 
void gpiv_piv_print_parameters (FILE *fp, const GpivPivPar *piv_par)
 Prints parameters to fp. More...
 
GpivPivPargpiv_piv_cp_parameters (const GpivPivPar *piv_par)
 Copies piv parameters. More...
 
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. More...
 
GpivPivPargpiv_piv_fread_hdf5_parameters (const gchar *fname)
 Reads piv parameters from hdf5 data file. More...
 
gchar * gpiv_piv_fwrite_hdf5_parameters (const gchar *fname, const GpivPivPar *piv_par)
 Writes piv parameters from hdf5 data file. More...
 

Detailed Description

module for parameters for image evaluation

SOURCES: lib/piv_par.c

LAST MODIFICATION DATE:

Id
gpiv-piv_par.h,v 1.3 2008-09-25 13:19:53 gerber Exp

Definition in file gpiv-piv_par.h.

Macro Definition Documentation

◆ GPIV_PIVPAR_KEY

#define GPIV_PIVPAR_KEY   "PIV"

Key of evaluation parameters.

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

Typedef Documentation

◆ GpivPivPar

typedef struct __GpivPivPar GpivPivPar

Image evaluation or interrogation parameters for obtaining PIV estimators.

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

Enumeration Type Documentation

◆ GpivIntScheme

PIV interrogation scheme.

Enumerator
GPIV_NO_CORR 
GPIV_LK_WEIGHT 

Linear kernel weighting if Interrogation Area's.

GPIV_ZERO_OFF_FORWARD 

classical zero ofsetting

GPIV_ZERO_OFF_CENTRAL 

zero ofsetting using central differential scheme

GPIV_IMG_DEFORM 

image deformation

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

Function Documentation

◆ gpiv_piv_check_parameters_read()

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.

@param[in] piv_par_default     default parameters. If NULL, library default 
                               values are used.
@param[out] piv_par            PIV evaluation parameters
@return                        NULL on success or error message on failure

◆ gpiv_piv_cp_parameters()

GpivPivPar* gpiv_piv_cp_parameters ( const GpivPivPar piv_par)

Copies piv parameters.

Parameters
[in]piv_parpiv parameters to be copied
Returns
GpivPivPar or NULL on failure

◆ gpiv_piv_cp_undef_parameters()

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.

Parameters
[in]piv_par_srcpiv parameters to be copied
[out]piv_par_destthe copied piv parameters
Returns
void

◆ gpiv_piv_default_parameters()

void gpiv_piv_default_parameters ( GpivPivPar piv_par_default,
const gboolean  force 
)

Sets default parameter values.

Parameters
[in]forceflag to enforce parameters set to defaults
[out]piv_par_defaultstructure of piv evaluation parameters
Returns
void

◆ gpiv_piv_fread_hdf5_parameters()

GpivPivPar* gpiv_piv_fread_hdf5_parameters ( const gchar *  fname)

Reads piv parameters from hdf5 data file.

Parameters
[in]fnameinput filename
Returns
GpivPivPar of NULL on failure

◆ gpiv_piv_fwrite_hdf5_parameters()

gchar* gpiv_piv_fwrite_hdf5_parameters ( const gchar *  fname,
const GpivPivPar piv_par 
)

Writes piv parameters from hdf5 data file.

Parameters
[in]fnameoutput filename
[out]piv_parPIV evaluation parameters
Returns
NULL on success or error message on failure

◆ gpiv_piv_get_parameters_from_resources()

GpivPivPar* gpiv_piv_get_parameters_from_resources ( const gchar *  localrc,
const gboolean  verbose 
)

Reads piv parameters from system-wide gpiv.conf and $HOME/.gpivrc.

Parameters
[in]localrcresource filename containing parameter at current directory
[in]verboseprints parameter values when read
Returns
GpivPivPar or NULL on failure

◆ gpiv_piv_parameters_set()

void gpiv_piv_parameters_set ( GpivPivPar piv_par,
const gboolean  flag 
)

Sets flags for all piv_par__set.

Parameters
[in]flagtrue (1) or false (0)
[out]piv_parPIV evaluation parameters
Returns
void

◆ gpiv_piv_print_parameters()

void gpiv_piv_print_parameters ( FILE *  fp,
const GpivPivPar piv_par 
)

Prints parameters to fp.

Parameters
[in]fpfile pointer for output. If NULL, stdout will be used.
[in]piv_parPIV evaluation parameters
Returns
void

◆ gpiv_piv_read_parameters()

void gpiv_piv_read_parameters ( FILE *  fp,
GpivPivPar piv_par,
const gboolean  verbose 
)

Reads all parameters for PIV evaluation.

Parameters
[in]fpfile pointer to parameter file. If NULL, stdin will be used.
[in]verboseflag to print parameters to stdout
[out]piv_parPIV evaluation parameters
Returns
NULL on success or error message on failure

◆ gpiv_piv_testadjust_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.

Parameters
[in]image_parimage parameters
[in]piv_parPIV parameters
Returns
NULL on success or error message on failure

◆ gpiv_piv_testonly_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.

Parameters
[in]image_parimage parameters
[in]piv_parPIV evaluation parameters
Returns
NULL on success or error message on failure

Generated for libgpiv-0.6.1 by doxygen 1.8.13