visit Kofax web site

de.softpro.signware.SPSignature Class Reference

Inheritance diagram for de.softpro.signware.SPSignature:

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

Detailed Description

Representation of a Signware signature object.

A signature consists of a a set of vectors, each containing a x and y coordinate, and the pressure. The signature also includes parameters that were recorded during capture such as tablet device, sample rate, timestamp etc.

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


Public Member Functions

void addVector (int x, int y, int p, int t) throws SPSignwareException
 Add a vector to this signature.
void addVector (int x, int y, int p) throws SPSignwareException
 Add a vector to this signature.
void addVector (SPTabletVector2 tv) throws SPSignwareException
 Add a vector to this signature.
void addVector (SPTabletVector tv) throws SPSignwareException
 Add a vector to this signature.
boolean check (SPPropertyMap pParams) throws SPSignwareException
 Check a signature.
void clearVectors () throws SPSignwareException
 Clear the signature vectors in this object.
SPSignature createClone () throws SPSignwareException
 Create a new signature object as a clone from this signature object.
int getComplexity () throws SPSignwareException
 Query the complexity of the signature contained in this object.
int getDevice () throws SPSignwareException
 Query the device that captured this signature object.
byte[] getImage (double dZoom, int iImageFormat) throws SPSignwareException
 Query an image on this signature object.
Dimension getImageSize () throws SPSignwareException
 Query the size of an image created by this signature object.
int getMaxPressure () throws SPSignwareException
 Query the pressure range as this signature was captured.
int getNrVectors () throws SPSignwareException
 Query the number of vectors contained in this signature.
final byte[] getPadSerial () throws SPSignwareException
 Query the tablet serial identification.
int getResolution () throws SPSignwareException
 Query the resolution as this signature was captured.
int getSampleRate () throws SPSignwareException
 Query the sample rate as this signature was captured.
int getTimeStamp () throws SPSignwareException
 Query the time stamp when this signature was captured.
SPTabletVector2 getVector (int iIndex) throws SPSignwareException
 Query a vector from this signature.
void mirrorY () throws SPSignwareException
 Mirror a signature vertically.
void setDevice (int iDevice) throws SPSignwareException
 Set the device ID in this signature object.
void setMaxPressure (int iMaxPressure) throws SPSignwareException
 Set the max. pressure in this signature object.
final void setPadSerial (byte padSerial[]) throws SPSignwareException
 Set the tablet serial identification.
void setResolution (int iResolution) throws SPSignwareException
 Set the resolution in this signature object.
void setSampleRate (int iSampleRate) throws SPSignwareException
 Set the sample rate as this signature was captured.
void setStaticPenWidth (double dPenWidth) throws SPSignwareException
 Set the width of the pen when rendering the signature to a static image, default 0.5 mm.
void setTicket (SPTicket spTicket) throws SPSignwareException
 Pass a license to render the image signature one or multiple times.
void setTimeStamp (int iTimeStamp) throws SPSignwareException
 Set the time stamp when this signature was captured.
 SPSignature (SPReference spReference, int index) throws SPSignwareException
 Create a new signature object from a reference object.
 SPSignature (byte[] pFlatFile, int iFlags) throws SPSignwareException
 Create a new signature object from a flat file object.
 SPSignature (byte[] pFlatFile) throws SPSignwareException
 Create a new signature object from a flat file object.
 SPSignature (SPTellerImage spTellerImage) throws SPSignwareException
 Create a new signature object from a teller image object.
 SPSignature (SPTemplate spTemplate) throws SPSignwareException
 Create a new signature object from a template object.
 SPSignature (SPTablet spTablet) throws SPSignwareException
 Create a new signature object from a tablet object.
 SPSignature (SPAcquire spAcquire) throws SPSignwareException
 Create a signature object from a SPAcquire object.
 SPSignature (SPJGuiAcqu spGuiAcqu) throws SPSignwareException
 Create a signature object from a SPJGuiAcqu object.
 SPSignature (SPGuiAcqu spGuiAcqu) throws SPSignwareException
 Create a signature object from a SPGuiAcqu object.
 SPSignature (SPSignature origin) throws SPSignwareException
 Create a new signature object as a clone of another signature object.
 SPSignature () throws SPSignwareException
 Create a new signature object.

