FVS Fingerprint Verification System API Documentation

image.h File Reference

#include "fvstypes.h"

Go to the source code of this file.

Typedefs

typedef FvsHandle_t FvsImage_t

Enumerations

enum  FvsImageFlag_t { FvsImageGray = 0, FvsImageBinarized = 1, FvsImageThinned = 2 }

Functions

FvsImage_t ImageCreate (void)
void ImageDestroy (FvsImage_t image)
FvsError_t ImageSetSize (FvsImage_t image, const FvsInt_t width, const FvsInt_t height)
FvsError_t ImageSetFlag (FvsImage_t image, const FvsImageFlag_t flag)
FvsImageFlag_t ImageGetFlag (const FvsImage_t image)
FvsError_t ImageCopy (FvsImage_t destination, const FvsImage_t source)
FvsError_t ImageClear (FvsImage_t image)
FvsError_t ImageFlood (FvsImage_t image, const FvsByte_t value)
void ImageSetPixel (FvsImage_t image, const FvsInt_t x, const FvsInt_t y, const FvsByte_t val)
FvsByte_t ImageGetPixel (const FvsImage_t image, const FvsInt_t x, const FvsInt_t y)
FvsByte_tImageGetBuffer (FvsImage_t image)
FvsInt_t ImageGetWidth (const FvsImage_t image)
FvsInt_t ImageGetHeight (const FvsImage_t image)
FvsInt_t ImageGetPitch (const FvsImage_t image)
FvsInt_t ImageGetSize (const FvsImage_t image)
FvsBool_t ImageCompareSize (const FvsImage_t image1, const FvsImage_t image2)


Typedef Documentation

typedef FvsHandle_t FvsImage_t
 

The implementation of the object is private and must not be known by the user. Use this handle to manipulate the file through the functions provided hereunder.


Enumeration Type Documentation

enum FvsImageFlag_t
 

Flags that define what for properties the image has. These flags are managed automatically by the library on some function calls. You may also set them by yourself if you know what you are doing. These flags will empeach some functions that only work with thinned images to end with a crash or incoherent results.

Todo:
implement...
Enumeration values:
FvsImageGray  no special properties, 8 bit gray level
FvsImageBinarized  marks a binarized image
FvsImageThinned  marks a thinned image


Function Documentation

FvsImage_t ImageCreate void   
 

Create a new image object.

Returns:
NULL if allocation failed, otherwise a new object handle.

void ImageDestroy FvsImage_t    image
 

Destroy an image object.

Parameters:
image pointer to an image object
Returns:
nothing.

FvsError_t ImageSetSize FvsImage_t    image,
const FvsInt_t    width,
const FvsInt_t    height
 

Set the size if an image. The memory allocation is done automatically when needed and the function returns an error if it failed.

Parameters:
image an image object
width width in pixels
height height in pixels
Returns:
an error code.

FvsError_t ImageSetFlag FvsImage_t    image,
const FvsImageFlag_t    flag
 

Set the current image flag. It should only be used in special cases, the flag will mostly be set automatically by the library.

Parameters:
image An image object
Returns:
An error code

FvsImageFlag_t ImageGetFlag const FvsImage_t    image
 

Retrieve the current image flag.

Parameters:
image An image object
Returns:
The flag associated with the image

FvsError_t ImageCopy FvsImage_t    destination,
const FvsImage_t    source
 

Copy a source image into a destination image. The memory allocation and resizing is done automatically when needed.

Parameters:
destination a destination image object
source a source image object
Returns:
an error code.

FvsError_t ImageClear FvsImage_t    image
 

Clear an image. Resets the contents of an image to zero.

Parameters:
image an image object
Returns:
an error code.

FvsError_t ImageFlood FvsImage_t    image,
const FvsByte_t    value
 

Set all pixels in the image to a specific value.

Parameters:
image an image object
value the value of every pixel after the call
Returns:
an error code.

void ImageSetPixel FvsImage_t    image,
const FvsInt_t    x,
const FvsInt_t    y,
const FvsByte_t    val
 

Set a pixel value in the picture.

Parameters:
image an image object
x x-coordinate
y y-coordinate
val value to set
Returns:
nothing

FvsByte_t ImageGetPixel const FvsImage_t    image,
const FvsInt_t    x,
const FvsInt_t    y
 

This function returns the pixel for the x and y value.

Parameters:
image an image object
x x-coordinate
y y-coordinate
Returns:
the pixel value

FvsByte_t* ImageGetBuffer FvsImage_t    image
 

Returns a pointer to the image buffer.

Parameters:
image an image object
Returns:
a pointer to the beginning of the memory buffer

FvsInt_t ImageGetWidth const FvsImage_t    image
 

Retrieve the image width.

Parameters:
image an image object
Returns:
the width in pixels

FvsInt_t ImageGetHeight const FvsImage_t    image
 

Retrieve the image height.

Parameters:
image an image object
Returns:
the heigth in pixels

FvsInt_t ImageGetPitch const FvsImage_t    image
 

Get the pitch. The pitch of an image is not necessary the width of the image. In the image, pixel(x,y) position in the buffer is at x + y * pitch.

Parameters:
image an image object
Returns:
the pitch in bytes

FvsInt_t ImageGetSize const FvsImage_t    image
 

Gets the number of bytes in the image buffer.

Parameters:
image an image object
Returns:
the number of bytes

FvsBool_t ImageCompareSize const FvsImage_t    image1,
const FvsImage_t    image2
 

Compares the sizes of 2 images and returns true if they are the same.

Parameters:
image1 an image object
image2 an image object
Returns:
a boolean value telling if the images are of the same size


Generated on Sat May 31 20:07:30 2003 for FVS Fingerprint Verification System by doxygen 1.3-rc3 Jaap de Haan (BinaryMan)