visit Kofax web site

de.softpro.signware.SPReference Class Reference

Inheritance diagram for de.softpro.signware.SPReference:

de.softpro.signware.SPSignwareObject List of all members.

Detailed Description

Representation of a SignWare reference object.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Public Member Functions

void addSignature (SPSignature pSignature) throws SPSignwareException
 Add a signature to this reference.
boolean check (SPPropertyMap pParams) throws SPSignwareException
 Check a reference.
SPReference createClone () throws SPSignwareException
 Create a new reference object based on this reference object.
int getDynamicQuality () throws SPSignwareException
 Get the dynamic quality of this reference.
byte[] getImage (double dZoom, int iImageFormat, int iIndex) throws SPSignwareException
 Query an image on this reference object.
byte[] getImage2 (double dZoom, int iImageFormat, int iIndex, SPTicket spTicket) throws SPSignwareException
 Query an image on this reference object.
Dimension getImageSize (int iIndex) throws SPSignwareException
 Query the size of an image created by this reference object.
int getSignatureCount () throws SPSignwareException
 Query the number of signatures that were acquired to create this reference.
int getStaticQuality (int iIndex) throws SPSignwareException
 Get the static quality of a signature embedded in this reference.
boolean getVariance (int iQuality) throws SPSignwareException
 Get the variance of this reference.
boolean getVariance () throws SPSignwareException
 Get the variance of this reference.
void mirrorY () throws SPSignwareException
 Mirror a reference vertically.
 SPReference (SPTellerImage tellerimage) throws SPSignwareException
 Create a new reference object based on teller image object.
 SPReference (SPReference reference) throws SPSignwareException
 Create a new reference object based on another reference object.
 SPReference (byte[] flatFile, int iFlags) throws SPSignwareException
 Create a new reference object based on a flat file object.
 SPReference (byte[] flatFile) throws SPSignwareException
 Create a new reference object based on a flat file object.
 SPReference (SPAcquire spAcquire) throws SPSignwareException
 Create a new reference object based on the signatures that were acquired in a SPAcquire object.
 SPReference (SPJGuiAcqu spGuiAcqu) throws SPSignwareException
 Create a new reference object based on the signatures that were acquired in a SPJGuiAcqu object.
 SPReference (SPGuiAcqu spGuiAcqu) throws SPSignwareException
 Create a new reference object based on the signatures that were acquired in a SPGuiAcqu object.
 SPReference () throws SPSignwareException
 Create an empty reference object.

Static Public Attributes

static final String SP_REFERENCE_CHECK_SIGNATURES = "SPReferenceCheckSignatures"
 Check all signatures included in a reference.
static final String SP_REFERENCE_MAX_DURATION = "SPReferenceMaxDuration"
 Maximum duration to enter all signatures within a reference.
static final String SP_REFERENCE_MIN_DYNAMIC_QUALITY = "SPReferenceMinDynamicQuality"
 Minimum dynamic quality of a reference.
static final String SP_REFERENCE_MIN_MATCH = "SPReferenceMinMatch"
 Variance of a reference.
static final String SP_REFERENCE_MIN_SIGNATURES = "SPReferenceMinSignatures"
 Minimum number of signatures contained in a reference.

Package Functions

native final int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPReference.SPReference  )  throws SPSignwareException
 

Create an empty reference object.

Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceCreate

de.softpro.signware.SPReference.SPReference SPGuiAcqu  spGuiAcqu  )  throws SPSignwareException
 

Create a new reference object based on the signatures that were acquired in a SPGuiAcqu object.

This reference object will contain copies of all signatures of the acquiry object. Signatures that are acquired after this reference is created will not be added to this reference.

Parameters:
spGuiAcqu [i] the acquiry object that contains the signatures
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32)
See also:
SPReferenceCreateFromGuiAcqu

de.softpro.signware.SPReference.SPReference SPJGuiAcqu  spGuiAcqu  )  throws SPSignwareException
 

Create a new reference object based on the signatures that were acquired in a SPJGuiAcqu object.

