Package ai.tech5.sdk.abis.finger

Class T5FingerAuth

java.lang.Object

ai.tech5.sdk.abis.finger.T5FingerAuth

public class T5FingerAuth
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
int	MAX_HEIGHT	maximum image height
int	MAX_WIDTH	maximum image width

Constructor Summary

Constructors

Constructor	Description
T5FingerAuth()

Method Summary

Modifier and Type	Method	Description
byte[]	allocateTemplateMinex(int minexType, int numFingers)	The function allocates memory for buffer that will receives INCITS 378 compliance template
byte[]	allocateTemplateTech5(byte fpType)	The function allocates memory for template variable
void	closeSDK()	The function uninitializes the Tech5_AuthMatcher_ServerE
int	createTemplateMinex(int minexType, ai.tech5.sdk.abis.finger.ImageData[] imageArray, byte[] templ, java.lang.Byte[] quality, java.lang.Integer templ_size, int maxTemplateSize)	The function takes set of images as input and outputs the corresponding ANSI INCITS 378 compliant template.
int	createTemplateMinexEx(int minexType, ai.tech5.sdk.abis.finger.RawImage[] imageArray, byte[] templ, java.lang.Byte[] quality, java.lang.Integer templ_size, int maxTemplateSize)	The function takes set of images as input and outputs the corresponding ANSI INCITS 378 compliant template.
int	createTemplateTech5(ai.tech5.sdk.abis.finger.ImageData image, byte[] fpTemplate, java.lang.Byte quality, java.lang.Integer templSize, byte fpType, int maxWidth, int maxHeight, boolean doSegmentation, byte[] skeleton, java.lang.Integer skeletonSize)	Processes fingerprint image and build the Tech5 template.
int	createTemplateTech5Ex(ai.tech5.sdk.abis.finger.RawImage srcImage, byte[] fpTemplate, java.lang.Byte quality, java.lang.Integer templSize, byte fpType, int maxWidth, int maxHeight, boolean doSegmentation, byte[] skeleton, java.lang.Integer skeletonSize)	Processes fingerprint image and build the Tech5 template.
java.lang.String	getLastErrorMsg()	function returns error description by its number Parameters:
ai.tech5.sdk.abis.finger.SearchParams	getSearchParams()	The function returns structure with current search parameters
java.lang.String	getVersion()	The function returns version of Tech5_AuthMatcher_ServerE Parameters:
boolean	initSDK()	The function initializes the Tech5_AuthMatcher_ServerE Parameters:
int	loadTemplateTech5(byte[] fpProbe)	This function loads the first template for 1:many searching Parameters:
int	matchTech5Minex(int minexType, byte[] templateTech5, byte[] templateNIST, java.lang.Double score, java.lang.Double logFAR, boolean useScale)	The function compares Tech5 and ANSI INCITS 378 compliant templates and outputs a match score.
int	matchTemplatesMinex(int minexType, byte[] probeTemplate, byte[] galleryTemplate, java.lang.Double score, java.lang.Double logFAR, boolean useScale)	The function compares two ANSI INCITS 378 compliant templates and outputs a match score.
int	matchTemplatesTech5(byte[] fpTempl1, byte[] fpTempl2, java.lang.Double score, java.lang.Double logFAR)	Compares two templates Parameters:
int	matchTemplatesTech5Ex(byte[] fpGallery, java.lang.Double score, java.lang.Double logFAR)	This function allows you to perform the 1:many search.
int	matchTemplatesTech5TT(ai.tech5.sdk.abis.finger.TpTemplate fpTempl1, ai.tech5.sdk.abis.finger.TpTemplate fpTempl2, java.lang.Double score, java.lang.Double logFAR)	Compares two templates Parameters:
int	scaleImage(ai.tech5.sdk.abis.finger.RawImage srcImage, ai.tech5.sdk.abis.finger.RawImage dstImage, byte gender, byte age)	The function scales fingerprint image to 500 ppi
int	setLicense(java.lang.String license_file)	The function sets license file Parameters:
int	setLicenseEx(byte[] license_data)	The function sets license data Parameters:
int	setSearchParams(ai.tech5.sdk.abis.finger.SearchParams params)	The function sets search parameters NOTE: this change will be valid until you unload SDK.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_WIDTH

