com.upek.android.ptapi.struct
Class PtSessionCfgV4

java.lang.Object
  extended by com.upek.android.ptapi.struct.PtSessionCfgV4
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class PtSessionCfgV4
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

PT_SESSION_CFG structure version 4

See Also:
Serialized Form

Field Summary
 short antispoofingEnable
          If PT_TRUE, antispoofing is enabled
 short antispoofingSecurityLevel
          Level of anti-spoofing security (see PT_ANTISPOOFING_xxxx values)
 short bioEnrollInputType
          Reconstruction type for enrollment (see PT_BIO_INPUT_TYPE_xxxx values)
 short bioFingerDetectInputType
          Reconstruction type for finger detection commands (see PT_BIO_INPUT_TYPE_xxxx values)
 short bioVerifyInputType
          Reconstruction type for verification (see PT_BIO_INPUT_TYPE_xxxx values)
 int callbackLevel
          Indicates what amount of GUI callbacks is received during biometric operations (see CALLBACKS_xxxx values)
 byte consolidationType
          Type of consolidation in multienrollment (see PT_CONSOLIDATION_xxxx values)
 byte createWrappedBIRs
          Indicates whether or not wrapped BIRs should be created by biometric functions
 short enableScanQualityQuery
          Bitmask of scan quality modes (see PT_SCANQUALQUERY_xxxx values)
 byte enrollMaxMinu
          Max number of minutiaes in biometric template after enroll (must be less or equal to ExtractionMaxMinu)
 byte extractionMaxMinu
          Max number of minutiaes in biometric template from extraction
 byte identificationThreshold
          Threshold for biometric identification
 boolean latentDetect
          Indicates whether or not latent detection should be activated (valid only for area sensor)
 boolean multipleEnroll
          Indicates whether or not enrollment should use multiple finger images
 int navClickAllowedMovement
          Maximum allowed movement for click
 short navClickTimeMax
          Maximum elapsed time to detect a click
 short navClickTimeMin
          Minimum elapsed time to detect a click
 short navFingerDownDelay
          Timing for finger touch
 short navFingerUpDelay
          Timing for finger lift
 short navFlags
          Navigation flags (see PT_NAVIG_xxxx values)
 short navMovementDelay
          Delay before movement detection
 short navNavigationType
          Navigation type (see PT_NAVTYPE_xxxx values)
 byte navOrientation
          Orientation of navigation (see PT_NAVORIENT_xxxx values)
 boolean navSubPixelPrecision
          Use sub-pixel precision for navigation
 boolean navUseHwDetection
          Use Hardware finger detection
 byte recNoiseRobustness
          Noise robustness setting (see PT_NOISE_ROBUSTNESS_xxxx)
 int recNoMovementResetTimeout
          If no movement is detected for that period [ms] and image is very short, the reconstruction is not restarted any more.
 int recNoMovementTimeout
          If no movement is detected for that period [ms], the swipe is terminated regardless on the finger presence.
 boolean recRemoveBottomup
          Remove striation from bottom
 boolean recRemoveTopdown
          Remove striation from top
 byte recSwipeDirection
          Swipe direction (see PT_SWIPEDIR_xxxx values)
 int recSwipeTimeout
          Timeout for swipe termination
 short recTerminationPolicy
          Defines the way, how end of finger scan is determined (see PT_SCAN_TERMINATION_xxxx values)
 boolean recUseHwDetection
          Use Hardware finger detection
 byte[] reserved1
          Not used
 byte[] reserved2
          Not used
 byte[] reserved4
          Not used
 byte[] reserved5
          Not used
 boolean restartBioTimeout
          Restart biometric timeout for each fingerprint scan
 byte retuning
          Enable retuning (see PT_RETUNING_xxxx values)
 int securitySetting
          Security level for templates matching (see PT_MATCH_xxxx values)
 boolean sensorDisabling
          Indicates whether or not put sensor into sleep mode after each biometric operation
 byte sensorSecurityMode
          Sensor security mode (see PT_SSM_xxxx values) (this parameter affects SOnly)
 byte signatureType
          Type of signing method (see PT_SIGNATURE_TYPE_xxxx values)
 boolean subSample
          Indicates wsether or not extraction should sub-sample images
 byte subWindowArea
          Area of the subwindow in percents of the full area used for extractor
 byte suspendInSleep
          Enable device suspend during PTSleep/PTSleepThenGrab/PTSleepThenCapture (see PT_SUSPEND_IN_SLEEP_xxxx values) (this parameter affects SOnly)
 byte templateType
          Type of templates created by FM (see PT_TEMPLATE_TYPE_xxxx values)
 boolean useHwFingerDetection
          Use TCD based hardware finger detection for biometrics
 boolean wakeUpByFinger
          If PT_TRUE, FM can be woken up from deep sleep by a finger on sensor
 int wakeUpByFingerTimeout
          Timeout for returning to standby after wake-up by finger (in milliseconds)
 short wffFingerDownDelay
          Timing for finger touch
 short wffFingerUpDelay
          Timing for finger lift
 boolean wffUseHwDetection
          Use Hardware finger detection
 
