FVS Fingerprint Verification System API Documentation

minutia.h File Reference

#include "fvstypes.h"
#include "image.h"
#include "floatfield.h"

Go to the source code of this file.

Data Structures

struct  FvsMinutia_t

Typedefs

typedef enum FvsMinutiaType_t FvsMinutiaType_t
typedef FvsMinutia_t FvsMinutia_t
typedef FvsHandle_t FvsMinutiaSet_t

Enumerations

enum  FvsMinutiaType_t { FvsMinutiaTypeEnding = 0, FvsMinutiaTypeBranching = 1, FvsMinutiaTypeCore = 2, FvsMinutiaTypeDelta = 3 }

Functions

FvsMinutiaSet_t MinutiaSetCreate (const FvsInt_t size)
void MinutiaSetDestroy (FvsMinutiaSet_t minutia)
FvsInt_t MinutiaSetGetSize (const FvsMinutiaSet_t minutia)
FvsInt_t MinutiaSetGetCount (const FvsMinutiaSet_t minutia)
FvsMinutia_tMinutiaSetGetBuffer (FvsMinutiaSet_t minutia)
FvsError_t MinutiaSetEmpty (FvsMinutiaSet_t minutia)
FvsError_t MinutiaSetAdd (FvsMinutiaSet_t minutia, const FvsFloat_t x, const FvsFloat_t y, const FvsMinutiaType_t type, const FvsFloat_t angle)
FvsError_t MinutiaSetExtract (FvsMinutiaSet_t minutia, const FvsImage_t image, const FvsFloatField_t direction, const FvsImage_t mask)
FvsError_t MinutiaSetDraw (const FvsMinutiaSet_t minutia, FvsImage_t image)


Typedef Documentation

typedef enum FvsMinutiaType_t FvsMinutiaType_t
 

Definitions for the different minutia types.

typedef struct FvsMinutia_t FvsMinutia_t
 

Minutia structure. We use here the FBI model, we will try to detect as well as possible the position, type and orientation of a minutia.

typedef FvsHandle_t FvsMinutiaSet_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 FvsMinutiaType_t
 

Definitions for the different minutia types.

Enumeration values:
FvsMinutiaTypeEnding  line ending
FvsMinutiaTypeBranching  line branch
FvsMinutiaTypeCore  core point
FvsMinutiaTypeDelta  delta point


Function Documentation

FvsMinutiaSet_t MinutiaSetCreate const FvsInt_t    size
 

Create a new minutia set that may contain at most size minutia.

Parameters:
size maximum number of minutia the set may contain
Returns:
NULL if allocation failed, otherwise a new object handle.

void MinutiaSetDestroy FvsMinutiaSet_t    minutia
 

Delete the memory allocated for the minutia set. After having been destroyed, the minutia set obviously cannot be used anymore in function calls before a new set gets allocated again.

Parameters:
minutia the minutia set to destroy
Returns:
nothing

FvsInt_t MinutiaSetGetSize const FvsMinutiaSet_t    minutia
 

Returns the maximum number of minutia the set may contain.

Parameters:
minutia The minutia set
Returns:
Get the maximum number of minutia that can be stored in the set

FvsInt_t MinutiaSetGetCount const FvsMinutiaSet_t    minutia
 

Returns the number of minutia in the set.

Parameters:
minutia The minutia set
Returns:
The number of minutia in the set

FvsMinutia_t* MinutiaSetGetBuffer FvsMinutiaSet_t    minutia
 

Returns a pointer to the table of minutia.

Parameters:
minutia The minutia set
Returns:
A pointer to the minutia set

FvsError_t MinutiaSetEmpty FvsMinutiaSet_t    minutia
 

Empty the minutia set.

Parameters:
minutia The minutia set to modify
Returns:
An error code

FvsError_t MinutiaSetAdd FvsMinutiaSet_t    minutia,
const FvsFloat_t    x,
const FvsFloat_t    y,
const FvsMinutiaType_t    type,
const FvsFloat_t    angle
 

Add a minutia to the set, returns an error if the set is full.

Parameters:
minutia The minutia set
x The position in the x direction of the minutia
y The position in the y direction of the minutia
type The minutia type
angle The minutia direction in radians
Returns:
An error code

FvsError_t MinutiaSetExtract FvsMinutiaSet_t    minutia,
const FvsImage_t    image,
const FvsFloatField_t    direction,
const FvsImage_t    mask
 

Extract minutia from a thinned image and store them into the set. The allocated set has to be big enough to contain all minutias. If it is too small then detection will stop after the set being filled.

Parameters:
minutia The minutia set to fill in
image The thinned image to extract the minutia from (position and type)
direction The orientation field used to compute the direction
mask A mask telling where valid fingerprint data is present
Returns:
An error code

FvsError_t MinutiaSetDraw const FvsMinutiaSet_t    minutia,
FvsImage_t    image
 

Draw the minutia set into the image. The background is not changed, so that the minutia are drawed as an overlay.

Todo:
allow changes in colors and appearance would be nice...
Parameters:
minutia The minutia set to draw into the image
image The image onto which the minutia should be drawn
Returns:
An error code


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