SPReference.h File Reference
Detailed Description
SignWare Dynamic Development toolkit, reference object.
- Author:
- uko
Use SPReferenceCreate, SPReferenceCreateFromFlatFile, SPReferenceCreateFromFlatFile3, SPReferenceCreateFromGuiAcqu, or SPReferenceCreateFromTellerImage to create an SPReference object.
Defines | |
#define | SP_REFERENCE_CHECK_SIGNATURES "SPReferenceCheckSignatures" |
Check all signatures included in a reference. | |
#define | SP_REFERENCE_MAX_DURATION "SPReferenceMaxDuration" |
Maximum duration to enter all signatures within a reference. | |
#define | SP_REFERENCE_MIN_DYNAMIC_QUALITY "SPReferenceMinDynamicQuality" |
Minimum dynamic quality of a reference. | |
#define | SP_REFERENCE_MIN_MATCH "SPReferenceMinMatch" |
Variance of a reference. | |
#define | SP_REFERENCE_MIN_SIGNATURES "SPReferenceMinSignatures" |
Minimum number of signatures contained in a reference. | |
Functions | |
SPINT32 __cdecl | SPReferenceAddSignature (pSPREFERENCE_T *ppReference, pSPSIGNATURE_T pSignature) |
Add a signature to an SPReference object. | |
SPINT32 __cdecl | SPReferenceCheck (pSPREFERENCE_T pReference, pSPPROPERTYMAP_T pParams) |
Check a reference. | |
SPINT32 __cdecl | SPReferenceClone (pSPREFERENCE_T pReference, pSPREFERENCE_T *ppReference) |
Create a copy of an SPReference object. | |
SPINT32 __cdecl | SPReferenceCreate (pSPREFERENCE_T *ppReference) |
Create a new SPReference object. | |
SPINT32 __cdecl | SPReferenceCreateFromAcquire (pSPREFERENCE_T *ppReference, pSPACQUIRE_T pSPAcquire) |
Create an SPReference object from the result of a signature acquiry. | |
SPINT32 __cdecl | SPReferenceCreateFromFlatFile (pSPREFERENCE_T *ppReference, const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength) |
Create a new SPReference object from a flat file object. | |
SPINT32 __cdecl | SPReferenceCreateFromFlatFile3 (pSPREFERENCE_T *ppReference, const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength, SPINT32 iFlags) |
Create a new SPReference object from a flat file object. | |
SPINT32 __cdecl | SPReferenceCreateFromGuiAcqu (pSPREFERENCE_T *ppReference, pSPGUIACQU_T pSPGuiAcqu) |
Create an SPReference object from the result of a signature acquiry. | |
SPINT32 __cdecl | SPReferenceCreateFromTellerImage (pSPREFERENCE_T *ppReference, pSPTELLERIMAGE_T pTellerImage) |
Create an SPReference object from an SPTellerImage object. | |
SPINT32 __cdecl | SPReferenceFree (pSPREFERENCE_T *ppReference) |
Deallocate an SPReference object. | |
SPINT32 __cdecl | SPReferenceFreeImage (SPUCHAR **ppbImage) |
Deallocate a bitmap created by SPReferenceGetImage or SPReferenceGetImage2. | |
SPINT32 __cdecl | SPReferenceGetDynamicQuality (pSPREFERENCE_T pReference, SPINT32 *piResult) |
Get the quality of the dynamic features of the signatures contained in an SPReference object. | |
SPINT32 __cdecl | SPReferenceGetImage (pSPREFERENCE_T pReference, SPDOUBLE dZoom, SPINT32 iImageFormat, SPINT32 iIndex, SPUCHAR **ppbImage, SPINT32 *piImageLength) |
Create a bitmap from a signature stored in an SPReference object. | |
SPINT32 __cdecl | SPReferenceGetImage2 (pSPREFERENCE_T pReference, SPDOUBLE dZoom, SPINT32 iImageFormat, SPINT32 iIndex, pSPTICKET_T pTicket, SPUCHAR **ppbImage, SPINT32 *piImageLength) |
Create a bitmap from a signature stored in an SPReference object. | |
SPINT32 __cdecl | SPReferenceGetImageSize (pSPREFERENCE_T pReference, SPINT32 iIndex, SPINT32 *piWidth, SPINT32 *piHeight) |
Get the size of an image for a signature of an SPReference object. | |
SPINT32 __cdecl | SPReferenceGetSignatureCount (pSPREFERENCE_T pReference, SPINT32 *piNrSignatures) |
Get the number of signatures contained in an SPReference object. | |
SPINT32 __cdecl | SPReferenceGetStaticQuality (pSPREFERENCE_T pReference, SPINT32 iIndex, SPINT32 *piResult) |
Get the quality of the static features of a signature contained in an SPReference object. | |
SPINT32 __cdecl | SPReferenceGetVariance (pSPREFERENCE_T pReference, SPINT32 *piVariance) |
Check the variance of the signatures contained in an SPReference object. | |
SPINT32 __cdecl | SPReferenceGetVarianceEx (pSPREFERENCE_T pReference, SPINT32 iQuality, SPINT32 *piVariance) |
Check the variance of the signatures contained in an SPReference object. | |
SPINT32 __cdecl | SPReferenceMirrorY (pSPREFERENCE_T pReference) |
Mirror a reference vertically. |
Define Documentation
|
Check all signatures included in a reference.
|
|
Maximum duration to enter all signatures within a reference.
|
|
Minimum dynamic quality of a reference.
|
|
Variance of a reference.
|
|
Minimum number of signatures contained in a reference.
|
Function Documentation
|
Add a signature to an SPReference object.
|
|
Check a reference. Reference plausibility check. A reference should have a min static and dynamic quality and a max variance.
|
|
Create a copy of an SPReference object.
|
|
Create a new SPReference object. Typically, SPReferenceAddSignature is used after calling this function to add signatures to the new SPReference object.
|
|
Create an SPReference object from the result of a signature acquiry. The returned reference may contain a single signature (in this case a signature was captured), or multiple signatures (when a true reference was captured). It is the responsability of the application to convert the reference to a signature if the returned object includes a single signature.
|
|
Create a new SPReference object from a flat file object. This function deserializes an SPReference object serialized by SPFlatFileCreateFromReference. SPReferenceCreateFromFlatFile() is equivalent to SPReferenceCreateFromFlatFile3() 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:
|
|
Create a new SPReference object from a flat file object. This function deserializes an SPReference object serialized by SPFlatFileCreateFromReference. This function does not use environment variable SIGNWARE_ISO_LOAD.
|
|
Create an SPReference object from the result of a signature acquiry. The returned reference may contain a single signature (in this case a signature was captured), or multiple signatures (when a true reference was captured). It is the responsability of the application to convert the reference to a signature if the returned object includes a single signature.
|
|
Create an SPReference object from an SPTellerImage object.
|
|
Deallocate an SPReference object. The SPReference object must have been created by SPReferenceCreate, SPReferenceCreateFromFlatFile, SPReferenceCreateFromFlatFile3, SPReferenceCreateFromGuiAcqu, SPReferenceCreateFromTellerImage, SPReferenceClone, or SPGuiAcquGetReference.
|
|
Deallocate a bitmap created by SPReferenceGetImage or SPReferenceGetImage2.
|
|
Get the quality of the dynamic features of the signatures contained in an SPReference object.
|
|
Create a bitmap from a signature stored in an SPReference object.
|
|
Create a bitmap from a signature stored in an SPReference object.
|
|
Get the size of an image for a signature of an SPReference object. The actual image might be slightly bigger than predicted by this function.
|
|
Get the number of signatures contained in an SPReference object.
|
|
Get the quality of the static features of a signature contained in an SPReference object.
|
|
Check the variance of the signatures contained in an SPReference object. This function is equivalent to SPReferenceGetVarianceEx with 80 being passed for iQuality.
|
|
Check the variance of the signatures contained in an SPReference object. SPReferenceGetVarianceEx calculates the variance based on a static compare of all embedded signatures against each other (the match rate of each single signature comparison must exceed iQuality)
|
|
Mirror a reference vertically. The reference is mirrored such that for each signature the range of Y coordinates is not changed.
|