GBSFingerprint

java.lang.Object
- com.griaulebiometrics.gbsfingerprint.GBSFingerprint

```
public class GBSFingerprint
extends java.lang.Object
```
GBSFingerprint is the main class of the Java SDK.

This class implements a Singleton. Use the GBSFingerprint.getInstance() method to use the singleton instance.

Field Summary

Fields
Modifier and Type	Field and Description
`static DeviceHandler`	`deviceHandler` The device handler.
`static FingerHandler`	`fingerHandler` The finger handler.
`static FrameHandler`	`frameHandler` The frame handler.
`static ImageHandler`	`imageHandler` The image handler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDeviceListener(DeviceAdapter listener)` Adds a new device listener.
`void`	`addFingerListener(FingerAdapter listener)` Adds a new finger listener.
`void`	`addFrameListener(FrameAdapter listener)` Adds a new frame listener.
`void`	`addImageListener(ImageAdapter listener)` Adds a new image listener.
`Image`	`biometricDisplay(Image image, Template template)` Draws over a fingerprint image all minutiae and segments contained in the supplied template.
`int`	`calculateFingerprintContrast(Image fingerprint)` Calculates the fingerprint image contrast
`int`	`calculateFingerprintNFIQ(Image fingerprint)` Calculates the fingerprint NFIQ
`void`	`capture(java.lang.String device)` Perform a forced capture from the supplied fingerprint reader.
`void`	`configureExtraction(ExtractionParameters parameters)` Sets the desired extractions parameters.
`ConsolidationResult`	`consolidate(Image fingerprint, TemplateFormat format, TemplateEncoding encoding)` Consolidates a template using the supplied fingerprint image.
`Image`	`convertImage(Image image, ImageFormat format)` Converts the supplied image into a another image, using a different format.
`Template`	`convertTemplate(Template template, TemplateFormat format, TemplateEncoding encoding)` Converts a template into a different template, possibly using different format and/or encoding.
`Minutia[]`	`deserializeTemplate(Template template)` Deserializes a template into an array of minutiae.
`Template`	`extractTemplate(Image image, TemplateFormat format, TemplateEncoding encoding)` Extracts a fingerprint template from the supplied fingerprint raw image.
`void`	`finalize()` Finalizes the GBS Fingerprint SDK library, freeing all resources used.
`CaptureInfo`	`getCaptureInfo(java.lang.String device)` This method calls the device to exhibit capture information about the last imageCallback() event.
`CaptureType`	`getCaptureType(java.lang.String device)` Gets the capture type for the supplied fingerprint reader.
`java.util.Map<java.lang.String,java.lang.String>`	`getDeviceInfo(java.lang.String device)`
`ImageConversionParameters`	`getImageConversionParameters()` Gets the image conversion parameters.
`static GBSFingerprint`	`getInstance()` Gets the singleton GBSFingerprint instance.
`Image`	`getProcessedImage(ProcessedImageType type)` Gets a image processed during the extraction.
`ReaderInfo`	`getReaderInfo(java.lang.String device)` This method exhibits hardware and firmware information about the currently connected device.
`VerificationParameters`	`getVerificationParameters()` Gets the verification parameters.
`Version`	`getVersion()` Gets the fingerprint version
`void`	`GSDAddPath(java.io.File path)` Adds a new path to look for the file configured with GSDConfigure.
`void`	`GSDConfigure(GSDMethod method, java.lang.String filename)` Configures the Griaule Spoof Detect.
`int`	`GSDTest(Image fingerprint)` Tests an image to get it spoof score.
`void`	`initialize()` Initializes the GBS Fingerprint SDK library, the capture module and checks for a valid license on system.
`Image`	`loadImage(java.io.File file)` Loads an image from a file.
`void`	`saveImage(Image image, java.lang.String filepath)` Saves an image to a file.
`java.util.List<Image>`	`segmentCard(Image fingerprint)` Segments the current card image into N images, each containing a single fingerprint.
`java.util.List<Image>`	`segmentFourFingers(Image fingerprint)` Segments the current image in four images, each containing a single fingerprint.
`java.util.List<Image>`	`segmentNFingers(Image fingerprint, int nfingers)` Segments the current image into N images, each containing a single fingerprint.
`java.util.List<Image>`	`segmentTwoFingers(Image fingerprint)` Segments the current image in two images, each containing a single fingerprint.
`Template`	`serializeTemplate(Minutia[] minutiae, TemplateFormat format, TemplateEncoding encoding)` Converts an array of minutiae into an template.
`void`	`setBiometricDisplayColors(BiometricDisplayColors colors)` Sets the colors used for the biometric display for each element.
`void`	`setBiometricDisplayOptions(BiometricDisplayOptions options)` Sets the options used for the biometric display for each element.
`void`	`setCaptureType(CaptureType captureType)` Sets the automatic capture type for all fingerprint readers.
`void`	`setDeviceInfo(java.lang.String device, java.util.Map<java.lang.String,java.lang.String> configurations)` Sets the device information
`void`	`setImageConversionParameters(ImageConversionParameters parameters)` Sets the image conversion parameters.
`void`	`setLicenseFolder(java.lang.String host)` Sets the folder in which GBS Fingerprint SDK should search for its licenses.
`void`	`setLicenseServerHost(java.lang.String host)` Sets the server host in which GBS Fingerprint SDK should search for its floating licenses.
`void`	`setVerificationParameters(VerificationParameters parameters)` Sets the verification parameters.
`void`	`startCapturing(java.lang.String device)` Starts capturing fingerprint images from the supplied fingerprint reader.
`void`	`startConsolidation()` Starts a consolidation process.
`void`	`stopCapturing(java.lang.String device)` Stops capturing fingerprint images from the supplied fingerprint reader.
`void`	`twinCompute(Template query, Template reference, MatchPair[] pairs, int maxpairs)` Computes the twin locked cursor
`Point`	`twinDirect(Point query)` Calculates the direct point (query -> reference)
`Point`	`twinReverse(Point reference)` Calculates the reverse point (reference -> query)
`VerificationResult`	`verify(Template query, Template reference)` Performs a verification by comparing the two supplied templates.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deviceHandler

public static final DeviceHandler deviceHandler

The device handler.

fingerHandler

public static final FingerHandler fingerHandler

The finger handler.

imageHandler

public static final ImageHandler imageHandler

The image handler.

frameHandler

public static final FrameHandler frameHandler

The frame handler.

Method Detail

getInstance
```
public static GBSFingerprint getInstance()
```
Gets the singleton GBSFingerprint instance.

Returns:

GBSFingerprint

addDeviceListener
```
public void addDeviceListener(DeviceAdapter listener)
```
Adds a new device listener.

For an example, see startCapturing.

This method must be called before the initialization of the GBS Fingerprint SDK library.

Parameters:

listener - The device listener to be added

addFingerListener

public void addFingerListener(FingerAdapter listener)

Adds a new finger listener.

The following example outputs a message whenever a finger enters or leaves a fingerprint reader.

 final GBSFingerprint sdk = GBSFingerprint.getInstance();

 sdk.addFingerListener(new FingerAdapter() {
     public void onFingerDown(String device) {
         System.out.println("Finger down on " + device);
     }
     
     public void onFingerUp(String device) {
         System.out.println("Finger up on " + device);
     }
 });

This method must be called before the initialization of the GBS Fingerprint SDK library.

Parameters:: listener - The finger listener to be added

addImageListener
```
public void addImageListener(ImageAdapter listener)
```
Adds a new image listener.

For an example, see extractTemplate).

This method must be called before the initialization of the GBS Fingerprint SDK library.

Parameters:

listener - The image listener to be added

addFrameListener

public void addFrameListener(FrameAdapter listener)

Adds a new frame listener.

The following example outputs a message whenever a frame is captured..

 final GBSFingerprint sdk = GBSFingerprint.getInstance();

 sdk.addFrameListener(new FrameAdapter() {
     public void onCapture(String device, Image image) {
         System.out.println("Frame captured on " + device);
     }
 });

This method must be called before the initialization of the GBS Fingerprint SDK library.

Parameters:: listener - The frame listener to be added

initialize
```
public void initialize()
                throws GBSFingerprintException
