C# Class Unosquare.Labs.LibFprint.FingerprintGallery

Provides means to keeping a fingerprint database. A fingerprint gallery is needed for fingerprint identification. Fingerprints can be loaded from byte arrays or enrollment results.

Inheritance: IDisposable

Mostra file Open project: unosquare/libfprint-cs Class Usage Examples

Private Properties

Property	Type	Description
GetFingerprintPointer	System.IntPtr
RebuildPointerArray	void
RegisterFingerprintData	void
Remove	void

Public Methods

Method	Description
Add ( string key, Unosquare.Labs.LibFprint.EnrollStageResult enrollResult ) : void	Adds the specified fingerprint data and associates it with the specified key.
Add ( string key, byte fingerprintData ) : void	Adds the specified fingerprint data and associates it with the specified key.
AddRange ( byte[]>.IEnumerable fingerprints ) : void	Adds the specified fingerprint key-value pairs to the gallery. This is the preferred method for bulk loading as it does not rebuild the database for every fingerprint.
AllKeys ( ) : string[]	Gets all the keys registered in this gallery.
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
FingerprintGallery ( ) : System	Initializes a new instance of the FingerprintGallery class.
HasKey ( string key ) : bool	Determines whether the gallery contains the specified keys.
Remove ( string key ) : void	Removes a fingerprint from the gallery given its key
this ( int offset ) : string	Gets the key with the specified offset.

Protected Methods

Method	Description
Dispose ( bool releaseOnlyManaged ) : void	Releases unmanaged and - optionally - managed resources.

Private Methods

Method	Description
GetFingerprintPointer ( string key ) : IntPtr	Gets the fingerprint pointer.
RebuildPointerArray ( ) : void	Rebuilds the pointer array. This method needs to be called whenever the Internal List gets modified in any way.
RegisterFingerprintData ( string key, byte fingerprintData ) : void	Registers the supplied fingerprint data, associating it with the given key.
Remove ( string key, bool rebuild ) : void	Removes a fingerprint from the gallery given its key

Method Details

Add() public method

Adds the specified fingerprint data and associates it with the specified key.

public Add ( string key, Unosquare.Labs.LibFprint.EnrollStageResult enrollResult ) : void
key	string	The key.
enrollResult	Unosquare.Labs.LibFprint.EnrollStageResult	The enroll result.
return	void

Add() public method

Adds the specified fingerprint data and associates it with the specified key.

public Add ( string key, byte fingerprintData ) : void
key	string	The key.
fingerprintData	byte	The fingerprint data.
return	void

AddRange() public method

Adds the specified fingerprint key-value pairs to the gallery. This is the preferred method for bulk loading as it does not rebuild the database for every fingerprint.

public AddRange ( byte[]>.IEnumerable fingerprints ) : void
fingerprints	byte[]>.IEnumerable	The fingerprints.
return	void

AllKeys() public method

Gets all the keys registered in this gallery.

public AllKeys ( ) : string[]
return	string[]

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public Dispose ( ) : void
return	void

Dispose() protected method

Releases unmanaged and - optionally - managed resources.

protected Dispose ( bool releaseOnlyManaged ) : void
releaseOnlyManaged	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.
return	void

FingerprintGallery() public method

Initializes a new instance of the FingerprintGallery class.

public FingerprintGallery ( ) : System
return	System

HasKey() public method

Determines whether the gallery contains the specified keys.

public HasKey ( string key ) : bool
key	string	The key.
return	bool

Remove() public method

Removes a fingerprint from the gallery given its key

public Remove ( string key ) : void
key	string	The key.
return	void

this() public method

Gets the key with the specified offset.

public this ( int offset ) : string
offset	int	The offset.
return	string