Constructor Summary
PtSessionCfgV4()
           
 
Method Summary
 PtSessionCfgV4 clone()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

antispoofingEnable

public short antispoofingEnable
If PT_TRUE, antispoofing is enabled


antispoofingSecurityLevel

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


bioEnrollInputType

public short bioEnrollInputType
Reconstruction type for enrollment (see PT_BIO_INPUT_TYPE_xxxx values)


bioFingerDetectInputType

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


bioVerifyInputType

public short bioVerifyInputType
Reconstruction type for verification (see PT_BIO_INPUT_TYPE_xxxx values)


callbackLevel

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


consolidationType

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


createWrappedBIRs

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


enableScanQualityQuery

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


enrollMaxMinu

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


extractionMaxMinu

public byte extractionMaxMinu
Max number of minutiaes in biometric template from extraction


identificationThreshold

public byte identificationThreshold
Threshold for biometric identification


latentDetect

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


multipleEnroll

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


navClickAllowedMovement

public int navClickAllowedMovement
Maximum allowed movement for click


navClickTimeMax

public short navClickTimeMax
Maximum elapsed time to detect a click


navClickTimeMin

public short navClickTimeMin
Minimum elapsed time to detect a click


navFingerDownDelay

public short navFingerDownDelay
Timing for finger touch


navFingerUpDelay

public short navFingerUpDelay
Timing for finger lift


navFlags

public short navFlags
Navigation flags (see PT_NAVIG_xxxx values)


navMovementDelay

public short navMovementDelay
Delay before movement detection


navNavigationType

public short navNavigationType
Navigation type (see PT_NAVTYPE_xxxx values)


navOrientation

public byte navOrientation
Orientation of navigation (see PT_NAVORIENT_xxxx values)


navSubPixelPrecision

public boolean navSubPixelPrecision
Use sub-pixel precision for navigation


navUseHwDetection

public boolean navUseHwDetection
Use Hardware finger detection


recNoiseRobustness

public byte recNoiseRobustness
Noise robustness setting (see PT_NOISE_ROBUSTNESS_xxxx)


recNoMovementResetTimeout

public 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

public 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

public boolean recRemoveBottomup
Remove striation from bottom


recRemoveTopdown

public boolean recRemoveTopdown
Remove striation from top


recSwipeDirection

public byte recSwipeDirection
Swipe direction (see PT_SWIPEDIR_xxxx values)


recSwipeTimeout

public int recSwipeTimeout
Timeout for swipe termination


recTerminationPolicy

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


recUseHwDetection

public boolean recUseHwDetection
Use Hardware finger detection


reserved1

public byte[] reserved1
Not used


reserved2

public byte[] reserved2
Not used


reserved4

public byte[] reserved4
Not used


reserved5

public byte[] reserved5
Not used


restartBioTimeout

public boolean restartBioTimeout
Restart biometric timeout for each fingerprint scan


retuning

public byte retuning
Enable retuning (see PT_RETUNING_xxxx values)


securitySetting

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


sensorDisabling

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


sensorSecurityMode

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


signatureType

public byte signatureType
Type of signing method (see PT_SIGNATURE_TYPE_xxxx values)


subSample

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


subWindowArea

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


suspendInSleep

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


templateType

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


useHwFingerDetection

public boolean useHwFingerDetection
Use TCD based hardware finger detection for biometrics


wakeUpByFinger

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


wakeUpByFingerTimeout

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


wffFingerDownDelay

public short wffFingerDownDelay
Timing for finger touch


wffFingerUpDelay

public short wffFingerUpDelay
Timing for finger lift


wffUseHwDetection

public boolean wffUseHwDetection
Use Hardware finger detection

Constructor Detail

PtSessionCfgV4

public PtSessionCfgV4()
Method Detail

clone

public PtSessionCfgV4 clone()
                     throws java.lang.CloneNotSupportedException
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException