visit Kofax web site

SPCompare Class Reference

List of all members.

Detailed Description

PHP Wrapper around the COM object ActiveSW.SPCompare.

Note:
the class SPCompare requires a prior instance of a SPSignWare object
See also:
ACTIVESWLib.ISPCompare


Public Member Functions

 compare ($spReference, $spSignature)
 Compare a biometric or static signature against a biometric or static reference.
 setMatchQuality ($iDynamic, $iStatic)
 Set the match quality, separate for the static and the dynamic engines.
 setMode ($iMode)
 Set the compare mode.
 SPCompare ()
 Instantiate the SPCompare object.

Public Attributes

 $className = "SPCompare"
 Name of this class.
 $com = false
 native COM handle


Constructor & Destructor Documentation

SPCompare.SPCompare  ) 
 

Instantiate the SPCompare object.


Member Function Documentation

SPCompare.compare spReference,
spSignature
 

Compare a biometric or static signature against a biometric or static reference.

Parameters:
$spReference [i] the reference signature, a object of class SPReference or SPImage
$spSignature [i] the signature, a object of class SPSignature or SPImage
Returns:
boolean true if signature and reference match, else false
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPCompare.CompareReference, ACTIVESWLib.ISPCompare.GetResult
Note:
Assure to set the correct mode if you pass image objects, see setMode.
Todo:
support templates

SPCompare.setMatchQuality iDynamic,
iStatic
 

Set the match quality, separate for the static and the dynamic engines.

Parameters:
$iDynamic [i] the match quality for the dynamic engine, range 0 ... 100
$iStatic [i] the match quality for the static engine, range 0 ... 100
Exceptions:
Exception on errors
Note:
The match quality has a non linear relation to the 'similarity' of signature and reference, and the relation may differ between the engines.
The defaults are 80, 80
See also:
ACTIVESWLib.ISPCompare.SetDynamicMatchQuality, ACTIVESWLib.ISPCompare.SetStaticMatchQuality

SPCompare.setMode iMode  ) 
 

Set the compare mode.

Parameters:
$iMode [i] Compare mode, may be a bitwise or of these constants:
  • SP_COMPARE_STATIC use the static engine to compare signature and reference
  • SP_COMPARE_DYNAMIC use the dynamic engine to compare signature and reference
  • SP_COMPARE_DESKEW deskew the biometric signature and reference before calling a static compare
  • SP_COMPARE_NORMLIZE_SAMPLERATE Normalize the sample rate of biometric signature and reference
  • SP_COMPARE_MIRROR mirror the image of signature and reference before calling the static compare (usefull for languages that are written left to right)
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPCompare.SetMode


Member Data Documentation

SPCompare.$className = "SPCompare"
 

Name of this class.

SPCompare.$com = false
 

native COM handle


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