```
Initializes the GBS Fingerprint SDK library, the capture module and checks for a valid license on system.

A valid license must exist on the system or on a floating license server.

Before initializing the SDK, you should register the event listeners. For more information about listeners, see the interfaces DeviceAdapter, ImageAdapter, FingerAdapter, and FrameAdapter and the respective methods addDeviceListener, addImageListener, addFingerListener and addFrameListener.

Throws:

GBSFingerprintException

finalize
```
public void finalize()
```
Finalizes the GBS Fingerprint SDK library, freeing all resources used.

The GBS Fingerprint SDK library must have been previously initialized.

Overrides:

finalize in class java.lang.Object

startCapturing

public void startCapturing(java.lang.String device)
                    throws GBSFingerprintException

Starts capturing fingerprint images from the supplied fingerprint reader.

The following code adds a device event handler that automatically starts/stops capturing images as soon as a device is plugged/unplugged.

 final GBSFingerprint sdk = GBSFingerprint.getInstance();
 
 sdk.addDeviceListener(new DeviceAdapter() {
     public void onPlug(String device) {
         try {
             sdk.startCapturing(device);
             sdk.setCaptureType(CaptureType.ROLLED);
         } catch (GBSFingerprintException e) {
             // Handle exception
         }
     }
 
     public void onUnplug(String device) {
         try {
             sdk.stopCapturing(device);
         } catch (GBSFingerprintException e) {
             // Handle exception
         }
     }
 });

The fingerprint capture module must have been previously initialized.

The supplied fingerprint reader must be connected, working and recognized as plugged by the capture module.

Parameters:: device - The id of the fingerprint reader
Throws:: GBSFingerprintException

stopCapturing
```
public void stopCapturing(java.lang.String device)
                   throws GBSFingerprintException
