com.upek.android.ptapi.struct
Class PtSessionCfgV5

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

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

PT_SESSION_CFG structure version 5

See Also:
Serialized Form

Field Summary
 byte antispoofingEnable
          If PT_TRUE, antispoofing is enabled
 byte antispoofingRejectsEnrollment
          If PT_TRUE, antispoofing rejects even enrollment captures
 byte antispoofingSecurityLevel
          Level of anti-spoofing security (see PT_ANTISPOOFING_xxxx values)
 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.
 byte bioEnrollInputType
          Reconstruction type for enrollment (see PT_BIO_INPUT_TYPE_xxxx values)
 byte bioFingerDetectInputType
          Reconstruction type for finger detection commands (see PT_BIO_INPUT_TYPE_xxxx values)
 byte 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 consolidationNumTemplates
          Number of templates captured for consolidation (possible values 1-5)
 byte consolidationSecurityLevel
          Sets trade-off between security and convenience for consolidation process (for future use)
 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 minutiae in biometric template after enroll
 short enrollMaxSize
          Max size (in bytes) of biometric data in template after enroll (must be bigger than 25)
 byte enrollMaxTemplates
          Do not change
 byte enrollMinTemplates
          Do not change
 byte extractionMaxMinu
          Max number of minutiae in biometric template from extraction
 short extractionMaxSize
          Max size (in bytes) of biometric data in template from extraction (must be bigger than 25)
 int fdetFlags
          Finger detection flags (see PT_FDETFLAG_xxxx values).
 byte identificationThreshold
          Threshold for biometric identification
 byte imageFormatPolicy
          SONLY (TCRS5D only): Image format policy (see PT_IMGPOLICY_xxxx values)
 byte latentDetect
          Indicates whether or not latent detection should be activated (valid only for area sensor)
 byte multipleEnroll
          Indicates whether or not enrollment should use multiple finger images
 int navClickAllowedMovement
          Maximum allowed movement for click
 byte navClickSensitivity
          Click detection sensitivity setting
 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
 byte navNavigationType
          Navigation type (see PT_NAVTYPE_xxxx values)
 byte navOrientation
          Orientation of navigation (see PT_NAVORIENT_xxxx values)
 short powerFlags
          Power management flags (see PT_POWERFLAG_xxxx values).
 byte readerSecurityMode
          SONLY (TCRxx only): Reader security mode (see PT_RSM_xxxx values).
 int recFlags
          Reconstruction control flags (see PT_RECFLAG_xxxx values)
 byte recNoiseRobustness
          Noise robustness setting (see PT_NOISE_ROBUSTNESS_xxxx)
 byte recNoiseRobustnessTrigger
          Sets how many consecutive bad swipes triggers noise robustness.
 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.
 byte recSwipeDirection
          Swipe direction (see PT_SWIPEDIR_xxxx values)
 int recSwipeTimeout
          Timeout for swipe termination
 byte recTerminationPolicy
          Defines the way, how end of finger scan is determined (see PT_SCAN_TERMINATION_xxxx values)
 byte[] reserved1
          Not used
 byte[] reserved2
          Not used
 byte[] reserved3
          Not used
 byte[] reserved4
           
 byte restartBioTimeout
          Restart biometric timeout for each fingerprint scan
 byte retuning
          Enable retuning (see PT_RETUNING_xxxx values)
 byte securitySetting
          Security level for templates matching (see PT_MATCH_xxxx values)
 byte 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)
 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)
 byte useHwFingerDetection
          Use TCD based hardware finger detection for biometrics
 byte 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
 
Constructor Summary
PtSessionCfgV5()
           
 
Method Summary
 PtSessionCfgV5 clone()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

antispoofingEnable

public byte antispoofingEnable
If PT_TRUE, antispoofing is enabled


antispoofingRejectsEnrollment

public byte antispoofingRejectsEnrollment
If PT_TRUE, antispoofing rejects even enrollment captures


antispoofingSecurityLevel

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


bandwidth

public 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

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


bioFingerDetectInputType

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


bioVerifyInputType

public byte 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)


consolidationNumTemplates

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


consolidationSecurityLevel

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


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 minutiae in biometric template after enroll


enrollMaxSize

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


enrollMaxTemplates

public byte enrollMaxTemplates
Do not change


enrollMinTemplates

public byte enrollMinTemplates
Do not change


extractionMaxMinu

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


extractionMaxSize

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


fdetFlags

public int fdetFlags
Finger detection flags (see PT_FDETFLAG_xxxx values).


identificationThreshold

public byte identificationThreshold
Threshold for biometric identification


imageFormatPolicy

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


latentDetect

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


multipleEnroll

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


navClickAllowedMovement

public int navClickAllowedMovement
Maximum allowed movement for click


navClickSensitivity

public byte navClickSensitivity
Click detection sensitivity setting


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 byte navNavigationType
Navigation type (see PT_NAVTYPE_xxxx values)


navOrientation

public byte navOrientation
Orientation of navigation (see PT_NAVORIENT_xxxx values)


powerFlags

public short powerFlags
Power management flags (see PT_POWERFLAG_xxxx values).


readerSecurityMode

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


recFlags

public int recFlags
Reconstruction control flags (see PT_RECFLAG_xxxx values)


recNoiseRobustness

public byte recNoiseRobustness
Noise robustness setting (see PT_NOISE_ROBUSTNESS_xxxx)


recNoiseRobustnessTrigger

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


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.


recSwipeDirection

public byte recSwipeDirection
Swipe direction (see PT_SWIPEDIR_xxxx values)


recSwipeTimeout

public int recSwipeTimeout
Timeout for swipe termination


recTerminationPolicy

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


reserved1

public byte[] reserved1
Not used


reserved2

public byte[] reserved2
Not used


reserved3

public byte[] reserved3
Not used


reserved4

public byte[] reserved4

restartBioTimeout

public byte restartBioTimeout
Restart biometric timeout for each fingerprint scan


retuning

public byte retuning
Enable retuning (see PT_RETUNING_xxxx values)


securitySetting

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


sensorDisabling

public byte 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)


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 byte useHwFingerDetection
Use TCD based hardware finger detection for biometrics


wakeUpByFinger

public byte 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

Constructor Detail

PtSessionCfgV5

public PtSessionCfgV5()
Method Detail

clone

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