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

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

module for image header en parameters More...


Data Structures

struct  __GpivImagePar

Defines

#define GPIV_IMGPAR_DEFAULT__DEPTH   8
#define GPIV_IMGPAR_DEFAULT__NCOLUMNS   256
#define GPIV_IMGPAR_DEFAULT__NROWS   256
#define GPIV_IMGPAR_DEFAULT__X_CORR   1
#define GPIV_IMGPAR_DEFAULT__S_SCALE   1.0
#define GPIV_IMGPAR_DEFAULT__T_SCALE   1.0
#define GPIV_IMGPAR_DEFAULT__Z_OFF_X   0.0
#define GPIV_IMGPAR_DEFAULT__Z_OFF_Y   0.0
#define GPIV_IMGPAR_DEFAULT__TITLE   ""
#define GPIV_IMGPAR_DEFAULT__CREATION_DATE   ""
#define GPIV_IMGPAR_DEFAULT__LOCATION   ""
#define GPIV_IMGPAR_DEFAULT__AUTHOR   ""
#define GPIV_IMGPAR_DEFAULT__SOFTWARE   "gpiv / gpiv_rr"
#define GPIV_IMGPAR_DEFAULT__SOURCE   ""
#define GPIV_IMGPAR_DEFAULT__USERTEXT   ""
#define GPIV_IMGPAR_DEFAULT__WARNING   ""
#define GPIV_IMGPAR_DEFAULT__DISCLAIMER   "See The GNU General Public License (GPL)"
#define GPIV_IMGPAR_DEFAULT__COMMENT   ""
#define GPIV_IMGPAR_DEFAULT__COPYRIGHT   ""
#define GPIV_IMGPAR_DEFAULT__EMAIL   ""
#define GPIV_IMGPAR_DEFAULT__URL   ""
#define GPIV_IMGPAR_DEFAULT__COMMENT   ""

Functions

void gpiv_img_parameters_logic (GpivImagePar *image_par, gboolean flag)
void gpiv_img_default_parameters (GpivImagePar *image_par, gboolean force)
void gpiv_img_read_header (FILE *fp_par, GpivImagePar *image_par, gboolean print_par)
void gpiv_img_fread_header (FILE *fp_par, FILE *fp_par_out, GpivImagePar *image_par, gboolean print_par)
char * gpiv_img_read_pgm_header (char *fname, GpivImagePar *image_par, gint *line_nr)
void gpiv_img_read_parameters (FILE *fp_h, GpivImagePar *image_par, gboolean print_par)
void gpiv_img_fread_parameters (FILE *fp_h, FILE *fp_par_out, GpivImagePar *image_par, gboolean print_par)
char * gpiv_img_check_header_read (GpivImagePar image_par)
char * gpiv_img_check_header_required_read (GpivImagePar image_par)
char * gpiv_img_check_header_scale_read (GpivImagePar image_par)
char * gpiv_img_test_header (GpivImagePar image_par)
void gpiv_img_print_header (GpivImagePar image_par)
void gpiv_img_fprint_pgmheader (FILE *fp_par_out, GpivImagePar image_par)
void gpiv_img_fprint_header (FILE *fp_par_out, GpivImagePar image_par)
void gpiv_img_cp_parameters (GpivImagePar image_par_src, GpivImagePar *image_par_dest, gboolean force, gboolean print_par)
void gpiv_img_fprint_parameters (FILE *fp_par_out, GpivImagePar image_par)
char * gpiv_img_fread_hdf5_parameters (char *fname, GpivImagePar *image_par)
char * gpiv_img_fwrite_hdf5_parameters (char *fname, GpivImagePar *image_par)
char * gpiv_img_fread_davis_parameters (char *fname, GpivImagePar *image_par)

Detailed Description

module for image header en parameters

SOURCE: lib/img.c

LAST MODIFICATION DATE:

Id
img.h,v 1.15 2007-03-22 15:29:44 gerber Exp

Define Documentation

#define GPIV_IMGPAR_DEFAULT__AUTHOR   ""

Default parameter for author of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__COMMENT   ""

Default parameter for comment of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__COMMENT   ""

Default parameter for comment of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__COPYRIGHT   ""

Default parameter for copyright of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__CREATION_DATE   ""

Default parameter for creation_date of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__DEPTH   8

Default parameter for depth of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__DISCLAIMER   "See The GNU General Public License (GPL)"

Default parameter for disclaimer of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__EMAIL   ""

Default parameter for email of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__LOCATION   ""

Default parameter for location of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__NCOLUMNS   256

Default parameter for ncolumns of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__NROWS   256

Default parameter for nrows of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__S_SCALE   1.0

Default parameter for s_scale of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__SOFTWARE   "gpiv / gpiv_rr"

Default parameter for software of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__SOURCE   ""

Default parameter for source of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__T_SCALE   1.0

Default parameter for t_scale of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__TITLE   ""

Default parameter for title of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__URL   ""

Default parameter for url of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__USERTEXT   ""

Default parameter for usertext of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__WARNING   ""

Default parameter for warning of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__X_CORR   1

Default parameter for x_corr of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__Z_OFF_X   0.0

Default parameter for z_off_x of __GpivImagePar

#define GPIV_IMGPAR_DEFAULT__Z_OFF_Y   0.0

Default parameter for z_off_y of __GpivImagePar

Function Documentation

char* gpiv_img_check_header_read ( GpivImagePar  image_par  ) 

Checks out if all image header info has been read

Parameters:
[in] image_par image parameters
Returns:
NULL on success or *err_msg on failure