```
Stops capturing fingerprint images from the supplied fingerprint reader.

For an example, see startCapturing.

The fingerprint capture module must have been previously initialized.

Image capture must have been previously started on the supplied fingerprint reader.

Parameters:

device - The id of the fingerprint reader

Throws:

GBSFingerprintException

capture
```
public void capture(java.lang.String device)
             throws GBSFingerprintException
```
Perform a forced capture from the supplied fingerprint reader.

The fingerprint capture module must have been previously initialized.

Image capture must have been previously started on the supplied fingerprint reader.

Parameters:

device - The id of the fingerprint reader.

Throws:

GBSFingerprintException

extractTemplate

public Template extractTemplate(Image image,
                                TemplateFormat format,
                                TemplateEncoding encoding)
                         throws GBSFingerprintException

Extracts a fingerprint template from the supplied fingerprint raw image.

The following code extracts a template from an image loaded from a file, gets the biometric display for it and saves it to another file, assuming the SDK has already been previously initialized.

 try {
     Image fileImage = sdk.loadImage("C:/fingerprint.png");
     Image rawImage  = sdk.convertImage(fileImage, ImageFormat.RAW);
 
     Template tpt = sdk.extractTemplate(rawImage, TemplateFormat.DEFAULT, TemplateEncoding.BASE64);
 
     BiometricDisplayColors colors = new BiometricDisplayColors();
     colors.setDirection(0xFF0000);
     colors.setMatchedDirection(0xFF00FF);
     colors.setMinutiae(0x00FF00);
     colors.setMatchedMinutiae(0xFF00FF);
     colors.setSegment(0x0000FF);
     colors.setMatchedSegment(0xFF00FF);
 
     sdk.setBiometricDisplayColors(colors);
 
     Image bioImage = sdk.biometricDisplay(rawImage, tpt);
     Image bioPNGImage = sdk.convertImage(bioImage, ImageFormat.PNG);
 
     sdk.saveImage(bioPNGImage, "C:/bioFingerprint.png");
 } catch (GBSFingerprintException e) {
     // Handle exception
 }

The following code adds an image event handler that automatically extracts all images received.

 final GBSFingerprint sdk = GBSFingerprint.getInstance();
 
 sdk.addImageListener(new ImageAdapter() {
     public void onCapture(String device, Image image) {
         try {
             Image rawImage = sdk.convertImage(image, ImageFormat.RAW);
             Template tpt = sdk.extractTemplate(rawImage, TemplateFormat.DEFAULT, TemplateEncoding.BASE64);
 
             // Do something useful with your extracted template
             doSomething(tpt);
         } catch (GBSFingerprintException e) {
             // Handle exception
         }
     }
 });

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:: image - A raw grayscale fingerprint image; format - The format desired for the extracted template; encoding - The encoding desired for the extracted template
Returns:: The extracted template
Throws:: GBSFingerprintException

deserializeTemplate
```
public Minutia[] deserializeTemplate(Template template)
                              throws GBSFingerprintException
```
Deserializes a template into an array of minutiae.

Parameters:

template -

Returns:

Minutia[]

Throws:

GBSFingerprintException

serializeTemplate

public Template serializeTemplate(Minutia[] minutiae,
                                  TemplateFormat format,
                                  TemplateEncoding encoding)
                           throws GBSFingerprintException

Converts an array of minutiae into an template.

Parameters:: minutiae -
Returns:: Template
Throws:: GBSFingerprintException

convertTemplate
```
public Template convertTemplate(Template template,
                                TemplateFormat format,
                                TemplateEncoding encoding)
                         throws GBSFingerprintException
```
Converts a template into a different template, possibly using different format and/or encoding.

The following code converts a given template, obtained from a previous call to extractTemplate, into a new template using ASCII encoding and the same format, assuming the SDK has already been previously initialized.
```
 Template asciiTemplate = sdk.convertTemplate(tpt, tpt.format, TemplateEncoding.ASCII);
 
```
The GBS Fingerprint SDK library must have been previously initialized.
Parameters:

template - The original template to be converted

format - The format desired for the converted template

encoding - The encoding desired for the converted template

Returns:

The converted template

Throws:

GBSFingerprintException

setCaptureType
```
public void setCaptureType(CaptureType captureType)
                    throws GBSFingerprintException
```
Sets the automatic capture type for all fingerprint readers.

The following code checks the capture type currently set for a previously connected reader; if it's not rolled, sets it to rolled type, assuming the SDK has already been previously initialized.
```
 try {
     if (sdk.getCaptureType(sensor) != CaptureType.ROLLED) {
         sdk.setCaptureType(CaptureType.ROLLED);
     }
 } catch (GBSFingerprintException e) {
     // Handle exception
 }
 
```
The fingerprint capture module must have been previously initialized.
Parameters:

captureType - The capture type to be set

Throws:

GBSFingerprintException

getCaptureType
```
public CaptureType getCaptureType(java.lang.String device)
                           throws GBSFingerprintException
```
Gets the capture type for the supplied fingerprint reader.

For an example, see setCaptureType.

The fingerprint capture module must have been previously initialized.

Parameters:

device - The id of the fingerprint reader

Returns:

The current capture type

Throws:

GBSFingerprintException

convertImage
```
public Image convertImage(Image image,
                          ImageFormat format)
                   throws GBSFingerprintException
```
Converts the supplied image into a another image, using a different format.

For an example, see extractTemplate.

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:

image - The original image to be converted

format - The format desired for the converted image

Returns:

The converted image

Throws:

GBSFingerprintException

saveImage
```
public void saveImage(Image image,
                      java.lang.String filepath)
               throws GBSFingerprintException
```
Saves an image to a file.

For an example, see extractTemplate.

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:

image - The image to be saved

filepath - The path to save the image on

Throws:

GBSFingerprintException

loadImage
```
public Image loadImage(java.io.File file)
                throws GBSFingerprintException
```
Loads an image from a file.

For an example, see extractTemplate.

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:

file - The path to load the image from

Returns:

The loaded image

Throws:

GBSFingerprintException

biometricDisplay
```
public Image biometricDisplay(Image image,
                              Template template)
                       throws GBSFingerprintException
```
Draws over a fingerprint image all minutiae and segments contained in the supplied template.

For an example, see extractTemplate.

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:

image - The original fingerprint image

template - The template extracted from the image

Returns:

The resulting image with all elements drawn, in RGB format

Throws:

GBSFingerprintException

setBiometricDisplayColors
```
public void setBiometricDisplayColors(BiometricDisplayColors colors)
                               throws GBSFingerprintException
```
Sets the colors used for the biometric display for each element.

For an example, see extractTemplate.

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:

colors - The colors used for the biometric display

Throws:

GBSFingerprintException

setBiometricDisplayOptions
```
public void setBiometricDisplayOptions(BiometricDisplayOptions options)
                                throws GBSFingerprintException
```
Sets the options used for the biometric display for each element.

For an example, see extractTemplate.

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:

options - The options used for the biometric display

Throws:

GBSFingerprintException

configureExtraction
```
public void configureExtraction(ExtractionParameters parameters)
                         throws GBSFingerprintException
```
Sets the desired extractions parameters.

The following code enables all existing parameters for the extraction, assuming the SDK has already been previously initialized.
```
 ExtractionParameters params = new ExtractionParameters();
 
 params.setExtractFFT(true);
 params.setExtractSingularities(true);
 params.setExtractProcessedImages(true);
 
 sdk.setExtractionParameters(params);
 
```
The GBS Fingerprint SDK library must have been previously initialized.
Parameters:

parameters - The desired extraction parameters to be set

Throws:

GBSFingerprintException

getProcessedImage
```
public Image getProcessedImage(ProcessedImageType type)
                        throws GBSFingerprintException
```
Gets a image processed during the extraction.

Parameters:

type -

Returns:

Image

Throws:

GBSFingerprintException

setLicenseServerHost
```
public void setLicenseServerHost(java.lang.String host)
                          throws GBSFingerprintException
```
Sets the server host in which GBS Fingerprint SDK should search for its floating licenses.

The following code sets the license server address to '192.168.1.1' on port 8002, assuming the SDK has already been previously initialized.
```
 try {
     sdk.SetLicenseServerHost("http://192.168.1.1:8002");
 } catch (GBSFingerprintException e) {
     // Handle exception
 }
 
```
This method must be called before the initialization of the GBS Fingerprint SDK library.
Parameters:

host - The server host in which GBS Fingerprint SDK should search for its floating licenses

Throws:

GBSFingerprintException

setLicenseFolder
```
public void setLicenseFolder(java.lang.String host)
                      throws GBSFingerprintException
```
Sets the folder in which GBS Fingerprint SDK should search for its licenses.

The following code sets the license folder to "C:/Temp", assuming the SDK has already been previously initialized.
```
 try {
     sdk.setLicenseFolder("C:/Temp");
 } catch (GBSFingerprintException e) {
     // Handle exception
 }
 
```
This method must be called before the initialization of the GBS Fingerprint SDK library.
Parameters:

host - The server host in which GBS Fingerprint SDK should search for its floating licenses

Throws:

GBSFingerprintException

setVerificationParameters
```
public void setVerificationParameters(VerificationParameters parameters)
                               throws GBSFingerprintException
```
Sets the verification parameters.

For an example, see verify.
The GBS Fingerprint SDK library must have been previously initialized.

Parameters:

parameters - The desired verification parameters

Throws:

GBSFingerprintException

getVerificationParameters
```
public VerificationParameters getVerificationParameters()
                                                 throws GBSFingerprintException
```
Gets the verification parameters.

The following code attempts to retrieve the current verification parameters, assuming the SDK has already been previously initialized.
```
 try {
     VerificationParameters verifParams = sdk.getVerificationParameters();
 } catch (GBSFingerprintException e) {
     // Handle exception
 }
 
