Serialized Form


Package com.upek.android.ptapi

Class com.upek.android.ptapi.PtException extends java.lang.Exception implements Serializable


Package com.upek.android.ptapi.callback

Class com.upek.android.ptapi.callback.PtStdGuiStateCallback extends java.lang.Object implements Serializable


Package com.upek.android.ptapi.rsa

Class com.upek.android.ptapi.rsa.RSAPrivateCrtKey extends java.lang.Object implements Serializable

Class com.upek.android.ptapi.rsa.RSAPrivateKey extends java.lang.Object implements Serializable

Class com.upek.android.ptapi.rsa.RSAPublicKey extends java.lang.Object implements Serializable


Package com.upek.android.ptapi.struct

Class com.upek.android.ptapi.struct.PtBir extends java.lang.Object implements Serializable

Serialized Fields

data

byte[] data

factorsMask

int factorsMask

formatID

short formatID

formatOwner

short formatOwner

headerVersion

byte headerVersion

purpose

byte purpose

quality

byte quality

type

byte type

Class com.upek.android.ptapi.struct.PtDeviceListItem extends java.lang.Object implements Serializable

Serialized Fields

displayInfo

java.lang.String displayInfo
String with displayable device info


dsnSubString

java.lang.String dsnSubString
String usable as part of DSN for PTOpen() to connect to this device


otherInfo

java.lang.String otherInfo
String with other info

Class com.upek.android.ptapi.struct.PtExtendedInfo extends java.lang.Object implements Serializable

Serialized Fields

guid

byte[] guid
TFM/ESS GUID


systemId

int systemId
System identification bits


systemName

java.lang.String systemName
System identification name


version

int version
Version of this structure (currently 1)

Class com.upek.android.ptapi.struct.PtExtendedInfoV2 extends PtExtendedInfo implements Serializable

Serialized Fields

bioLibVersion

int bioLibVersion
Version of used BioLib


fwFunctionality2

int fwFunctionality2
Additional flags of supported functionality


fwUpdateCount

short fwUpdateCount
Number of performed firmware updates


templateTypeFlags

int templateTypeFlags
Flags of all supported template formats (see PT_TEMPLATEBIT_xxxx)

Class com.upek.android.ptapi.struct.PtFingerListItem extends java.lang.Object implements Serializable

Serialized Fields

fingerData

byte[] fingerData
Data associated with the finger


slotNr

int slotNr
Number of slot, where is the finger stored

Class com.upek.android.ptapi.struct.PtGlobalInfo extends java.lang.Object implements Serializable

Serialized Fields

apiVersion

int apiVersion
Version of TFM API. Highest byte = major version, second highest byte = minor version, low word = subversions.


flags

int flags
Additional flags (e.g. encryption strength), see PT_GIFLAGS_xxxx.


functionality

int functionality
Bitmask, defining which blocks of functions are supported (see PT_GIFUNC_xxxx).

Class com.upek.android.ptapi.struct.PtGuiSampleImage extends java.lang.Object implements Serializable

Serialized Fields

height

int height
Image height


imageData

byte[] imageData
Image data


width

int width
Image width

Class com.upek.android.ptapi.struct.PtImgFormat extends java.lang.Object implements Serializable

Serialized Fields

compressMode

short compressMode
Data compression mode


flags

short flags
Additional flags (see PT_IMGFORMAT_FLAG_xxxx values)


inBpp

byte inBpp
Input color depth


inXDpi

short inXDpi
Input X resolution


inYDpi

short inYDpi
Input Y resolution


outBpp

byte outBpp
Output Color depth


outXDpi

short outXDpi
Output X resolution


outYDpi

short outYDpi
Output Y resolution


powerMode

short powerMode
Scanning power mode

Class com.upek.android.ptapi.struct.PtInfo extends java.lang.Object implements Serializable

Serialized Fields

authentifyId

int authentifyId
ID of the Authentify group. Every TFM with the same Authentify code belongs to the same Authentify group. If AuthentifyId == 0, PTAuthentify is not necessary. See PTAuthentify().


companionVendorCode

int companionVendorCode
Companion vendor code


fwConfig

int fwConfig
FW's configuration flags, set up during manufacturing. See PT_FWCFG_xxxx.


fwFunctionality

int fwFunctionality
Blocks of functionality included in firmware. See PT_FWFUNC_xxxx.


fwMinNextVersion

int fwMinNextVersion
Minimal version required for future firmware update


fwVariant

int fwVariant
Variant of firmware


