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

module for parameters for post-processing of PIV data More...

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

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...
 
GpivPostPargpiv_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...
 
GpivPostPargpiv_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...
 

Detailed Description

module for parameters for post-processing of PIV data

SOURCES: lib/post_par.c

LAST MODIFICATION DATE:

Id
gpiv-post_par.h,v 1.3 2008-10-09 15:04:47 gerber Exp

Definition in file gpiv-post_par.h.

Macro Definition Documentation

◆ GPIV_POSTPAR_KEY

#define GPIV_POSTPAR_KEY   "POST"

Key of post processing parameters.

Definition at line 55 of file gpiv-post_par.h.

Typedef Documentation

◆ GpivPostPar

typedef struct __GpivPostPar GpivPostPar

Definition at line 121 of file gpiv-post_par.h.

◆ GpivRoi

typedef struct __GpivRoi GpivRoi

Definition at line 108 of file gpiv-post_par.h.

Enumeration Type Documentation

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

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

◆ GpivOperationManipiv

Operator to transform (manipulate) PIV data.

Enumerator
GPIV_FAST_Y 

returns fast running y-positions of data

GPIV_FLIP_X 

flip in x-direction

GPIV_FLIP_Y 

flip in y-direction

GPIV_REVERT 

reverts array indexes

GPIV_ROT90 

rotates over 90 degrees

GPIV_ROT180 

rotates over 180 degrees

GPIV_FILTER_BLOCK 

filters out

GPIV_PASS_BLOCK 

passes through

GPIV_ADD_XY 

adds specified displacement/velocity in x and y direction

Definition at line 61 of file gpiv-post_par.h.

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

Function Documentation

◆ gpiv_post_check_parameters_read()

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.

Parameters
[in]post_parpost-processing parameters
[in]post_par_defaultdefault post-processing parameters If NULL, library default values are used.
[out]post_parpost-processing parameters
Returns
NULL on success or error message on failure

◆ gpiv_post_default_parameters()

void gpiv_post_default_parameters ( GpivPostPar post_par_default,
const gboolean  force 
)

Sets post-processing parameters to default values.

Parameters
[in]forceflag to enforce parameters set to defaults
[out]post_par_defaultdefault post-processing parameters
Returns
void

◆ gpiv_post_fread_hdf5_parameters()

GpivPostPar* gpiv_post_fread_hdf5_parameters ( const gchar *  fname)

Reads post parameters from hdf5 data file.

Parameters
[in]fnamefile name of data file
Returns
GpivPostPar or NULL on failure

◆ gpiv_post_fwrite_hdf5_parameters()

gchar* gpiv_post_fwrite_hdf5_parameters ( const gchar *  fname,
const GpivPostPar post_par 
)

Writes post parameters to an existing hdf5 data file.

Parameters
[in]fnamefile name of data file
[in]post_parpost-processing parameters
Returns
NULL on success or error message on failure

◆ gpiv_post_get_parameters_from_resources()

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.

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

◆ gpiv_post_parameters_set()

void gpiv_post_parameters_set ( GpivPostPar post_par,
const gboolean  flag 
)

Sets flag for post_par __set.

Parameters
[in]post_parpost-processing parameters
[in]flagboolean to set
Returns
void

◆ gpiv_post_print_parameters()

void gpiv_post_print_parameters ( FILE *  fp_par_out,
const GpivPostPar post_par 
)

Prints parameters to fp_par_out.

Parameters
[in]post_parpost-processing parameters
[in]fp_par_outpointer to output file
Returns
void

◆ gpiv_post_read_parameters()

void gpiv_post_read_parameters ( FILE *  fp_par,
GpivPostPar post_par,
const gboolean  print_par 
)

Reads all parameters for PIV data validation.

Parameters
[in]fp_parpointer to input file
[in]print_parflag to print parameters to stdout
[out]post_parpost-processing parameters
Returns
void

Generated for libgpiv-0.6.1 by doxygen 1.8.13