```
The GBS Fingerprint SDK library must have been previously initialized.
Returns:

The current verification parameters

Throws:

GBSFingerprintException

verify

public VerificationResult verify(Template query,
                                 Template reference)
                          throws GBSFingerprintException

Performs a verification by comparing the two supplied templates.

The following code sets a minimum score of 35 for matching and verifies if two templates extracted from two previously acquired raw images match, assuming the SDK has already been previously initialized.

 try {
     Template tptOne = sdk.extractTemplate(imageOne, TemplateFormat.DEFAULT, TemplateEncoding.BASE64);
     Template tptTwo = sdk.extractTemplate(imageTwo, TemplateFormat.DEFAULT, TemplateEncoding.BASE64);
 
     sdk.setVerificationParameters(new VerificationParameters(35, 90));
 
     VerificationResult res = sdk.verify(tptOne, tptTwo);
     if (res.hasMatched()) {
         // Templates match, res.getScore() >= 35
     } else {
         // Templates don't match, res.getScore() < 35
     }
 } catch (GBSFingerprintException e) {
     // Handle exception
 }

The GBS Fingerprint SDK library must have been previously initialized.

Parameters:: query - Query template to be verified; reference - Reference template for verification
Returns:: The result of the verification process
Throws:: GBSFingerprintException

getImageConversionParameters
```
public ImageConversionParameters getImageConversionParameters()
                                                       throws GBSFingerprintException
```
Gets the image conversion parameters.

For an example, see setImageConversionParameters.
The GBS Fingerprint SDK library must have been previously initialized.

Returns:

The current image conversion parameters

Throws:

GBSFingerprintException

setImageConversionParameters

public void setImageConversionParameters(ImageConversionParameters parameters)
                                  throws GBSFingerprintException

Sets the image conversion parameters.

The following code alters the current image conversion parameters to set the JPEQ quality to 100, assuming the SDK has already been previously initialized.

 try {
     ImageConversionParameters parameters = sdk.getImageConversionParameters();
     
     parameters.setJPEGQuality(100);
     
     sdk.setImageConversionParameters(parameters);
 } catch (GBSFingerprintException e) {
     // Handle exception
 }

Parameters:: parameters - The desired image conversion parameters
Throws:: GBSFingerprintException

startConsolidation
```
public void startConsolidation()
                        throws GBSFingerprintException