fwVersion

int fwVersion
Version of the TFM's firmware. Highest byte = major version, second highest byte = minor version, low word = subversions/revisions.


id

int id
TFM ID. If used, allows to assign unique ID to every TFM/ESS piece. Otherwise 0.


imageHeight

short imageHeight
Sensor image height (for strip sensor max. height)


imageWidth

short imageWidth
Sensor image width


maxGrabWindow

int maxGrabWindow
Max. guaranteed length of the output data for PTGrabWindow


sensorType

int sensorType
Type and version of sensor.


usage

int usage
Type of the reader in which the TFM is used. 0 = unspecified usage.

Class com.upek.android.ptapi.struct.PtInputBir extends java.lang.Object implements Serializable

Serialized Fields

bir

PtBir bir
Used when byForm = PT_FULLBIR_INPUT


form

byte form
Form of the input BIR


slotNr

int slotNr
Used when byForm = PT_SLOT_INPUT

Class com.upek.android.ptapi.struct.PtMatchOnHostParams extends java.lang.Object implements Serializable

Serialized Fields

identificationThreshold

byte identificationThreshold
Threshold for biometric identification


securitySetting

int securitySetting
Security level for templates matching (see PT_MATCH_xxxx values)


version

int version
Version of this structure (currently 1)

Class com.upek.android.ptapi.struct.PtNavigationData extends java.lang.Object implements Serializable

Serialized Fields

dx

short dx
Delta X since the last navigation data


dy

short dy
Delta Y since the last navigation data


signalBits

short signalBits
Information bitmask, see PT_NAVIGBITS_xxxx

Class com.upek.android.ptapi.struct.PtSessionCfgV1 extends java.lang.Object implements Serializable

Serialized Fields

antispoofingLevel

int antispoofingLevel
Level of anti-spoofing security (see PT_ANTISPOOFING_xxxx values)


callbackLevel

int callbackLevel
Indicates what amount of GUI callbacks is received during biometric operations (see CALLBACKS_xxxx values)


latentDetect

boolean latentDetect
Indicates whether or not latent detection should be activated (valid only for area sensor)


multipleEnroll

boolean multipleEnroll
Indicates whether or not enrollment should use multiple finger images


reserved

byte[] reserved
Not used


securitySetting

int securitySetting
Security level for templates matching (see PT_MATCH_xxxx values)


sensorDisabling

boolean sensorDisabling
Indicates whether or not put sensor into sleep mode after each biometric operation


subSample

boolean subSample
Indicates wsether or not extraction should sub-sample images

Class com.upek.android.ptapi.struct.PtSessionCfgV2 extends java.lang.Object implements Serializable

Serialized Fields

antispoofingLevel

int antispoofingLevel
Level of anti-spoofing security (see PT_ANTISPOOFING_xxxx values)


callbackLevel

int callbackLevel
Indicates what amount of GUI callbacks is received during biometric operations (see CALLBACKS_xxxx values)


latentDetect

boolean latentDetect
Indicates whether or not latent detection should be activated (valid only for area sensor)


multipleEnroll

boolean multipleEnroll
Indicates whether or not enrollment should use multiple finger images


navClickAllowedMovement

int navClickAllowedMovement
Maximum allowed movement for click


navClickTimeMax

short navClickTimeMax
Maximum elapsed time to detect a click


navClickTimeMin

short navClickTimeMin
Minimum elapsed time to detect a click


navFingerDownDelay

short navFingerDownDelay
Timing for finger touch


navFingerUpDelay

short navFingerUpDelay
Timing for finger lift


navMovementDelay

short navMovementDelay
Delay before movement detection


navUseHwDetection

boolean navUseHwDetection
Use Hardware finger detection


recFingerDownDelay

short recFingerDownDelay
Timing for finger touch


recFingerUpDelay

short recFingerUpDelay
Timing for finger lift


recRemoveBottomup

boolean recRemoveBottomup
Remove striation from bottom


recRemoveTopdown

boolean recRemoveTopdown
Remove striation from top


recUseHwDetection

boolean recUseHwDetection
Use Hardware finger detection


securitySetting

int securitySetting
Security level for templates matching (see PT_MATCH_xxxx values)


sensorDisabling

boolean sensorDisabling
Indicates whether or not put sensor into sleep mode after each biometric operation


subSample

boolean subSample
Indicates wsether or not extraction should sub-sample images


subWindowArea

byte subWindowArea
Area of the subwindow in percents of the full area used for extractor