Static Public Attributes

static final String SP_SIGNATURE_MIN_HEIGHT = "SPSignatureMinHeight"
 Min signature height.
static final String SP_SIGNATURE_MIN_PRESSURE_LEVELS = "SPSignatureMinPressureLevels"
 Min signature pressure levels.
static final String SP_SIGNATURE_MIN_STATIC_QUALITY = "SPSignatureMinStaticQuality"
 Min static signature quality.
static final String SP_SIGNATURE_MIN_VECTORS = "SPSignatureMinVectors"
 Min signature vectors (with pressure greater than 0).
static final String SP_SIGNATURE_MIN_WIDTH = "SPSignatureMinWidth"
 Min signature width.

Package Functions

native final int jniFree ()
void setStaticGrayAlias (boolean bGrayAlias) throws SPSignwareException
 Calculate gray levels in a static signature either from pressure levels of the vectors or from aliasing.


Constructor & Destructor Documentation

de.softpro.signware.SPSignature.SPSignature  )  throws SPSignwareException
 

Create a new signature object.

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

de.softpro.signware.SPSignature.SPSignature SPSignature  origin  )  throws SPSignwareException
 

Create a new signature object as a clone of another signature object.

Parameters:
origin [i] the signature object that should be copied into this object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureClone

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

Create a signature object from a SPGuiAcqu object.

Parameters:
spGuiAcqu [i] the acquiry object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64)
See also:
SPSignatureCreateFromGuiAcqu

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

Create a signature object from a SPJGuiAcqu object.

Parameters:
spGuiAcqu [i] the acquiry object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64)
See also:
SPSignatureCreateFromGuiAcqu

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

Create a signature object from a SPAcquire object.

Parameters:
spAcquire [i] the acquiry object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64)
See also:
SPSignatureCreateFromGuiAcqu

de.softpro.signware.SPSignature.SPSignature SPTablet  spTablet  )  throws SPSignwareException
 

Create a new signature object from a tablet object.

Parameters:
spTablet [i] the tablet object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64)
See also:
SPSignatureCreateFromTablet

de.softpro.signware.SPSignature.SPSignature SPTemplate  spTemplate  )  throws SPSignwareException
 

Create a new signature object from a template object.

Parameters:
spTemplate [i] the template object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureCreateFromTemplate

de.softpro.signware.SPSignature.SPSignature SPTellerImage  spTellerImage  )  throws SPSignwareException
 

Create a new signature object from a teller image object.

Parameters:
spTellerImage [i] the teller image object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPSignatureCreateFromTellerImage

de.softpro.signware.SPSignature.SPSignature byte[]  pFlatFile  )  throws SPSignwareException
 

Create a new signature object from 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:
pFlatFile [i] the flatfile object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureCreateFromFlatFile

de.softpro.signware.SPSignature.SPSignature byte[]  pFlatFile,
int  iFlags
throws SPSignwareException
 

Create a new signature object from a flat file object.

This function does not use environment variable SIGNWARE_ISO_LOAD.

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

de.softpro.signware.SPSignature.SPSignature SPReference  spReference,
int  index
throws SPSignwareException
 

Create a new signature object from a reference object.

Parameters:
spReference [i] the reference object
index [i] 0-based index in the reference object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureCreateFromReference


Member Function Documentation

void de.softpro.signware.SPSignature.addVector int  x,
int  y,
int  p,
int  t
throws SPSignwareException
 

Add a vector to this signature.

Parameters:
x [i] the x coordinate of the vector
y [i] the y coordinate of the vector
p [i] the pressure of the vector
t [i] the time since signature capture start in mseconds
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureAddVector2

void de.softpro.signware.SPSignature.addVector int  x,
int  y,
int  p
throws SPSignwareException
 

Add a vector to this signature.