```
Starts a consolidation process.

For an example, see consolidate.
The GBS Fingerprint SDK library must have been previously initialized.

Throws:

GBSFingerprintException

consolidate

public ConsolidationResult consolidate(Image fingerprint,
                                       TemplateFormat format,
                                       TemplateEncoding encoding)
                                throws GBSFingerprintException

Consolidates a template using the supplied fingerprint image.

The following code starts capturing images on a previously connected sensor to consolidate a template, assuming the SDK has already been previously initialized with the image event listener below.

 sdk.startConsolidation();
 sdk.startCapturing(sensor);
 }

 sdk.addImageListener(new ImageAdapter() {
     public void onCapture(String device, Image image) {
         try {
             Image rawImage = sdk.convertImage(image, ImageFormat.RAW);
 
             ConsolidationResult consRes = sdk.consolidate(rawImage, TemplateFormat.DEFAULT, TemplateEncoding.BASE64);
 
             // Consolidation completed
             if (consRes.getStatus() != ConsolidationStatus.NOT_READY) {
                 // Do something with the consolidated template
                 doSomething(consRes.getTemplate(), consRes.getQuality());
 
                 // Done consolidating
                 sdk.stopCapturing(device);
             }
         } catch (GBSFingerprintException e) {
             // Handle exception
         }
     }
 });

The GBS Fingerprint SDK library must have been previously initialized.

A consolidation process must have been previously started.

Parameters:: fingerprint - A raw grayscale fingerprint image; format - The format desired for the consolidated template; encoding - The encoding desired for the consolidated template
Returns:: The result of the consolidation process
Throws:: GBSFingerprintException

segmentTwoFingers

public java.util.List<Image> segmentTwoFingers(Image fingerprint)
                                        throws GBSFingerprintException

Segments the current image in two images, each containing a single fingerprint.

The following code loads an image from the disk containing 2 fingerprints, segments it and extracts each segmented image, assuming the SDK has already been previously initialized.

 try {
     Image twoFingers = sdk.loadImage("C:/twoFinger.png");
     
     List segmentedImages = sdk.segmentTwoFingers(twoFingers);
     
     Template firstFinger  = sdk.extractTemplate(segmentedImages.get(0), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     Template secondFinger = sdk.extractTemplate(segmentedImages.get(1), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     
     // Do something with the extracted templates
     doSomething(firstFinger, secondFinger);
 }  catch (GBSFingerprintException e) {
     // Handle exception
 }

The GBS Fingerprint SDK library must have been previously initialized.

A Professional License is required to use this method.

Parameters:: fingerprint - The image to be segmented
Returns:: The segmented images
Throws:: GBSFingerprintException

segmentFourFingers

public java.util.List<Image> segmentFourFingers(Image fingerprint)
                                         throws GBSFingerprintException

Segments the current image in four images, each containing a single fingerprint.

The following code loads an image from the disk containing 4 fingerprints, segments it and extracts each segmented image, assuming the SDK has already been previously initialized.

 try {
     Image twoFingers = sdk.loadImage("C:/twoFinger.png");
     
     List segmentedImages = sdk.segmentFourFingers(fourFingers);
     
     Template firstFinger  = sdk.extractTemplate(segmentedImages.get(0), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     Template secondFinger = sdk.extractTemplate(segmentedImages.get(1), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     Template thirdFinger  = sdk.extractTemplate(segmentedImages.get(2), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     Template fourthFinger = sdk.extractTemplate(segmentedImages.get(3), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     
     // Do something with the extracted templates
     doSomething(firstFinger, secondFinger);
 }  catch (GBSFingerprintException e) {
     // Handle exception
 }

The GBS Fingerprint SDK library must have been previously initialized.

A Professional License is required to use this method.

Parameters:: fingerprint - The image to be segmented
Returns:: The segmented images
Throws:: GBSFingerprintException

segmentNFingers

public java.util.List<Image> segmentNFingers(Image fingerprint,
                                             int nfingers)
                                      throws GBSFingerprintException

Segments the current image into N images, each containing a single fingerprint.

The following code loads an image from the disk containing n fingerprints, segments it and extracts each segmented image, assuming the SDK has already been previously initialized.

 try {
     Image twoFingers = sdk.loadImage("C:/twoFinger.png");
     
     List segmentedImages = sdk.segmentFourFingers(fourFingers);
     
     Template firstFinger  = sdk.extractTemplate(segmentedImages.get(0), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     Template secondFinger = sdk.extractTemplate(segmentedImages.get(1), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     ...
     Template fourthFinger = sdk.extractTemplate(segmentedImages.get(n-1), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     
     // Do something with the extracted templates
     doSomething(firstFinger, secondFinger);
 }  catch (GBSFingerprintException e) {
     // Handle exception
 }

The GBS Fingerprint SDK library must have been previously initialized.

A Professional License is required to use this method.

Parameters:: fingerprint - The image to be segmented
Returns:: The segmented images
Throws:: GBSFingerprintException

segmentCard

public java.util.List<Image> segmentCard(Image fingerprint)
                                  throws GBSFingerprintException

Segments the current card image into N images, each containing a single fingerprint.

The following code loads an image from the disk containing n fingerprints, segments it and extracts each segmented image, assuming the SDK has already been previously initialized.

 try {
     Image twoFingers = sdk.loadImage("C:/twoFinger.png");
     
     List segmentedImages = sdk.segmentFourFingers(fourFingers);
     
     Template firstFinger  = sdk.extractTemplate(segmentedImages.get(0), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     Template secondFinger = sdk.extractTemplate(segmentedImages.get(1), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     ...
     Template fourthFinger = sdk.extractTemplate(segmentedImages.get(n-1), TemplateFormat.DEFAULT, TemplateEncoding.ASCII);
     
     // Do something with the extracted templates
     doSomething(firstFinger, secondFinger);
 }  catch (GBSFingerprintException e) {
     // Handle exception
 }

The GBS Fingerprint SDK library must have been previously initialized.

A Professional License is required to use this method.

Parameters:: fingerprint - The image to be segmented
Returns:: The segmented images
Throws:: GBSFingerprintException

setDeviceInfo

public void setDeviceInfo(java.lang.String device,
                          java.util.Map<java.lang.String,java.lang.String> configurations)
                   throws GBSFingerprintException

Sets the device information

Parameters:: device -; configurations -
Throws:: GBSFingerprintException

getDeviceInfo

public java.util.Map<java.lang.String,java.lang.String> getDeviceInfo(java.lang.String device)

getReaderInfo
```
public ReaderInfo getReaderInfo(java.lang.String device)
                         throws GBSFingerprintException
```
This method exhibits hardware and firmware information about the currently connected device.

Returns:

ReaderInfo object

Throws:

GBSFingerprintException

getCaptureInfo
```
public CaptureInfo getCaptureInfo(java.lang.String device)
                           throws GBSFingerprintException
```
This method calls the device to exhibit capture information about the last imageCallback() event.

Returns:

CaptureInfo object

Throws:

GBSFingerprintException

calculateFingerprintContrast
```
public int calculateFingerprintContrast(Image fingerprint)
                                 throws GBSFingerprintException
```
Calculates the fingerprint image contrast

Parameters:

fingerprint -

Returns:

int

Throws:

GBSFingerprintException

calculateFingerprintNFIQ

public int calculateFingerprintNFIQ(Image fingerprint)
                             throws GBSFingerprintException

Calculates the fingerprint NFIQ

Parameters:: fingerprint -
Returns:: int
Throws:: GBSFingerprintException

twinCompute

public void twinCompute(Template query,
                        Template reference,
                        MatchPair[] pairs,
                        int maxpairs)
                 throws GBSFingerprintException

Computes the twin locked cursor

Parameters:: query -; reference -; pairs -; maxpairs -
Throws:: GBSFingerprintException

twinDirect
```
public Point twinDirect(Point query)
                 throws GBSFingerprintException
```
Calculates the direct point (query -> reference)

Parameters:

query -

Returns:

Point

Throws:

GBSFingerprintException

twinReverse
```
public Point twinReverse(Point reference)
                  throws GBSFingerprintException
```
Calculates the reverse point (reference -> query)

Parameters:

reference -

Returns:

Point

Throws:

GBSFingerprintException

getVersion

public Version getVersion()
                   throws GBSFingerprintException

Gets the fingerprint version

Returns:: Version
Throws:: GBSFingerprintException

GSDConfigure

public void GSDConfigure(GSDMethod method,
                         java.lang.String filename)
                  throws GBSFingerprintException

Configures the Griaule Spoof Detect.

Parameters:: method -; filename -
Throws:: GBSFingerprintException

GSDAddPath
```
public void GSDAddPath(java.io.File path)
                throws GBSFingerprintException
```
Adds a new path to look for the file configured with GSDConfigure.

Parameters:

path -

Throws:

GBSFingerprintException

GSDTest
```
public int GSDTest(Image fingerprint)
            throws GBSFingerprintException
```
Tests an image to get it spoof score.

Parameters:

fingerprint -

Returns:

spoof score

Throws:

GBSFingerprintException

Class GBSFingerprint

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

deviceHandler

fingerHandler

imageHandler

frameHandler

Method Detail

getInstance

addDeviceListener

addFingerListener

addImageListener

addFrameListener

initialize

finalize

startCapturing

stopCapturing

capture

extractTemplate

deserializeTemplate

serializeTemplate

convertTemplate

setCaptureType

getCaptureType

convertImage

saveImage

loadImage

biometricDisplay

setBiometricDisplayColors

setBiometricDisplayOptions

configureExtraction

getProcessedImage

setLicenseServerHost

setLicenseFolder

setVerificationParameters

getVerificationParameters

verify

getImageConversionParameters

setImageConversionParameters

startConsolidation

consolidate

segmentTwoFingers

segmentFourFingers

segmentNFingers

segmentCard

setDeviceInfo

getDeviceInfo

getReaderInfo

getCaptureInfo

calculateFingerprintContrast

calculateFingerprintNFIQ

twinCompute

twinDirect

twinReverse

getVersion

GSDConfigure

GSDAddPath

GSDTest