wakeUpByFinger

boolean wakeUpByFinger
If PT_TRUE, FM can be woken up from deep sleep by a finger on sensor


wffFingerDownDelay

short wffFingerDownDelay
Timing for finger touch


wffFingerUpDelay

short wffFingerUpDelay
Timing for finger lift


wffUseHwDetection

boolean wffUseHwDetection
Use Hardware finger detection

Class com.upek.android.ptapi.struct.PtSessionCfgV3 extends java.lang.Object implements Serializable

Serialized Fields

antispoofingLevel

int antispoofingLevel
Level of anti-spoofing security (see PT_ANTISPOOFING_xxxx values)


bioEnrollInputType

short bioEnrollInputType
Reconstruction type for enrollment (see PT_BIO_INPUT_TYPE_xxxx values)


bioVerifyInputType

short bioVerifyInputType
Reconstruction type for verification (see PT_BIO_INPUT_TYPE_xxxx values)


callbackLevel

int callbackLevel
Indicates what amount of GUI callbacks is received during biometric operations (see CALLBACKS_xxxx values)


consolidationType

byte consolidationType
Type of consolidation in multienrollment (see PT_CONSOLIDATION_xxxx values)


enableScanQualityQuery

short enableScanQualityQuery
Bitmask of scan quality modes (see PT_SCANQUALQUERY_xxxx values)


latentDetect

boolean latentDetect
Indicates whether or not latent detection should be activated (valid only for area sensor)


multipleEnroll

boolean multipleEnroll
Indicates whether or not enrollment should use multiple finger images


navClickAllowedMovement

int navClickAllowedMovement
Maximum allowed movement for click


navClickTimeMax

short navClickTimeMax
Maximum elapsed time to detect a click


navClickTimeMin

short navClickTimeMin
Minimum elapsed time to detect a click


navFingerDownDelay

short navFingerDownDelay
Timing for finger touch


navFingerUpDelay

short navFingerUpDelay
Timing for finger lift


navMovementDelay

short navMovementDelay
Delay before movement detection


navNavigationType

short navNavigationType
Navigation type (see PT_NAVTYPE_xxxx values)


navUseHwDetection

boolean navUseHwDetection
Use Hardware finger detection


recDigitalGain

byte recDigitalGain
Digital gain


recFingerDownDelay

short recFingerDownDelay
Timing for finger touch


recFingerUpDelay

short recFingerUpDelay
Timing for finger lift


recRemoveBottomup

boolean recRemoveBottomup
Remove striation from bottom


recRemoveTopdown

boolean recRemoveTopdown
Remove striation from top


recRetuning

byte recRetuning
Enable retuning (see PT_RETUNING_xxxx values)


recTerminationPolicy

short recTerminationPolicy
Defines the way, how end of finger scan is determined (see PT_SCAN_TERMINATION_xxxx values)


recUseHwDetection

boolean recUseHwDetection
Use Hardware finger detection


securitySetting

int securitySetting
Security level for templates matching (see PT_MATCH_xxxx values)


sensorDisabling

boolean sensorDisabling
Indicates whether or not put sensor into sleep mode after each biometric operation


subSample

boolean subSample
Indicates wsether or not extraction should sub-sample images


subWindowArea

byte subWindowArea
Area of the subwindow in percents of the full area used for extractor


wakeUpByFinger

boolean wakeUpByFinger
If PT_TRUE, FM can be woken up from deep sleep by a finger on sensor


wakeUpByFingerTimeout

int wakeUpByFingerTimeout
Timeout for returning to standby after wake-up by finger (in milliseconds)


wffFingerDownDelay

short wffFingerDownDelay
Timing for finger touch


wffFingerUpDelay

short wffFingerUpDelay
Timing for finger lift


wffUseHwDetection

boolean wffUseHwDetection
Use Hardware finger detection

Class com.upek.android.ptapi.struct.PtSessionCfgV4 extends java.lang.Object implements Serializable

Serialized Fields

antispoofingEnable

short antispoofingEnable
If PT_TRUE, antispoofing is enabled


antispoofingSecurityLevel

short antispoofingSecurityLevel
Level of anti-spoofing security (see PT_ANTISPOOFING_xxxx values)


bioEnrollInputType

short bioEnrollInputType
Reconstruction type for enrollment (see PT_BIO_INPUT_TYPE_xxxx values)


bioFingerDetectInputType

short bioFingerDetectInputType
Reconstruction type for finger detection commands (see PT_BIO_INPUT_TYPE_xxxx values)


bioVerifyInputType

short bioVerifyInputType
Reconstruction type for verification (see PT_BIO_INPUT_TYPE_xxxx values)


callbackLevel

int callbackLevel
Indicates what amount of GUI callbacks is received during biometric operations (see CALLBACKS_xxxx values)


consolidationType

byte consolidationType
Type of consolidation in multienrollment (see PT_CONSOLIDATION_xxxx values)


createWrappedBIRs

byte createWrappedBIRs
Indicates whether or not wrapped BIRs should be created by biometric functions


enableScanQualityQuery

short enableScanQualityQuery
Bitmask of scan quality modes (see PT_SCANQUALQUERY_xxxx values)


enrollMaxMinu

byte enrollMaxMinu
Max number of minutiaes in biometric template after enroll (must be less or equal to ExtractionMaxMinu)


extractionMaxMinu

byte extractionMaxMinu
Max number of minutiaes in biometric template from extraction


identificationThreshold

byte identificationThreshold
Threshold for biometric identification


latentDetect

boolean latentDetect
Indicates whether or not latent detection should be activated (valid only for area sensor)


multipleEnroll

boolean multipleEnroll
Indicates whether or not enrollment should use multiple finger images


navClickAllowedMovement

int navClickAllowedMovement
Maximum allowed movement for click


navClickTimeMax

short navClickTimeMax
Maximum elapsed time to detect a click


navClickTimeMin

short navClickTimeMin
Minimum elapsed time to detect a click


navFingerDownDelay

short navFingerDownDelay
Timing for finger touch


navFingerUpDelay

short navFingerUpDelay
Timing for finger lift


navFlags

short navFlags
Navigation flags (see PT_NAVIG_xxxx values)


navMovementDelay

short navMovementDelay
Delay before movement detection


navNavigationType

short navNavigationType
Navigation type (see PT_NAVTYPE_xxxx values)


navOrientation

byte navOrientation
Orientation of navigation (see PT_NAVORIENT_xxxx values)


navSubPixelPrecision

boolean navSubPixelPrecision
Use sub-pixel precision for navigation


navUseHwDetection

boolean navUseHwDetection
Use Hardware finger detection


recNoiseRobustness

byte recNoiseRobustness
Noise robustness setting (see PT_NOISE_ROBUSTNESS_xxxx)


recNoMovementResetTimeout

int recNoMovementResetTimeout
If no movement is detected for that period [ms] and image is very short, the reconstruction is not restarted any more. This feature is disabled if set to 0.


recNoMovementTimeout

int recNoMovementTimeout
If no movement is detected for that period [ms], the swipe is terminated regardless on the finger presence. This feature is disabled if set to 0.


recRemoveBottomup

boolean recRemoveBottomup
Remove striation from bottom


recRemoveTopdown

boolean recRemoveTopdown
Remove striation from top


recSwipeDirection

byte recSwipeDirection
Swipe direction (see PT_SWIPEDIR_xxxx values)


recSwipeTimeout

int recSwipeTimeout
Timeout for swipe termination


recTerminationPolicy

short recTerminationPolicy
Defines the way, how end of finger scan is determined (see PT_SCAN_TERMINATION_xxxx values)


recUseHwDetection

boolean recUseHwDetection
Use Hardware finger detection


reserved1

byte[] reserved1
Not used


reserved2

byte[] reserved2
Not used


reserved4

byte[] reserved4
Not used


reserved5

byte[] reserved5
Not used


restartBioTimeout

boolean restartBioTimeout
Restart biometric timeout for each fingerprint scan


retuning

byte retuning
Enable retuning (see PT_RETUNING_xxxx values)


securitySetting

int securitySetting
Security level for templates matching (see PT_MATCH_xxxx values)


sensorDisabling

boolean sensorDisabling
Indicates whether or not put sensor into sleep mode after each biometric operation


sensorSecurityMode

byte sensorSecurityMode
Sensor security mode (see PT_SSM_xxxx values) (this parameter affects SOnly)


signatureType

byte signatureType
Type of signing method (see PT_SIGNATURE_TYPE_xxxx values)


subSample

boolean subSample
Indicates wsether or not extraction should sub-sample images


subWindowArea

byte subWindowArea
Area of the subwindow in percents of the full area used for extractor


suspendInSleep

byte suspendInSleep
Enable device suspend during PTSleep/PTSleepThenGrab/PTSleepThenCapture (see PT_SUSPEND_IN_SLEEP_xxxx values) (this parameter affects SOnly)


templateType

byte templateType
Type of templates created by FM (see PT_TEMPLATE_TYPE_xxxx values)


useHwFingerDetection

boolean useHwFingerDetection
Use TCD based hardware finger detection for biometrics


wakeUpByFinger

boolean wakeUpByFinger
If PT_TRUE, FM can be woken up from deep sleep by a finger on sensor


wakeUpByFingerTimeout

int wakeUpByFingerTimeout
Timeout for returning to standby after wake-up by finger (in milliseconds)


wffFingerDownDelay

short wffFingerDownDelay
Timing for finger touch


wffFingerUpDelay

short wffFingerUpDelay
Timing for finger lift


wffUseHwDetection

boolean wffUseHwDetection
Use Hardware finger detection

Class com.upek.android.ptapi.struct.PtSessionCfgV5 extends java.lang.Object implements Serializable

Serialized Fields

antispoofingEnable

byte antispoofingEnable
If PT_TRUE, antispoofing is enabled


antispoofingRejectsEnrollment

byte antispoofingRejectsEnrollment
If PT_TRUE, antispoofing rejects even enrollment captures


antispoofingSecurityLevel

byte antispoofingSecurityLevel
Level of anti-spoofing security (see PT_ANTISPOOFING_xxxx values)


bandwidth

byte bandwidth
SONLY (TCS5D only): Explicit value or lower bound (depending on policy) of bandwidth to be used in percentage of maximal available bandwidth for the sensor on given platform. Allowed values are 0-100, 0 means static maximum bandwidth.


bioEnrollInputType

byte bioEnrollInputType
Reconstruction type for enrollment (see PT_BIO_INPUT_TYPE_xxxx values)


bioFingerDetectInputType

byte bioFingerDetectInputType
Reconstruction type for finger detection commands (see PT_BIO_INPUT_TYPE_xxxx values)


bioVerifyInputType

byte bioVerifyInputType
Reconstruction type for verification (see PT_BIO_INPUT_TYPE_xxxx values)


callbackLevel

int callbackLevel
Indicates what amount of GUI callbacks is received during biometric operations (see CALLBACKS_xxxx values)


consolidationNumTemplates

byte consolidationNumTemplates
Number of templates captured for consolidation (possible values 1-5)


consolidationSecurityLevel

byte consolidationSecurityLevel
Sets trade-off between security and convenience for consolidation process (for future use)


consolidationType

byte consolidationType
Type of consolidation in multienrollment (see PT_CONSOLIDATION_xxxx values)


createWrappedBIRs

byte createWrappedBIRs
Indicates whether or not wrapped BIRs should be created by biometric functions


enableScanQualityQuery

short enableScanQualityQuery
Bitmask of scan quality modes (see PT_SCANQUALQUERY_xxxx values)


enrollMaxMinu

byte enrollMaxMinu
Max number of minutiae in biometric template after enroll


enrollMaxSize

short enrollMaxSize
Max size (in bytes) of biometric data in template after enroll (must be bigger than 25)


enrollMaxTemplates

byte enrollMaxTemplates
Do not change


enrollMinTemplates

byte enrollMinTemplates
Do not change


extractionMaxMinu

byte extractionMaxMinu
Max number of minutiae in biometric template from extraction


extractionMaxSize

short extractionMaxSize
Max size (in bytes) of biometric data in template from extraction (must be bigger than 25)


fdetFlags

int fdetFlags
Finger detection flags (see PT_FDETFLAG_xxxx values).


identificationThreshold

byte identificationThreshold
Threshold for biometric identification


imageFormatPolicy

byte imageFormatPolicy
SONLY (TCRS5D only): Image format policy (see PT_IMGPOLICY_xxxx values)


latentDetect

byte latentDetect
Indicates whether or not latent detection should be activated (valid only for area sensor)


multipleEnroll

byte multipleEnroll
Indicates whether or not enrollment should use multiple finger images


navClickAllowedMovement

int navClickAllowedMovement
Maximum allowed movement for click


navClickSensitivity

byte navClickSensitivity
Click detection sensitivity setting


navClickTimeMax

short navClickTimeMax
Maximum elapsed time to detect a click


navClickTimeMin

short navClickTimeMin
Minimum elapsed time to detect a click


navFingerDownDelay

short navFingerDownDelay
Timing for finger touch


navFingerUpDelay

short navFingerUpDelay
Timing for finger lift


navFlags