public final int MAX_WIDTH

maximum image width

See Also:

Constant Field Values

MAX_HEIGHT

public final int MAX_HEIGHT

maximum image height

See Also:

Constant Field Values

Constructor Detail

T5FingerAuth

public T5FingerAuth()

Method Detail

getVersion

public java.lang.String getVersion()

The function returns version of Tech5_AuthMatcher_ServerE Parameters:

Returns:

value of current version

initSDK

public boolean initSDK()

The function initializes the Tech5_AuthMatcher_ServerE Parameters:

Returns:

Return value: The function returns true if success

closeSDK

public void closeSDK()

The function uninitializes the Tech5_AuthMatcher_ServerE

setSearchParams

public int setSearchParams(ai.tech5.sdk.abis.finger.SearchParams params)

The function sets search parameters NOTE: this change will be valid until you unload SDK. If you want to make this changers persistent you should set these parameters in Windows Control Panel Parameters:

Parameters:

params - (input) - the pointer to structure with the new search parameters

Returns:

Return value: The function returns SE_OK if success and error code otherwise

getSearchParams

public ai.tech5.sdk.abis.finger.SearchParams getSearchParams()

The function returns structure with current search parameters

Returns:

current search parameters

setLicense

public int setLicense(java.lang.String license_file)

The function sets license file Parameters:

Parameters:

license_file - (input) - license file for checking of product legality

Returns:

Return value: The function returns SE_OK if success and error code otherwise

setLicenseEx

public int setLicenseEx(byte[] license_data)

The function sets license data Parameters:

Parameters:

license_data - (input) - license data for checking of product legality

Returns:

Return value: The function returns SE_OK if success and error code otherwise

createTemplateTech5

public int createTemplateTech5(ai.tech5.sdk.abis.finger.ImageData image,
                               byte[] fpTemplate,
                               java.lang.Byte quality,
                               java.lang.Integer templSize,
                               byte fpType,
                               int maxWidth,
                               int maxHeight,
                               boolean doSegmentation,
                               byte[] skeleton,
                               java.lang.Integer skeletonSize)

Processes fingerprint image and build the Tech5 template. Parameters:

Parameters:

image - ( input) - image data @see ImageData

fpTemplate - (output) - the buffer that receives the built template Memory for that buffer should be previously allocated by 'allocateTemplate' function

quality - (output) - this variable receives the quality of fingerprint image

templSize - (output) - this variable receives the size of built template

fpType - (input ) - type of processing. Can be: 'F' - finger, 'L' - latent, 'P' - palm, 'S' - palm latent

maxWidth - - if this parameters greater 0 and source image have size bigger than these values, then source image will cut to this size(input)

maxHeight - - if this parameters greater 0 and source image have size bigger than these values, then source image will cut to this size(input)

doSegmentation - (input) - if true then forces to segmentation of image

skeleton - (output) - if this parameter is non null, then the skeleton information will be copied in this buffer. The memory (with size at least width * height) should be allocated in application

skeletonSize - (output) - the buffer that receives the real size of copied skeleton data

Returns:

SE_OK - if function succeeds, error code - otherwise

createTemplateTech5Ex

public int createTemplateTech5Ex(ai.tech5.sdk.abis.finger.RawImage srcImage,
                                 byte[] fpTemplate,
                                 java.lang.Byte quality,
                                 java.lang.Integer templSize,
                                 byte fpType,
                                 int maxWidth,
                                 int maxHeight,
                                 boolean doSegmentation,
                                 byte[] skeleton,
                                 java.lang.Integer skeletonSize)

Processes fingerprint image and build the Tech5 template. Parameters:

Parameters:

srcImage - ( input) - image data @see RawImage

