FVS Fingerprint Verification System API Documentation
	Overview TODO Globals Classes (annotated) Members Source Files

floatfield.h File Reference

#include "fvstypes.h"

Go to the source code of this file.

Typedefs
typedef FvsHandle_t	FvsFloatField_t
Functions
FvsFloatField_t	FloatFieldCreate (void)
void	FloatFieldDestroy (FvsFloatField_t field)
FvsError_t	FloatFieldSetSize (FvsFloatField_t field, const FvsInt_t width, const FvsInt_t height)
FvsError_t	FloatFieldCopy (FvsFloatField_t destination, const FvsFloatField_t source)
FvsError_t	FloatFieldClear (FvsFloatField_t field)
FvsError_t	FloatFieldFlood (FvsFloatField_t field, const FvsFloat_t value)
void	FloatFieldSetValue (FvsFloatField_t field, const FvsInt_t x, const FvsInt_t y, const FvsFloat_t val)
FvsFloat_t	FloatFieldGetValue (const FvsFloatField_t field, const FvsInt_t x, const FvsInt_t y)
FvsFloat_t *	FloatFieldGetBuffer (FvsFloatField_t field)
FvsInt_t	FloatFieldGetWidth (const FvsFloatField_t field)
FvsInt_t	FloatFieldGetHeight (const FvsFloatField_t field)
FvsInt_t	FloatFieldGetPitch (const FvsFloatField_t field)

---

Typedef Documentation

typedef FvsHandle_t FvsFloatField_t

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

---

Function Documentation

FvsFloatField_t FloatFieldCreate (  void    )

Create a new floating point field object. Returns: NULL if allocation failed, otherwise a new object handle.

void FloatFieldDestroy (  FvsFloatField_t    field )

Destroy an existing floating point field object. Parameters: field  pointer to a floating point field object Returns: nothing.

FvsError_t FloatFieldSetSize (  FvsFloatField_t    field, const FvsInt_t    width, const FvsInt_t    height )

Set the size if a floating point field. The memory allocation is done automatically when needed and the function returns an error if it failed. Parameters: field  a floating point field object width  width in pixels height  height in pixels Returns: an error code.

FvsError_t FloatFieldCopy (  FvsFloatField_t    destination, const FvsFloatField_t    source )

Copy a source image into a destination image. The memory allocation and resizing is done automatically when needed. Parameters: destination  a destination floating point field object source  a source floating point field object Returns: an error code.

FvsError_t FloatFieldClear (  FvsFloatField_t    field )

Clear an image. Resets the contents of a floating point field to zero. Parameters: field  a floating point field object Returns: an error code.

FvsError_t FloatFieldFlood (  FvsFloatField_t    field, const FvsFloat_t    value )

Set all values in the floating point field to a specific value. Parameters: field  a floating point field object value  the value of every pixel after the call Returns: an error code.

void FloatFieldSetValue (  FvsFloatField_t    field, const FvsInt_t    x, const FvsInt_t    y, const FvsFloat_t    val )

Set a floating point value in a floating point field at specified coordinates. Parameters: field  a floating point field object x  x-coordinate y  y-coordinate val  value to set Returns: nothing

FvsFloat_t FloatFieldGetValue (  const FvsFloatField_t    field, const FvsInt_t    x, const FvsInt_t    y )

This function returns the value for the x and y coordinates. Parameters: field  a floating point field object x  x-coordinate y  y-coordinate Returns: the floating point value

FvsFloat_t* FloatFieldGetBuffer (  FvsFloatField_t    field )

Returns a pointer to the floating point field buffer. Parameters: field  a floating point field object Returns: a pointer to the beginning of the memory buffer

FvsInt_t FloatFieldGetWidth (  const FvsFloatField_t    field )

Retrieve the floating point field width. Parameters: field  a floating point field object Returns: the width in pixels

FvsInt_t FloatFieldGetHeight (  const FvsFloatField_t    field )

Retrieve the floating point field height. Parameters: field  a floating point field object Returns: the heigth in pixels

FvsInt_t FloatFieldGetPitch (  const FvsFloatField_t    field )

Get the pitch. The pitch of a floating point field is not necessary the width that was specified when setting the size. In the floating point field, the value at position (x,y) in the buffer is at address x + y * pitch. Parameters: field  a floating point field object Returns: the pitch in bytes

---