short navFlags
Navigation flags (see PT_NAVIG_xxxx values)


navMovementDelay

short navMovementDelay
Delay before movement detection


navNavigationType

byte navNavigationType
Navigation type (see PT_NAVTYPE_xxxx values)


navOrientation

byte navOrientation
Orientation of navigation (see PT_NAVORIENT_xxxx values)


powerFlags

short powerFlags
Power management flags (see PT_POWERFLAG_xxxx values).


readerSecurityMode

byte readerSecurityMode
SONLY (TCRxx only): Reader security mode (see PT_RSM_xxxx values).


recFlags

int recFlags
Reconstruction control flags (see PT_RECFLAG_xxxx values)


recNoiseRobustness

byte recNoiseRobustness
Noise robustness setting (see PT_NOISE_ROBUSTNESS_xxxx)


recNoiseRobustnessTrigger

byte recNoiseRobustnessTrigger
Sets how many consecutive bad swipes triggers noise robustness. Value of 0 means no triggering by bad swipes.


recNoMovementResetTimeout

int recNoMovementResetTimeout
If no movement is detected for that period [ms] and image is very short, the reconstruction is not restarted any more. This feature is disabled if set to 0.


recNoMovementTimeout

int recNoMovementTimeout
If no movement is detected for that period [ms], the swipe is terminated regardless on the finger presence. This feature is disabled if set to 0.


recSwipeDirection

byte recSwipeDirection
Swipe direction (see PT_SWIPEDIR_xxxx values)


recSwipeTimeout

int recSwipeTimeout
Timeout for swipe termination


recTerminationPolicy

byte recTerminationPolicy
Defines the way, how end of finger scan is determined (see PT_SCAN_TERMINATION_xxxx values)


reserved1

byte[] reserved1
Not used


reserved2

byte[] reserved2
Not used


reserved3

byte[] reserved3
Not used


reserved4

byte[] reserved4

restartBioTimeout

byte restartBioTimeout
Restart biometric timeout for each fingerprint scan


retuning

byte retuning
Enable retuning (see PT_RETUNING_xxxx values)


securitySetting

byte securitySetting
Security level for templates matching (see PT_MATCH_xxxx values)


sensorDisabling

byte sensorDisabling
Indicates whether or not put sensor into sleep mode after each biometric operation


sensorSecurityMode

byte sensorSecurityMode
Sensor security mode (see PT_SSM_xxxx values) (this parameter affects SOnly)


signatureType

byte signatureType
Type of signing method (see PT_SIGNATURE_TYPE_xxxx values)


suspendInSleep

byte suspendInSleep
Enable device suspend during PTSleep/PTSleepThenGrab/PTSleepThenCapture (see PT_SUSPEND_IN_SLEEP_xxxx values) (this parameter affects SOnly)


templateType

byte templateType
Type of templates created by FM (see PT_TEMPLATE_TYPE_xxxx values)


useHwFingerDetection

byte useHwFingerDetection
Use TCD based hardware finger detection for biometrics


wakeUpByFinger

byte wakeUpByFinger
If PT_TRUE, FM can be woken up from deep sleep by a finger on sensor


wakeUpByFingerTimeout

int wakeUpByFingerTimeout
Timeout for returning to standby after wake-up by finger (in milliseconds)


wffFingerDownDelay

short wffFingerDownDelay
Timing for finger touch


wffFingerUpDelay

short wffFingerUpDelay
Timing for finger lift

Class com.upek.android.ptapi.struct.PtSwipeInfo extends java.lang.Object implements Serializable

Serialized Fields

backgroundColor

short backgroundColor
Image background color.


invertedSwipe

byte invertedSwipe
Direction of swipe (0 = standard direction, 1 = inverted direction).


noiseRobustnessFlags

byte noiseRobustnessFlags
Noise robustness flags.


qualityMessage

short qualityMessage
GUI message resulting from image quality test (see PT_GUIMSG_xxxx), 0xffff when image quality wasn't assessed.


qualityScore

byte qualityScore
Image quality score, negative when image quality wasn't assessed.


realHeight

short realHeight
Number of actually reconstructed lines.


recErrorStates

short recErrorStates
Bit array with signaled reconstruction errors (see PT_RECERRBIT_xxxx).


recScore

byte recScore
Reconstruction score.


roiLength

short roiLength
Vertical length of the region of interest, zero if no ROI was detected.


roiPos

short roiPos
Vertical position of the center of the region of interest (e.g. the core). Negative if no ROI was detected.