fpTemplate - (output) - the buffer that receives the built template Memory for that buffer should be previously allocated by 'allocateTemplate' function

quality - (output) - this variable receives the quality of fingerprint image

templSize - (output) - this variable receives the size of built template

fpType - (input ) - type of processing. Can be: 'F' - finger, 'L' - latent, 'P' - palm, 'S' - palm latent

maxWidth - - if this parameters greater 0 and source image have size bigger than these values, then source image will cut to this size(input)

maxHeight - - if this parameters greater 0 and source image have size bigger than these values, then source image will cut to this size(input)

doSegmentation - (input) - if true then forces to segmentation of image

skeleton - (output) - if this parameter is non null, then the skeleton information will be copied in this buffer. The memory (with size at least width * height) should be allocated in application

skeletonSize - (output) - the buffer that receives the real size of copied skeleton data

Returns:

SE_OK - if function succeeds, error code - otherwise

createTemplateMinex

public int createTemplateMinex(int minexType,
                               ai.tech5.sdk.abis.finger.ImageData[] imageArray,
                               byte[] templ,
                               java.lang.Byte[] quality,
                               java.lang.Integer templ_size,
                               int maxTemplateSize)

The function takes set of images as input and outputs the corresponding ANSI INCITS 378 compliant template. Parameters:

Parameters:

minexType - (input) - type of template for creation. @see MinexTemplateType

imageArray - (input )- array of ImageData structure

templ - (output) - The processed ANSI INCITS 378 compliant template. The memory for the template should be allocated by caller

quality - (output) - Array of quality of images in template

templ_size - (output) - size of created template in bytes

maxTemplateSize - (input) - the maximum size of template. If size of template is more than this value, then some of minutiae will be eliminated from template to satisfy this parameter. If it's 0, then all minutiae will be put into template.

Returns:

Return value: The function returns SE_OK if success and error code otherwise. In case of failure the null template will be output.

createTemplateMinexEx

public int createTemplateMinexEx(int minexType,
                                 ai.tech5.sdk.abis.finger.RawImage[] imageArray,
                                 byte[] templ,
                                 java.lang.Byte[] quality,
                                 java.lang.Integer templ_size,
                                 int maxTemplateSize)

The function takes set of images as input and outputs the corresponding ANSI INCITS 378 compliant template. Parameters:

Parameters:

minexType - (input) - type of template for creation. @see MinexTemplateType

imageArray - (input )- array of source RawImage structures

templ - (output) - The processed ANSI INCITS 378 compliant template. The memory for the template should be allocated by 'allocateNISTtemplate' function

quality - (output) - Array of quality of images in template

templ_size - (output) - size of created template in bytes

maxTemplateSize - (input) - the maximum size of template. If size of template is more than this value, then some of minutiae will be eliminated from template to satisfy this parameter. If it's 0, then all minutiae will be put into template.

Returns:

Return value: The function returns SE_OK if success and error code otherwise. In case of failure the null template will be output.

matchTemplatesTech5

public int matchTemplatesTech5(byte[] fpTempl1,
                               byte[] fpTempl2,
                               java.lang.Double score,
                               java.lang.Double logFAR)

Compares two templates Parameters:

Parameters:

fpTempl1 - (input) - the first fingerprint template

fpTempl2 - (input) - the second fingerprint template

score - (output) - this variable receives the value that shows

logFAR - (output) : logFAR may be null if unused how two fingerprints similarity one to other in percent

Returns:

Return value: The function returns SE_OK if success and error code otherwise

loadTemplateTech5

public int loadTemplateTech5(byte[] fpProbe)

This function loads the first template for 1:many searching Parameters:

Parameters:

fpProbe - (input) : the probe fingerprint template

Returns:

The function returns SE_OK if success and error code otherwise

matchTemplatesTech5Ex

public int matchTemplatesTech5Ex(byte[] fpGallery,
                                 java.lang.Double score,
                                 java.lang.Double logFAR)

This function allows you to perform the 1:many search. Parameters:

