PBBiometry Class Reference

#import <PBBiometry.h>

List of all members.

Public Member Functions
(PBBiometryStatus)	- enrollFinger:database:gui:nbrOfImages:config:
(PBBiometryStatus)	- verifyFingers:database:gui:config:matchingFinger:
(PBBiometryStatus)	- verifyFingers:database:gui:verifier:config:matchingFinger:
(PBBiometryStatus)	- captureImagesWithGUI:
(PBBiometryStatus)	- captureImagesWithGUI:minimumQuality:minimumArea:
(PBBiometryStatus)	- cancel

Static Public Member Functions
(PBBiometry *)	+ sharedBiometry
(NSString *)	+ stringFromStatus:

Protected Attributes
BOOL	isEnrolling
BOOL	isVerifying
BOOL	isCapturing

---

Detailed Description

Class containing the main biometric operations, enrollFinger and verifyFinger.

Definition at line 104 of file PBBiometry.h.

---

Member Function Documentation

- (PBBiometryStatus) cancel

Cancels the enrollment, verification or image capturing process.

Returns:

PBBiometryStatusOK if successful, or an error code.

- (PBBiometryStatus) captureImagesWithGUI:

(id< PBBiometryGUI >)

gui

Captures images from a fingerprint sensor.

Parameters:

[in]

gui

is the GUI module that will display the image capturing progress.

Returns:

PBBiometryStatusOK if successful, or an error code.

- (PBBiometryStatus) captureImagesWithGUI:		(id< PBBiometryGUI >)	gui
minimumQuality:		(uint8_t)	minimumQuality
minimumArea:		(uint32_t)	minimumArea

Captures images from a fingerprint sensor. Use this method instead of captureImagesWithGUI: when there is requirements on quality and area for the captured images. Note: Implement the displayChosenImage: for the GUI to display the images with enough quality and area. displayImage: will still be called for all images, including images that do not pass the quality and area restrictions.

Parameters:

[in]	gui	is the GUI module that will display the image capturing progress.
[in]	minimumQuality	is the minimum quality required for a fingerprint image to be captured. The quality value ranges from 0 (worst quality) to 100 (best quality).
[in]	minimumArea	is the minimum fingerprint area, in mm^2 required for a fingerprint image to be captured.

Returns:

PBBiometryStatusOK if successful, or an error code.

- (PBBiometryStatus) enrollFinger:		(PBBiometryFinger *)	finger
database:		(id< PBBiometryDatabase >)	database
gui:		(id< PBBiometryGUI >)	gui
nbrOfImages:		(uint8_t)	nbrOfImages
config:		(PBBiometryEnrollConfig *)	config

Captures x images from a fingerprint sensor. A template is then extracted from the "best" image out of the x images and that template is enrolled in the database.

Parameters:

[in]	finger	is the finger to be enrolled.
[in]	database	is the database module in which the enrolled template will be saved.
[in]	gui	is the GUI module that will display the enrollment progress.
[in]	nbrOfImages	is the number of images to be captured and used for selecting the "best" image. It is recommended to use 3-5 images.
[in]	config	is the config parameters for the enrollment.

Returns:

PBBiometryStatusOK if successful, or an error code.

+ (PBBiometry*) sharedBiometry

+ (NSString*) stringFromStatus:

(PBBiometryStatus)

status

Converts a biometry status code to a readable string.

- (PBBiometryStatus) verifyFingers:		(NSArray *)	fingers
database:		(id< PBBiometryDatabase >)	database
gui:		(id< PBBiometryGUI >)	gui
config:		(PBBiometryVerifyConfig *)	config
matchingFinger:		(PBBiometryFinger **)	matchingFinger

Extracts a template from an image captured from a fingerprint sensor and verifies it against templates stored in the database. The internal verifier will be used.

Parameters:

[in]	fingers	is an array of fingers to verify against. Will be input to the database to deliver the correct templates.
[in]	database	is the database module in which the enrolled templates has been saved.
[in]	gui	is the GUI module that will display the verification progress.
[in]	config	is the config parameters for the verification.
[out]	matchingFinger	is the matching finger of the verification, or nil if no finger matched.

Returns:

PBBiometryStatusOK if successful, or an error code.

- (PBBiometryStatus) verifyFingers:		(NSArray *)	fingers
database:		(id< PBBiometryDatabase >)	database
gui:		(id< PBBiometryGUI >)	gui
verifier:		(id< PBBiometryVerifier >)	verifier
config:		(PBBiometryVerifyConfig *)	config
matchingFinger:		(PBBiometryFinger **)	matchingFinger

Extracts a template from an image captured from a fingerprint sensor and verifies it against templates stored in the database. The method allows for external verifiers to be used, e.g. to be able to do a match-on-card.

Parameters:

[in]	fingers	is an array of fingers to verify against. Will be input to the database to deliver the correct templates.
[in]	database	is the database module in which the enrolled templates has been saved.
[in]	gui	is the GUI module that will display the verification progress.
[in]	verifier	is the verifier module that will do the actual comparison of the templates. This allows for external verifiers e.g. for match-on-card verifiers. All external verifiers that support any of the possible template types may be used. Also make sure that the correct template type is specified, both for enrollment and for verification. Passing nil as verifier is the same as calling verifyFingers:database:gui:config:matchingFinger: in which case the internal verifier will be used.
[in]	config	is the config parameters for the verification.
[out]	matchingFinger	is the matching finger of the verification, or nil if no finger matched.

Returns:

PBBiometryStatusOK if successful, or an error code.

---

Member Data Documentation

- (BOOL) isCapturing

protected

Definition at line 107 of file PBBiometry.h.

- (BOOL) isEnrolling

protected

Definition at line 105 of file PBBiometry.h.

- (BOOL) isVerifying

protected

Definition at line 106 of file PBBiometry.h.

---

The documentation for this class was generated from the following file:

• PBBiometry.h