This reference object will contain copies of all signatures of the acquiry object. Signatures that are acquired after this reference is created will not be added to this reference.

Parameters:
spGuiAcqu [i] the acquiry object that contains the signatures
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32)
See also:
SPReferenceCreateFromGuiAcqu

de.softpro.signware.SPReference.SPReference SPAcquire  spAcquire  )  throws SPSignwareException
 

Create a new reference object based on the signatures that were acquired in a SPAcquire object.

This reference object will contain copies of all signatures of the acquiry object. Signatures that are acquired after this reference is created will not be added to this reference.

Parameters:
spAcquire [i] the acquiry object that contains the signatures
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32)
See also:
SPReferenceCreateFromGuiAcqu

de.softpro.signware.SPReference.SPReference byte[]  flatFile  )  throws SPSignwareException
 

Create a new reference object based on a flat file object.

This constructor is equivalent to the two-argument constructor with a value of zero for iFlags unless overridden by environment variable SIGNWARE_ISO_LOAD.

The value of that environment variable is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits, that is, the following values (and combinations thereof) are defined:

Parameters:
flatFile [i] the flatFile object
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceCreateFromFlatFile

de.softpro.signware.SPReference.SPReference byte[]  flatFile,
int  iFlags
throws SPSignwareException
 

Create a new reference object based on a flat file object.

This function does not use environment variable SIGNWARE_ISO_LOAD.

Parameters:
flatFile [i] the flatFile object
iFlags [i] flags modifying the behavior of this function:
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceCreateFromFlatFile3

de.softpro.signware.SPReference.SPReference SPReference  reference  )  throws SPSignwareException
 

Create a new reference object based on another reference object.

Parameters:
reference [i] the reference object
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceClone

de.softpro.signware.SPReference.SPReference SPTellerImage  tellerimage  )  throws SPSignwareException
 

Create a new reference object based on teller image object.

Parameters:
tellerimage [i] the teller image object
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32)
See also:
SPReferenceCreateFromTellerImage


Member Function Documentation

void de.softpro.signware.SPReference.addSignature SPSignature  pSignature  )  throws SPSignwareException
 

Add a signature to this reference.

Parameters:
pSignature [i] the signature to be added
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceGetSignatureCount

boolean de.softpro.signware.SPReference.check SPPropertyMap  pParams  )  throws SPSignwareException
 

Check a reference.

Reference plausibility check. A reference should have a min static and dynamic quality and a max variance.

Parameters:
pParams [i] Parameters, may be null
Returns:
boolean, true on success, false if check failed
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPReferenceCheck

SPReference de.softpro.signware.SPReference.createClone  )  throws SPSignwareException
 

Create a new reference object based on this reference object.

Returns:
SPReference the reference object
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceClone

int de.softpro.signware.SPReference.getDynamicQuality  )  throws SPSignwareException
 

Get the dynamic quality of this reference.

A recommended min. dynamic should be in the range 80.

Returns:
int the dynamic quality, range 0 .. 100, 0 no features available from this referemce
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32)
See also:
SPReferenceGetDynamicQuality

byte [] de.softpro.signware.SPReference.getImage double  dZoom,
int  iImageFormat,
int  iIndex
throws SPSignwareException
 

Query an image on this reference object.

Parameters:
dZoom [i] zoom rate [1.0 typically creates an image with 300 dpi]
iImageFormat [i] requested image format
iIndex [i] 0-based index of the signature within the reference
Returns:
byte[] the image in the requested format
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceGetImage

SP_IMAGE_GIF, SP_IMAGE_CCITT4, SP_IMAGE_TIFF, SP_IMAGE_BMP_WIN

SP_IMAGE_BLACKWHITE, SP_IMAGE_BLACKWHITE_1BPP and SP_IMAGE_CROSSED

byte [] de.softpro.signware.SPReference.getImage2 double  dZoom,
int  iImageFormat,
int  iIndex,
SPTicket  spTicket
throws SPSignwareException
 