char* gpiv_img_check_header_required_read ( GpivImagePar  image_par  ) 

Checks out if the required image header info for reading/storing has been read

Parameters:
[in] image_par image parameters
Returns:
NULL on success or *err_msg on failure

char* gpiv_img_check_header_scale_read ( GpivImagePar  image_par  ) 

Checks out if image header info for time/spatial scaling has been read

Parameters:
[in] image_par image parameters
Returns:
NULL on success or *err_msg on failure

void gpiv_img_cp_parameters ( GpivImagePar  image_par_src,
GpivImagePar *  image_par_dest,
gboolean  force,
gboolean  print_par 
)

Copies image parameters from src to dest

Parameters:
[in] image_par_src source image parameters
[in] force flag to force the copying, even if destination already exists
[in] print_par verbose output. Not implemented yet.
[out] image_par_dest destination image parameters
Returns:
void

void gpiv_img_default_parameters ( GpivImagePar *  image_par,
gboolean  force 
)

Sets default parameter values

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

void gpiv_img_fprint_header ( FILE *  fp_par_out,
GpivImagePar  image_par 
)

Prints image header parameters to file without GPIV_IMAGE_PAR_KEY

Parameters:
[in] fp_par_out file pointer to output file
[in] image_par image parameter structure
Returns:
void

void gpiv_img_fprint_parameters ( FILE *  fp_par_out,
GpivImagePar  image_par 
)

Prints image header parameters to fp_par_out including IMAGE_PAR_KEY

Parameters:
[in] fp_par_out filepointer or NULL if stdout
[in] image_par structure to image parameters
Returns:
void

void gpiv_img_fprint_pgmheader ( FILE *  fp_par_out,
GpivImagePar  image_par 
)

Prints image header parameters to PGM image format file without GPIV_IMAGE_PAR_KEY

Parameters:
[in] fp_par_out file pointer to output file
[in] image_par image parameter structure
Returns:
void

char* gpiv_img_fread_davis_parameters ( char *  fname,
GpivImagePar *  image_par 
)

Reads image specifications from Davis formatted image, with ext .IMG, from file

Parameters:
[in] fname filename
[out] image_par image parameters
Returns:
NULL on success or *err_msg on failure

char* gpiv_img_fread_hdf5_parameters ( char *  fname,
GpivImagePar *  image_par 
)

Reads image parameters from hdf5 data file without IMAGE_PAR_KEY

Parameters:
[in] fname filename
[out] image_par image parameters
Returns:
NULL on success or *err_msg on failure

void gpiv_img_fread_header ( FILE *  fp_par,
FILE *  fp_par_out,
GpivImagePar *  image_par,
gboolean  print_par 
)

Reads each line of file fp_par and looks for image header parameters without IMAGE_PAR_KEY

Parameters:
[in] fp_par file pointer of which parameters will be read from
[in] fp_par_out file pointer of which parameter will have to be printed
[in] print_par print parameters to fp_par_out (1) or not (0)
[out] image_par structure of image parameters
[out] fp_par_out file to write parameters to when read
Returns:
void

void gpiv_img_fread_parameters ( FILE *  fp_h,
FILE *  fp_par_out,
GpivImagePar *  image_par,
gboolean  print_par 
)

Reads each line of the file and looks for image header parameters including IMAGE_PAR_KEY

Parameters:
[in] fp_h file pointer to image header
[in] print_par print parameters to fp_par_out (1) or not (0)
[in] fp_par_out file pointer to print parameter to
[out] image_par image parameters
Returns:
void

char* gpiv_img_fwrite_hdf5_parameters ( char *  fname,
GpivImagePar *  image_par 
)

Writes image parameters to an existing hdf5 data file

Parameters:
[in] fname filename
[in] image_par image parameters
Returns:
NULL on success or *err_msg on failure

void gpiv_img_parameters_logic ( GpivImagePar *  image_par,
gboolean  flag 
)

Sets flag for image_par_logic

Parameters:
[in] flag flag to enforce parameters set to defaults
[out] image_par image parameter
Returns:
void

void gpiv_img_print_header ( GpivImagePar  image_par  ) 

Prints header information without IMAGE_PAR_KEY

Parameters:
[in] image_par image parameters
Returns:
NULL on success or *err_msg on failure

void gpiv_img_read_header ( FILE *  fp_par,
GpivImagePar *  image_par,
gboolean  print_par 
)

Scans the content of fp_par on image parameters without IMAGE_PAR_KEY

Parameters:
[in] fp_par poitner to input file
[in] print_par print parameters to stdout
[out] image_par output parameters
Returns:
void

void gpiv_img_read_parameters ( FILE *  fp_h,
GpivImagePar *  image_par,
gboolean  print_par 
)

Reads each line of file fp_h and looks for image header parameters including IMAGE_PAR_KEY

Parameters:
[in] fp_h file pointer to image header
[in] print_par print parameters to fp_par_out (1) or not (0)
[out] image_par image parameters
Returns:
void

char* gpiv_img_read_pgm_header ( char *  fname,
GpivImagePar *  image_par,
gint *  line_nr 
)

Reads each line of the raw portable graymap (pgm) format image file and retrieves image header parameters without GPIV_IMAGE_PAR_KEY

Parameters:
[in] fname file name
[out] image_par parameter structure
[out] line_nr line number to start image data
Returns:
NULL on success or *err_msg on failure

char* gpiv_img_test_header ( GpivImagePar  image_par  ) 

Checks out if all header parameters have been read

Parameters:
[in] image_par image parameters
Returns:
NULL on success or *err_msg on failure

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