Main Page | Files | Data Structures | Functions | Global Variables | Deprecated list

/home/gerber/gpiv_all/libgpiv-0.4.0/include/gpiv/imgproc.h File Reference

module for image processing More...


Data Structures

struct  __GpivImageProcPar

Defines

#define GPIV_IMGPROCPAR_DEFAULT__BIT   8
#define GPIV_IMGPROCPAR_DEFAULT__DIR_PREFIX   0
#define GPIV_IMGPROCPAR_DEFAULT__FILTER   0
#define GPIV_IMGPROCPAR_DEFAULT__FIRST_DIR   0
#define GPIV_IMGPROCPAR_DEFAULT__LAST_DIR   0
#define GPIV_IMGPROCPAR_DEFAULT__FIRST_FILE   0
#define GPIV_IMGPROCPAR_DEFAULT__LAST_FILE   0
#define GPIV_IMGPROCPAR_DEFAULT__FILE_PREFIX   0
#define GPIV_IMGPROCPAR_DEFAULT__SMOOTH_OPERATOR   0
#define GPIV_IMGPROCPAR_DEFAULT__THRESHOLD   30
#define GPIV_IMGPROCPAR_DEFAULT__WINDOW   10

Enumerations

enum  GpivImgFilter {
  GPIV_IMGFI_MKTSTIMG, GPIV_IMGFI_SUBACK, GPIV_IMGFI_SMOOTH, GPIV_IMGFI_HILO, GPIV_IMGFI_CLIP, GPIV_IMGFI_FFT, GPIV_IMGFI_INVFFT, GPIV_IMGFI_CORR, GPIV_IMGFI_CONV, GPIV_IMGFI_LOWPASS,
  GPIV_IMGFI_HIGHPASS, GPIV_IMGFI_GETBIT
}
enum  GpivImgSmoothOperator { GPIV_IMGOP_EQUAL, GPIV_IMGOP_SUBTRACT, GPIV_IMGOP_ADD, GPIV_IMGOP_MULTIPLY, GPIV_IMGOP_DIVIDE }

Functions

void gpiv_imgproc_default_parameters (GpivImageProcPar *imgproc_par_default, gboolean force)
void gpiv_imgproc_read_parameters (FILE *fp_h, GpivImageProcPar *image_proc_par, gboolean print_par)
gchar * gpiv_imgproc_check_parameters_read (GpivImageProcPar *image_proc_par, GpivImageProcPar image_proc_par_default)
gchar * gpiv_imgproc_test_parameters (GpivImageProcPar image_proc_par)
void gpiv_imgproc_print_parameters (GpivImageProcPar image_proc_par)
void gpiv_imgproc_fprint_parameters (FILE *fp_par_out, GpivImageProcPar image_proc_par)
gchar * gpiv_imgproc_mktestimg (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 ***img_out)
gchar * gpiv_imgproc_subtractimg (GpivImagePar image_par_in, guint16 **img_in, GpivImagePar image_par_out, guint16 **img_out)
gchar * gpiv_imgproc_smooth (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img)
gchar * gpiv_imgproc_highpass (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img)
gchar * gpiv_imgproc_highlow (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img)
gchar * gpiv_imgproc_clip (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img)
gchar * gpiv_imgproc_getbit (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img)
gchar * gpiv_imgproc_fft (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img)
gchar * gpiv_imgproc_lowpass (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img)
gchar * gpiv_imgproc_correlate (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img1_in, guint16 **img2_in, guint16 ***img_out)
gchar * gpiv_imgproc_convolve (GpivImagePar image_par, GpivImageProcPar image_proc_par, guint16 **img1_in, guint16 **img2_in, guint16 ***img_out)
gchar * gpiv_imgproc_deform (GpivPivData *piv_data, GpivImagePar *image_par, guint16 **img1_src, guint16 **img2_src, guint16 ***img1_dest, guint16 ***img2_dest)

Detailed Description

module for image processing

SOURCE: lib/imgproc.c

LAST MODIFICATION DATE:

Id
imgproc.h,v 1.5 2007-03-22 15:44:36 gerber Exp

Define Documentation

#define GPIV_IMGPROCPAR_DEFAULT__BIT   8

Default parameter for bit of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__DIR_PREFIX   0

Default parameter for dir_prefix of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__FILE_PREFIX   0

Default parameter for file_prefix of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__FILTER   0

Default parameter for filter of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__FIRST_DIR   0

Default parameter for first_dir of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__FIRST_FILE   0

Default parameter for first_file of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__LAST_DIR   0

Default parameter for last_dir of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__LAST_FILE   0

Default parameter for last_file of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__SMOOTH_OPERATOR   0

Default parameter for smooth_operator of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__THRESHOLD   30

Default parameter for threshold of __GpivImageProcPar

#define GPIV_IMGPROCPAR_DEFAULT__WINDOW   10

Default parameter for window of __GpivImageProcPar

Enumeration Type Documentation

enum GpivImgFilter

Image filter type

Enumerator:
GPIV_IMGFI_MKTSTIMG  Generate test image
GPIV_IMGFI_SUBACK  Subtract background image
GPIV_IMGFI_SMOOTH  Smooth filter
GPIV_IMGFI_HILO  High-low filter
GPIV_IMGFI_CLIP  Clipping
GPIV_IMGFI_FFT  FFT image
GPIV_IMGFI_INVFFT  Inverse FFT image
GPIV_IMGFI_CORR  Correlate
GPIV_IMGFI_CONV  Convolve
GPIV_IMGFI_LOWPASS  Low pass filter
GPIV_IMGFI_HIGHPASS  High pass filter
GPIV_IMGFI_GETBIT  Pointer operation to get the N least significant bits

enum GpivImgSmoothOperator

Operator type when smoothing is performed

Enumerator:
GPIV_IMGOP_EQUAL  No action
GPIV_IMGOP_SUBTRACT  Subtract avarage
GPIV_IMGOP_ADD  Add avarage
GPIV_IMGOP_MULTIPLY  Multiply with avarage
GPIV_IMGOP_DIVIDE  Divide by avarage

Function Documentation

gchar* gpiv_imgproc_check_parameters_read ( GpivImageProcPar *  image_proc_par,
GpivImageProcPar  image_proc_par_default 
)

Checks if all necessary image processing parameters have been read

Parameters:
[in] image_proc_par structure of image processing parameters
[in] image_proc_par_default image processing parameters containing default values
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_clip ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img 
)

Sets all pixel values lower than threshold to zero

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img input image. Needs to be allocated
[out] img modified input image
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_convolve ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img1_in,
guint16 **  img2_in,
guint16 ***  img_out 
)

Convolves two images

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img1_in first input image. Needs to be allocated
[in] img2_in second input image. Needs to be allocated
[out] img_out pointer to output image. Not necessarily allocated
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_correlate ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img1_in,
guint16 **  img2_in,
guint16 ***  img_out 
)

Correlates two images

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img1_in first input image. Needs to be allocated
[in] img2_in second input image. Needs to be allocated
[out] img_out pointer to output image. Not necessarily allocated
Returns:
NULL on success or *err_msg on failure

void gpiv_imgproc_default_parameters ( GpivImageProcPar *  imgproc_par_default,
gboolean  force 
)

Sets default parameter values

Parameters:
[in] force flag to enforce parameters set to defaults
[out] imgproc_par_default structure of image processing parameters
Returns:
void

gchar* gpiv_imgproc_deform ( GpivPivData *  piv_data,
GpivImagePar *  image_par,
guint16 **  img1_src,
guint16 **  img2_src,
guint16 ***  img1_dest,
guint16 ***  img2_dest 
)

Image shifting and deformation routine for a single exposed, double frame PIV image pair with magnitude of PIV estimations at each pixel

Parameters:
[in] piv_data Input PIV data structure
[in] image_par image parameters
[in] img1_src first input image frame. Needs to be allocated
[in] img2_src second input image frame. Needs to be allocated
[out] img1_dest first deformed image frame. May be allocated or not
[out] img2_dest second deformed image frame. May be allocated or not
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_fft ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img 
)

Fast Fourier Transformation

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img input image. Needs to be allocated
[out] img modified input image
Returns:
NULL on success or *err_msg on failure

void gpiv_imgproc_fprint_parameters ( FILE *  fp_par_out,
GpivImageProcPar  image_proc_par 
)

Prints image processing parameters to file

Parameters:
[in] fp_par_out file pointer to which paraeters will be printed
[in] image_proc_par structure of image processing parameters
Returns:
void

gchar* gpiv_imgproc_getbit ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img 
)

Pointer operation to get the N least significant bits and moves them to most the significant bits

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img input image. Needs to be allocated
[out] img modified input image
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_highlow ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img 
)

High-low filter to maximize contrast by stretching pixel values to local max and min within window x window area

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img input image. Needs to be allocated
[out] img modified input image
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_highpass ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img 
)

Highpass filter on an image passing data from M - window,..,M/2, N - window,..,N/2

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img input image. Needs to be allocated
[out] img modified input image
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_lowpass ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img 
)

Lowpass filter on an image

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img input image. Needs to be allocated
[out] img modified input image
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_mktestimg ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 ***  img_out 
)

Genarates test image for image processing

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[out] img_out pointer to output image. Not necessarily allocated
Returns:
NULL on success or *err_msg on failure

void gpiv_imgproc_print_parameters ( GpivImageProcPar  image_proc_par  ) 

Prints image processing parameters to stdout

Parameters:
[in] image_proc_par structure of image processing parameters
Returns:
void

void gpiv_imgproc_read_parameters ( FILE *  fp_h,
GpivImageProcPar *  image_proc_par,
gboolean  print_par 
)

Reads image processing parameters

Parameters:
[in] fp_h file to be read
[in] image_proc_par pointer to structure of image processing parameters
[in] print_par prints parameters to stdout during reading
[out] image_proc_par pointer to structure of image processing parameters
Returns:
void

gchar* gpiv_imgproc_smooth ( GpivImagePar  image_par,
GpivImageProcPar  image_proc_par,
guint16 **  img 
)

Smoothing filter by taking mean value of surrounding window x window pixels

Parameters:
[in] image_par structure of image parameters
[in] image_proc_par structure of image processing parameters
[in] img input image. Needs to be allocated
[out] img modified input image
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_subtractimg ( GpivImagePar  image_par_in,
guint16 **  img_in,
GpivImagePar  image_par_out,
guint16 **  img_out 
)

Subtracts image intensities of img_in from img_out. To avoid swapping of intensities, output values are set to zero if img_in is larger than img_out. Images will have to be of identic dimensions.

Parameters:
[in] image_par_in structure of image parameters of img_in
[in] image_par_out image parameters of img_out
[in] img_in image containing the intensities to be subtracted
[out] img_out modified image. will have to exist and allocated
Returns:
NULL on success or *err_msg on failure

gchar* gpiv_imgproc_test_parameters ( GpivImageProcPar  image_proc_par  ) 

Tests on validity and adapt image processing parameters

Parameters:
[in] image_proc_par structure of image processing parameters
Returns:
NULL on success or *err_msg on failure

Generated on Sat Mar 31 19:30:54 2007 by  doxygen 1.5.1