Query an image on this reference object.

Parameters:
dZoom [i] zoom rate [1.0 typically creates an image with 300 dpi]
iImageFormat [i] requested image format
iIndex [i] 0-based index of the signature within the reference
spTicket [i] a ticked that must be charged for SP_TICKET_RENDER usage, or null if not applicable
Returns:
byte[] the image in the requested format
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceGetImage

SPBitmap.SP_IMAGE_GIF, SPBitmap.SP_IMAGE_CCITT4, SPBitmap.SP_IMAGE_TIFF, SPBitmap.SP_IMAGE_BMP_WIN

SPBitmap.SP_IMAGE_BLACKWHITE, SPBitmap.SP_IMAGE_BLACKWHITE_1BPP, SPBitmap.SP_IMAGE_CROSSED

Dimension de.softpro.signware.SPReference.getImageSize int  iIndex  )  throws SPSignwareException
 

Query the size of an image created by this reference object.

Parameters:
iIndex [i] 0-based index of the signature within the reference
Returns:
Dimension the size of the image
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceGetImageSize

int de.softpro.signware.SPReference.getSignatureCount  )  throws SPSignwareException
 

Query the number of signatures that were acquired to create this reference.

Returns:
int the number of signatures
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPReferenceGetSignatureCount

int de.softpro.signware.SPReference.getStaticQuality int  iIndex  )  throws SPSignwareException
 

Get the static quality of a signature embedded in this reference.

A recommended min. dynamic should be in the range 50.

Parameters:
iIndex [i] index of the signature
Returns:
int the static quality, range 0 .. 100, 0 no static features available from signature
Exceptions:
SPSignwareExcepion on errors
Operating Systems:
Windows (Win32)
See also:
SPReferenceGetStaticQuality

boolean de.softpro.signware.SPReference.getVariance int  iQuality  )  throws SPSignwareException
 

Get the variance of this reference.

It is highly recommended to check the variance if you intend to use the static compare engine. The result is true if all embedded signatures are similar.

Parameters:
iQuality [i] variance threshold, range 0 .. 100, 100: signatures must be almost identical
Returns:
bool true: variance is OK, else variance is not OK
Operating Systems:
Windows (Win32)
See also:
SPReferenceGetVariance

boolean de.softpro.signware.SPReference.getVariance  )  throws SPSignwareException
 

Get the variance of this reference.

It is highly recommended to check the variance if you intend to use the static compare engine. The result is true if all embedded signatures are similar.

This call is identical with getVariance(80).

Returns:
bool true: variance is OK, else variance is not OK
Operating Systems:
Windows (Win32)
See also:
SPReferenceGetVariance

native final int de.softpro.signware.SPReference.jniFree  )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPReference.mirrorY  )  throws SPSignwareException
 

Mirror a reference vertically.

The reference is mirrored such that for each signature the range of Y coordinates is not changed.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)


Member Data Documentation

final String de.softpro.signware.SPReference.SP_REFERENCE_CHECK_SIGNATURES = "SPReferenceCheckSignatures" [static]
 

Check all signatures included in a reference.

See also:
SPReferenceCheck

final String de.softpro.signware.SPReference.SP_REFERENCE_MAX_DURATION = "SPReferenceMaxDuration" [static]
 

Maximum duration to enter all signatures within a reference.

See also:
SPReferenceCheck

final String de.softpro.signware.SPReference.SP_REFERENCE_MIN_DYNAMIC_QUALITY = "SPReferenceMinDynamicQuality" [static]
 

Minimum dynamic quality of a reference.

See also:
SPReferenceCheck

final String de.softpro.signware.SPReference.SP_REFERENCE_MIN_MATCH = "SPReferenceMinMatch" [static]
 

Variance of a reference.

See also:
SPReferenceCheck

final String de.softpro.signware.SPReference.SP_REFERENCE_MIN_SIGNATURES = "SPReferenceMinSignatures" [static]
 

Minimum number of signatures contained in a reference.

See also:
SPReferenceCheck


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