Parameters:

fpGallery - (input) : the gallery fingerprint template

score - (output): this variable receives the value that shows

logFAR - (output) : logFAR may be null if unused how two fingerprints similarity one to other in percent

Returns:

The function returns SE_OK if success and error code otherwise

matchTemplatesMinex

public int matchTemplatesMinex(int minexType,
                               byte[] probeTemplate,
                               byte[] galleryTemplate,
                               java.lang.Double score,
                               java.lang.Double logFAR,
                               boolean useScale)

The function compares two ANSI INCITS 378 compliant templates and outputs a match score. Parameters:

Parameters:

minexType - (input) - type of template for creation. @see MinexTemplateType

probeTemplate - (input) : the first ANSI INCITS 378 compliant template

galleryTemplate - (input) : the second ANSI INCITS 378 compliant template

score - (output): a similarity score resulting from comparison of the templates.

logFAR - (output) : logFAR may be null if unused

useScale - (input) : if true, will be used a special matching mode, more tolerate to image scale

Returns:

Return value: The function returns SE_OK if success and error code otherwise. NOTE: At this version of software templates (probeTemplate and galleryTemplate) can keeps information about two fingers

matchTech5Minex

public int matchTech5Minex(int minexType,
                           byte[] templateTech5,
                           byte[] templateNIST,
                           java.lang.Double score,
                           java.lang.Double logFAR,
                           boolean useScale)

The function compares Tech5 and ANSI INCITS 378 compliant templates and outputs a match score. Parameters:

Parameters:

minexType - (input) : the type of template. @see MinexTemplateType

templateTech5 - (input) : the Tech5 template

templateNIST - (input) : the second ANSI INCITS 378 compliant template

score - (output) : a similarity score resulting from comparison of the templates.

logFAR - (output) : logFAR may be null if unused

useScale - (input) : if true, will be used a special matching mode, more tolerate to image scale

Returns:

Return value: The function returns SE_OK if success and error code otherwise.

matchTemplatesTech5TT

public int matchTemplatesTech5TT(ai.tech5.sdk.abis.finger.TpTemplate fpTempl1,
                                 ai.tech5.sdk.abis.finger.TpTemplate fpTempl2,
                                 java.lang.Double score,
                                 java.lang.Double logFAR)

Compares two templates Parameters:

Parameters:

fpTempl1 - (input) - the first fingerprint template

fpTempl2 - (input) - the second fingerprint template

score - (output) - this variable receives the value that shows

logFAR - (output) : logFAR may be null if unused how two fingerprints similarity one to other in percent

Returns:

Return value: The function returns SE_OK if success and error code otherwise

getLastErrorMsg

public java.lang.String getLastErrorMsg()

function returns error description by its number Parameters:

Returns:

The last error descriptions

allocateTemplateTech5

public byte[] allocateTemplateTech5(byte fpType)

The function allocates memory for template variable

Parameters:

fpType - (input ) - type of processing. Can be: 'F' - finger, 'L' - latent, 'P' - palm, 'S' - palm latent

Returns:

allocated buffer

allocateTemplateMinex

public byte[] allocateTemplateMinex(int minexType,
                                    int numFingers)

The function allocates memory for buffer that will receives INCITS 378 compliance template

Parameters:

minexType - (input) - type of template. @see MinexTemplateType

numFingers - (input) : count of fingers in template

Returns:

allocated buffer

scaleImage

public int scaleImage(ai.tech5.sdk.abis.finger.RawImage srcImage,
                      ai.tech5.sdk.abis.finger.RawImage dstImage,
                      byte gender,
                      byte age)

The function scales fingerprint image to 500 ppi

Parameters:

srcImage - (input) source fingerprint image

dstImage - (output) result image. Memory must be allocated by caller. If dstImage.m_image is NULL then will return sizes of image only

gender - (input) gender 0 unspecified 1 male 2 female

age - (input) age 0 unspecified 1-99 in years

Returns:

The function returns SE_OK if success and error code otherwise.