Note:
this is a compatibility function equal which equals addVector(x, y, p, -1)
Parameters:
x [i] the x coordinate of the vector
y [i] the y coordinate of the vector
p [i] the pressure of the vector
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureAddVector2

void de.softpro.signware.SPSignature.addVector SPTabletVector2  tv  )  throws SPSignwareException
 

Add a vector to this signature.

Parameters:
tv [i] the vector as a SPTabletVector2
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureAddVector2

void de.softpro.signware.SPSignature.addVector SPTabletVector  tv  )  throws SPSignwareException
 

Add a vector to this signature.

Note:
this is a compatibility function equal which equals addVector(tv.x(), tv.y(), tv.p(), -1)
Parameters:
tv [i] the vector as a SPTabletVector
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureAddVector2

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

Check a signature.

Signature plausibility check. A signature should exceed a certain size and contain a pressure level range.

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

void de.softpro.signware.SPSignature.clearVectors  )  throws SPSignwareException
 

Clear the signature vectors in this object.

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

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

Create a new signature object as a clone from this signature object.

Returns:
SPSignature a clone of this object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureClone

int de.softpro.signware.SPSignature.getComplexity  )  throws SPSignwareException
 

Query the complexity of the signature contained in this object.

Returns:
int the complexity, range 0 ... 100, 0 equals the most simple signature
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPSignatureGetComplexity
Since:
Version 3.2.2

int de.softpro.signware.SPSignature.getDevice  )  throws SPSignwareException
 

Query the device that captured this signature object.

Returns:
int the device ID
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetDevice

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

Query an image on this signature object.

Note:
The created image is a BW or gray image. Please use SPImage.setSignature and SPImage.etBitsPerPixel to convert the image to a color image if you prefer a color image.
Parameters:
dZoom [i] zoom rate [1.0 typically creates an image with 300 dpi]
iImageFormat [i] requested image format
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:
SPSignatureGetImage

SPBitmap

SP_IMAGE_GIF, SP_IMAGE_CCITT4, SP_IMAGE_TIFF, SP_IMAGE_BMP_WIN

SP_IMAGE_BLACKWHITE, SP_IMAGE_BLACKWHITE_1BPP, SP_IMAGE_CROSSED

Dimension de.softpro.signware.SPSignature.getImageSize  )  throws SPSignwareException
 

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

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:
SPSignatureGetImageSize

int de.softpro.signware.SPSignature.getMaxPressure  )  throws SPSignwareException
 

Query the pressure range as this signature was captured.

Returns:
int pressure range
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetMaxPressure

int de.softpro.signware.SPSignature.getNrVectors  )  throws SPSignwareException
 

Query the number of vectors contained in this signature.

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

final byte [] de.softpro.signware.SPSignature.getPadSerial  )  throws SPSignwareException
 

Query the tablet serial identification.

This function is provided for future compatibility. Currently no tablet supports serial identification.

Returns:
byte[] the tablet serial identification
Exceptions:
SPSignwareException if an error occured
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetPadSerial, SPTablet.getPadSerial

setPadSerial

int de.softpro.signware.SPSignature.getResolution  )  throws SPSignwareException
 

Query the resolution as this signature was captured.

Returns:
int the resolution [DPI]
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetResolution

int de.softpro.signware.SPSignature.getSampleRate  )  throws SPSignwareException
 

Query the sample rate as this signature was captured.

Returns:
int the sample rate [Hz]
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetSampleRate

int de.softpro.signware.SPSignature.getTimeStamp  )  throws SPSignwareException
 

Query the time stamp when this signature was captured.

Returns:
int time stamp, seconds since Jan 1st 1970, UTC
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetTimeStamp

SPTabletVector2 de.softpro.signware.SPSignature.getVector int  iIndex  )  throws SPSignwareException
 

Query a vector from this signature.

Parameters:
iIndex [i] 0-based index
Returns:
SPTabletVector the vector
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetVector2

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

Implements de.softpro.signware.SPSignwareObject.

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

Mirror a signature vertically.

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

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

void de.softpro.signware.SPSignature.setDevice int  iDevice  )  throws SPSignwareException
 

Set the device ID in this signature object.

You should not overwrite the device unless you know what you are doing.

Parameters:
iDevice [i] the new device ID
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureSetDevice

void de.softpro.signware.SPSignature.setMaxPressure int  iMaxPressure  )  throws SPSignwareException
 

Set the max. pressure in this signature object.

Note:
You should not overwrite the max. pressure unless you know what you are doing.
Parameters:
iMaxPressure [i] the new max. pressure
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureSetMaxPressure

final void de.softpro.signware.SPSignature.setPadSerial byte  padSerial[]  )  throws SPSignwareException
 

Set the tablet serial identification.

This function is provided for future compatibility. Currently no tablet supports serial identification.

Parameters:
padSerial the tablet serial identification
Exceptions:
SPSignwareException if an error occured
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureSetPadSerial, SPTablet.setPadSerial

getPadSerial

void de.softpro.signware.SPSignature.setResolution int  iResolution  )  throws SPSignwareException
 

Set the resolution in this signature object.

You should not overwrite the resolution unless you know what you are doing.

Parameters:
iResolution [i] the new device ID
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureSetResolution

void de.softpro.signware.SPSignature.setSampleRate int  iSampleRate  )  throws SPSignwareException
 

Set the sample rate as this signature was captured.

Some tablets return an incorrect sample rate. Therefore you can query the sample rate from the tablet object after capturing the signature, and pass it to this object.

Parameters:
iSampleRate [i] the capture sample rate
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureSetSampleRate

void de.softpro.signware.SPSignature.setStaticGrayAlias boolean  bGrayAlias  )  throws SPSignwareException [package]
 

Calculate gray levels in a static signature either from pressure levels of the vectors or from aliasing.

By default, the gray level is based on the pressure level of a vector.

Exceptions:
SPSignwareException on errors
Parameters:
bGrayAlias [i] true: calculate the gray level from aliasing, else calculate the gray level from the pressure.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureSetStaticGrayAlias, getImage
Since:
Version 3.0

void de.softpro.signware.SPSignature.setStaticPenWidth double  dPenWidth  )  throws SPSignwareException
 

Set the width of the pen when rendering the signature to a static image, default 0.5 mm.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

void de.softpro.signware.SPSignature.setTicket SPTicket  spTicket  )  throws SPSignwareException
 

Pass a license to render the image signature one or multiple times.

You must pass the ticket before you call getImage. The ticket must have been charged for usage SPTicket.ticket_render.

Deprecated:
Please use a license key.
Parameters:
spTicket [i] a valid and charged ticket
Exceptions:
SPSignwareException 
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
Deprecated:
Use de.softpro.signware.SPSignware.setTicket instead

void de.softpro.signware.SPSignature.setTimeStamp int  iTimeStamp  )  throws SPSignwareException
 

Set the time stamp when this signature was captured.

Parameters:
iTimeStamp [i] time stamp, seconds since Jan 1st 1970, UTC
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureSetTimeStamp


Member Data Documentation

final String de.softpro.signware.SPSignature.SP_SIGNATURE_MIN_HEIGHT = "SPSignatureMinHeight" [static]
 

Min signature height.

See also:
check

final String de.softpro.signware.SPSignature.SP_SIGNATURE_MIN_PRESSURE_LEVELS = "SPSignatureMinPressureLevels" [static]
 

Min signature pressure levels.

See also:
check

final String de.softpro.signware.SPSignature.SP_SIGNATURE_MIN_STATIC_QUALITY = "SPSignatureMinStaticQuality" [static]
 

Min static signature quality.

See also:
check

final String de.softpro.signware.SPSignature.SP_SIGNATURE_MIN_VECTORS = "SPSignatureMinVectors" [static]
 

Min signature vectors (with pressure greater than 0).

See also:
check

final String de.softpro.signware.SPSignature.SP_SIGNATURE_MIN_WIDTH = "SPSignatureMinWidth" [static]
 

Min signature width.

See also:
check


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