Programas Biometricos de Seguridad PDF

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.
1 and VeriSpeak Embedded 1.1 SDK for Android

Developer's Guide
Copyright 2011-2013 Neurotechnology. All rights reserved.
MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,
Table of Contents 1 About

1.1 System Requirements 1.2 Licensing
1
1 1
2 Installation 3 What's New 4 Overview

4.1 SDK Components 4.1.1 Embedded Fingerprint Extractor 4.1.2 Embedded Fingerprint Matcher 4.1.3 Embedded Face Extractor 4.1.4 Embedded Face Matcher 4.1.5 Embedded Voice Extractor 4.1.6 Embedded Voice Matcher 4.2 Supported Biometric Standards 4.2.1 Fingerprint BSS 4.2.2 Face BSS 4.2.3 Iris BSS 4.3 Required Libraries 4.4 Supported Devices 4.4.1 Fingerprint Scanners
3 4 7
7 7 7 7 8 8 8 8 9 10 10 11 11 11
5 Using
5.1 System Setup Instructions 5.2 Android Activation 5.3 Matching Threshold and FAR/FRR 5.4 Quick Start
13
13 14 21 23
6 Tutorials 7 Samples
24 26
ii
7.1 VeriLook 7.2 VeriFinger 7.3 VeriSpeak 7.4 VeriEye 7.5 Java Samples Compilation
27 32 40 45 50
8 API Reference
8.1 Java Reference 8.1.1 com.neurotec.biometrics Package 8.1.1.1 Classes 8.1.1.1.1 NBiometricAttributes Class 8.1.1.1.2 NBiometrics Class 8.1.1.1.3 NBiometricTypes Class 8.1.1.1.4 NEAttributes Class 8.1.1.1.5 NEESegmentationDetails Class 8.1.1.1.6 NEExtractor Class 8.1.1.1.7 NEMatchingDetails Class 8.1.1.1.8 NERecord Class 8.1.1.1.9 NETemplate Class 8.1.1.1.10 NFAttributes Class 8.1.1.1.11 NFCore Class 8.1.1.1.12 NFDelta Class 8.1.1.1.13 NFDoubleCore Class 8.1.1.1.14 NFExtractor Class 8.1.1.1.15 NFMatchingDetails Class 8.1.1.1.16 NFMinutia Class 8.1.1.1.17 NFMinutiaNeighbor Class 8.1.1.1.18 NFRecord Class 8.1.1.1.19 NFTemplate Class 8.1.1.1.20 NLAttributes Class 8.1.1.1.21 NLEDetectionDetails Class 8.1.1.1.22 NLEEyes Class 8.1.1.1.23 NLEFace Class 8.1.1.1.24 NLERotation Class 8.1.1.1.25 NLExtractor Class 8.1.1.1.26 NLFeaturePoint Class 8.1.1.1.27 NLMatchingDetails Class 8.1.1.1.28 NLRecord Class 8.1.1.1.29 NLTemplate Class 8.1.1.1.30 NMatcher Class
58
59 60 61 61 63 63 65 67 68 75 75 80 83 85 87 90 91 105 106 110 110 130 135 136 140 141 142 143 161 163 163 167 170 iii
8.1.1.1.31 NMatchingDetails Class 8.1.1.1.32 NMatchingDetailsBase Class 8.1.1.1.33 NSAttributes Class 8.1.1.1.34 NSExtractor Class 8.1.1.1.35 NSMatchingDetails Class 8.1.1.1.36 NSRecord Class 8.1.1.1.37 NSTemplate Class 8.1.1.1.38 NTemplate Class 8.1.2 com.neurotec.biometrics.standards Package 8.1.2.1 Classes 8.1.2.1.1 ANASCIIBinaryRecord Class 8.1.2.1.2 ANASCIIRecord Class 8.1.2.1.3 ANBinaryRecord Class 8.1.2.1.4 ANCharset Class 8.1.2.1.5 ANFAlternateSegment Class 8.1.2.1.6 ANFAmputation Class 8.1.2.1.7 ANFCore Class 8.1.2.1.8 ANFDelta Class 8.1.2.1.9 ANField Class 8.1.2.1.10 ANFImageBinaryRecord Class 8.1.2.1.11 ANFPatternClass Class 8.1.2.1.12 ANFPImageASCIIBinaryRecord Class 8.1.2.1.13 ANFPMinutia Class 8.1.2.1.14 ANFPositionDescriptor Class 8.1.2.1.15 ANFPQualityMetric Class 8.1.2.1.16 ANFPrintPosition Class 8.1.2.1.17 ANFSegment Class 8.1.2.1.18 ANImageASCIIBinaryRecord Class 8.1.2.1.19 ANImageBinaryRecord Class 8.1.2.1.20 ANIrisImageProperties Class 8.1.2.1.21 ANNISTQualityMetric Class 8.1.2.1.22 ANPenVector Class 8.1.2.1.23 ANQualityMetric Class 8.1.2.1.24 ANRecord Class 8.1.2.1.25 ANRecordType Class 8.1.2.1.26 ANSMT Class 8.1.2.1.27 ANSubField Class 8.1.2.1.28 ANTemplate Class 8.1.2.1.29 ANType10Record Class 8.1.2.1.30 ANType13Record Class 8.1.2.1.31 ANType14Record Class 8.1.2.1.32 ANType15Record Class
191 196 197 198 203 203 207 210 214 217 217 220 222 223 224 224 225 226 227 229 233 234 240 245 246 247 249 250 261 265 266 267 268 270 275 283 285 286 320 342 349 360 iv
8.1.2.1.33 ANType16Record Class 8.1.2.1.34 ANType17Record Class 8.1.2.1.35 ANType1Record Class 8.1.2.1.36 ANType2Record Class 8.1.2.1.37 ANType3Record Class 8.1.2.1.38 ANType4Record Class 8.1.2.1.39 ANType5Record Class 8.1.2.1.40 ANType6Record Class 8.1.2.1.41 ANType7Record Class 8.1.2.1.42 ANType8Record Class 8.1.2.1.43 ANType99Record Class 8.1.2.1.44 ANType9Record Class 8.1.2.1.45 BDIFFaceFeaturePoint Class 8.1.2.1.46 BDIFFPMinutiaNeighbor Class 8.1.2.1.47 CBEFFBDBFormatIdentifiers Class 8.1.2.1.48 CBEFFBiometricOrganizations Class 8.1.2.1.49 FCRecord Class 8.1.2.1.50 FCRFaceImage Class 8.1.2.1.51 FIRecord Class 8.1.2.1.52 FIRFinger Class 8.1.2.1.53 FIRFingerView Class 8.1.2.1.54 FMCard Class 8.1.2.1.55 FMCBDTTags Class 8.1.2.1.56 FMCBITBHTBAPTTags Class 8.1.2.1.57 FMRCore Class 8.1.2.1.58 FMRDelta Class 8.1.2.1.59 FMRecord Class 8.1.2.1.60 FMRFinger Class 8.1.2.1.61 FMRFingerView Class 8.1.2.1.62 FMRMinutia Class 8.1.2.1.63 IIRecord Class 8.1.2.1.64 IIRIris Class 8.1.2.1.65 IIRIrisImage Class 8.1.2.1.66 NBiometricStandards Class 8.1.3 com.neurotec.biometrics.tools Package 8.1.3.1 Classes 8.1.3.1.1 NBiometricTools Class 8.1.3.1.2 NFClassifier Class 8.1.3.1.3 NFIQ Class 8.1.4 com.neurotec.devices Package 8.1.4.1 Classes 8.1.4.1.1 NBiometricDevice Class
366 372 385 400 401 404 407 410 412 414 420 425 435 437 438 449 461 467 479 488 492 495 502 503 503 506 512 521 524 532 535 547 550 555 556 556 556 557 558 559 560 560 v
8.1.4.1.2 NCamera Class 8.1.4.1.3 NCaptureDevice Class 8.1.4.1.4 NDevice Class 8.1.4.1.5 NDeviceManager Class 8.1.4.1.6 NDevices Class 8.1.4.1.7 NFingerScanner Class 8.1.4.1.8 NFScanner Class 8.1.4.1.9 NIrisScanner Class 8.1.4.1.10 NMicrophone Class 8.1.4.1.11 NPalmScanner Class 8.1.5 com.neurotec.images Package 8.1.5.1 Classes 8.1.5.1.1 NGrayscaleImage Class 8.1.5.1.2 NImage Class 8.1.5.1.3 NImageFormat Class 8.1.5.1.4 NImageInfo Class 8.1.5.1.5 NImages Class 8.1.5.1.6 NPixelFormat Class 8.1.5.1.7 NRGB Class 8.1.5.1.8 NRGBImage Class 8.1.5.1.9 PNGInfo Class 8.1.6 com.neurotec.jna Package 8.1.6.1 Classes 8.1.6.1.1 HNObject Class 8.1.6.1.2 NativeSize Class 8.1.6.1.3 NFunctionMapper Class 8.1.6.1.4 NMemory Class 8.1.6.2 Interfaces 8.1.6.2.1 NLibrary Interface 8.1.7 com.neurotec.lang Package 8.1.7.1 Classes 8.1.7.1.1 ErrorCreator Class 8.1.7.1.2 ExternalException Class 8.1.7.1.3 NAbstractDisposable Class 8.1.7.1.4 NCore Class 8.1.7.1.5 NError Class 8.1.7.1.6 NeurotecException Class 8.1.7.1.7 NModule Class 8.1.7.1.8 NObject Class 8.1.7.1.9 NRational Class 8.1.7.1.10 NResult Class 8.1.7.1.11 ParameterException Class
562 563 566 569 573 573 575 579 584 585 586 587 587 589 622 634 634 636 654 655 658 659 660 660 660 661 661 662 663 663 663 663 664 665 666 678 680 680 683 694 695 704 vi
8.1.7.1.12 ParameterReadOnlyException Class 8.1.7.2 Interfaces 8.1.7.2.1 NDisposable Interface 8.1.8 com.neurotec.licensing Package 8.1.8.1 Classes 8.1.8.1.1 NLicense Class 8.1.8.1.2 NLicenseInfo Class 8.1.8.1.3 NLicensing Class 8.1.8.1.4 NLicensingService Class 8.1.9 com.neurotec.media Package 8.1.9.1 Classes 8.1.9.1.1 NMedia Class 8.1.9.1.2 NMediaFormat Class 8.1.9.1.3 NMediaReader Class 8.1.9.1.4 NMediaSource Class 8.1.9.1.5 NVideoFormat Class 8.1.10 com.neurotec.plugins Package 8.1.10.1 Classes 8.1.10.1.1 NPlugin Class 8.1.10.1.2 NPluginManager Class 8.1.10.1.3 NPluginModule Class 8.1.11 com.neurotec.plugins.event Package 8.1.11.1 Classes 8.1.11.1.1 NPluginEvent Class 8.1.11.2 Interfaces 8.1.11.2.1 NPluginsChangeListener Interface
704 705 705 706 706 706 712 713 714 716 716 716 717 718 726 731 742 742 742 745 750 751 751 751 752 752
Index
vii
1.2 Licensing
1 About
MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android is software development kit from Neurotechnology that enables developers to create biometric applications for the Android platform (Android powered mobile devices such as smartphones and tablet computers). MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android provides required libraries to build Android based applications for live faces, fingerprints, irises and voice enrollment and matching. Also sample applications ( see page 26) (applets) with source code are included to demonstrate how to use SDK. Notes Before start using MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android, user should be familiar with Android SDK.
1.1 System Requirements

Development environment requirements Java SE JDK 6 (or higher) (http://www.oracle.com/technetwork/java/javase/downloads/index.html) Eclipse IDE 3.7 (or higher) (Eclipse Indigo) (http://eclipse.org/indigo/) Android SDK v9 (or higher; Android OS 2.3 or higher) (http://developer.android.com/sdk/installing.html) Maven 3.0.3 (http://maven.apache.org/download.html) Internet connection Note: Read more how to configure Eclipse to use Android SDK ( see page 13) and MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android ( see page 50). Hardware requirements (recommended) Android 2.3 (or higher) powered mobile device with camera 1 GHz Arm based CPU 512 MB RAM (Optional) Fingerprint scanner.
1.2 Licensing
Product based on one of MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android technology requires to obtain SDK. Each modality (component) included into MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android also requires a license. Components are copy-protected a license is required for a component to run. A license for an individual component is required for each CPU that runs the component (a processor can have any number of cores). Licenses are intended for end-user products development. Integrators who want to develop and sell a MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android based development tool (with API, programming 1
1.2 Licensing
possibilities, programming samples, etc.), must obtain permission from Neurotechnology and sign a special VAR agreement. Trial licenses Trial license is used in a period of time (usually one month) for SDK evaluation purpose before obtaining single computer license. The license will be obtained automatically via internet when using SDK trial version. Note: Trial SDK requires constant internet connection. Single computer licenses A single computer license allows the installation and running of a MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android component installation on one CPU (a processor can have any number of cores). Neurotechnology provides a way to renew the license if the device or computer undergoes changes due to technical maintenance. Each single computer license requires activation for a component to run. The available activation options are listed below. License activation options Single computer licenses are supplied in three ways: Internet activation. A special license file is stored on a device or computer; the license file allows to run particular MegaMatcher Embedded components on that device or computer after checking the license over the Internet. Internet connection should be available for a short period of time at least once in 7 days. A single computer license can be transferred to another device or computer by moving the license file there and waiting until the previous activation expires. Serial numbers are used to activate licenses for particular MegaMatcher Embedded components. The activation is done via the Internet or by email. After activation the network connection is not required for single computer license usage. Note: activation by serial number is not suitable for virtual environment Dongle. License file stored on a device or computer allows to run particular components on that device or computer. This license activation option is suitable for virtual environments and requires that Internet connection would be available for a short period of time at least once in 7 days. A single computer license can be transferred to another device or computer by moving the license file there and waiting until the previous activation expires. Notes For end-user applications it is required license file to be stored on a mobile device running Android OS. See Samples ( page 26) for more information how to transfer a license file to device. see
Using Single computer licenses, MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android connects internet occasionally (requires approximately 1MB of data traffic per 24 hours). Beware mobile network and international roaming charges. See Also Read more how to activate Android licenses ( see page 14).
2 Installation
3 What's New
March 6, 2013 Fixed directory structure for native libraries according to the Android style. Fixed variation in record quality and quality sharpness failures bug in sample. Fixed camera layout initialization bug in sample. Fixed face detection details adjustment calculations in sample. Fixed minor bugs in NCore library. Updated and simplified application state and licensing management. Redone image recognition in Android sample. Added biometrics-gui component. January 29, 2013 Futronic support via Android USB Host API. Minor internal improvements, error handling. Fixed score normalization bug, improved accuracy. Fixed NfmMatchDetails serialization bug. New face image sharpness quality measure. Updated iris segmentation, improved iris extraction speed and accuracy. Updated gender classification algorithm, improved accuracy. Updated voices matching algorithm, improved speed. Fixed internal bugs in NCore and NBiometrics library. Fixed bugs in Activation Wizard. December 18, 2012 Added new NLicensing library methods ( see page 714) (former NInstaller API).
Added ability to save sound buffer to Wav files. Added ability to return iris inner boundary ( see page 70) to iris extractor.
Added new voice activity detection, which can be used for online audio processing in real-time. Improved voice recognition accuracy. Added gender classification from face image to face extractor. Added new fingerprint slap segmentation: improved accuracy on scans from paper, slightly improved accuracy on scans from scanner. Added support for hardware licenses on Android: activation/deactivation of hardware licenses. Added separate licensing manager application. Added integration of biometric standards to all Android samples. Updated and improved rolled fingeprint recognition. Fixed Android imports. Removed obsolete NInstaller API. October 1, 2012 Native library loading moved from samples/tutorials to wrapper. Minor fixes in Abis sample. Fixed face detection issue.
Fixed obtainining license on device orientation change. Applications loading time improved. Added Biometric and BiometricTools tutorials. August 22, 2012 Updated Version of Android JNA from 3.2.7 to 3.4.1. Fixed JNA Callback crash with CheckJNI enabled (i.e. when android:debuggable flag is set to true). Fixed face detection details rendering (details were rendering incorrectly after camera resolution switch). July 25, 2012 Updated licensing manager, it is incorporated into each sample and tutorials apk's. Updated Java native code wrapper: get/set methods for parameters changed to fields in classes that map to structs in native code. Updated and simplified loading of native libraries. Updated samples to correspond a common style. Updated fingerprint sample: added support for biometric standards, modules enumeration bug fixed. Updated iris sample: added support for biometric standards. Added C tutorials for Biometrics/BiometricStandards/BiometricTools. Added Java tutorials for BiometricStandards. July 12, 2012 Fixed minor bugs in Java wrapper. Added native tutorials. June 7, 2012 Fixed minor bugs in faces and fingers samples. Updated NCore library internals. May 14, 2012 Fixed minor bugs in NBiometrics library and other libraries. Fixed minor bugs in Android face and fingerprint samples. April 27, 2012 Fixed Media library bug - unable to save WSQ image to memory. Fixed number of minor Core library bugs. April 6, 2012 Preference seekbar bug fixed in multimodal biometric sample. Iris and voice minimal value fixes. Voice settings are managed in milliseconds instead of seconds. Voice maxPhraseDuration is set to 10s instead of maximal value 60s. April 2, 2012 Release of VeriSpeak for voice recognition and VeriEye ( see page 45) for iris recognition Embedded SDKs.
MegaMatcher Embedded SDK now includes face, finger, iris and voice recognition technologies. Increased fingers recognition reliability, with 20% decrease in the false rejection rate (FRR) when set the same false acceptance rate (FAR). Enchantments for recognition of faces that are rotated out-of-plane. Added Futronic scanner support for Android OS. Merged face and fingerprint Android samples, added iris and voice modalities to this sample. 5
3 Fixed minor bugs in samples. February 28, 2012
Added support for armeabi-v7a native libraries. Added support for Futronic fingerprint scanners. Face sample image stretching issue fixed. Face sample thread synchronization issue fixed. January 25, 2012 Added parameter PARAMETER_FACE_ROLL_ANGLE_BASE. Added wireless network connection check to samples. Added support for front facing camera on devices with OS 2.3 or higher to faces sample. Added verification scenario to faces sample. Added landscape and portrait device orientations to faces sample.
4.1 SDK Components
Embedded Face Extractor
4 Overview
4.1 SDK Components

Functionality of MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android is split into components (each component providing some functionality). This section describes available components.
4.1.1 Embedded Fingerprint Extractor

Embedded Fingerprint Extractor creates fingerprint templates from fingerprint images. Image quality control can be applied to accept only good quality fingerprint images. The Fingerprint Extractor can generalize a fingerprint template from several images that contain the same fingerprint to improve the template's quality. Features extraction can be used with fingerprint images from fingerprint scanners or images from files. Using Feature extraction: NfeExtractor.extract method. Template generalization: NFExtractor.generalize method.
4.1.2 Embedded Fingerprint Matcher

Embedded Fingerprint Matcher performs fingerprint template matching in 1-to-1 (verification) and 1-to-many (identification) modes. Also the Fingerprint Matcher for MegaMatcher component includes fused matching algorithm that allows to increase template matching reliability by: matching templates that contain 2 or more fingerprint records; matching templates that contain fingerprint, face and/or iris records;
4.1.3 Embedded Face Extractor

Embedded Face Extractor creates face templates from face images (captured by camera). Image quality control can be applied to accept only good quality face images. The Extractor can generalize a face template from several images that include the same face to improve the template's quality. Live face detection can be used for determining whether a face in a video stream belongs to a real human or is a photo.
4.2 Supported Biometric Standards
Features extraction can be used with face images from cameras or images from files. Camera management software allows to perform simultaneous capture from multiple cameras. Using Feature extraction from single image: NLExtractor.extract method Feature extraction from image sequence: NLExtractor.extractStart method Template generalization: NLExtractor.generalize method
4.1.4 Embedded Face Matcher

Embedded Face Matcher performs facial template matching in 1-to-1 (verification) and 1-to-many (identification) modes. Also the Face Matcher component includes fused matching algorithm that allows to increase template matching reliability by matching templates that contain fingerprint, face and/or iris records.
4.1.5 Embedded Voice Extractor

Voice Extractor creates voice templates from sound stream. Voice quality control can be applied to accept only good quality sound stream. The Extractor can generalize a voice template from several sound streams that include the same speaker to improve the quality of template. Using Feature extraction from sound stream: NSExtractor.extractStart method
4.1.6 Embedded Voice Matcher

The Voice Matcher performs voice template matching in 1-to-1 (verification) and 1-to-many (identification) modes.

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android supports the following biometrical standards and formats: 1. Biometric Data Interchange standards (Bdif) FCRecord - supports Face Recognition Format for Data Interchange (ANSI INCITS 385-2004) and Biometric data interchange format - Part 5: Face image data (ISO/IEC 19794-5:2005). FIRecord - Biometric data interchange formats - Part 4: Finger image data (ISO/IEC 19794-4:2005) and Finger Image-Based Data Interchange Format (ANSI/INCITS 381-2004). FMCard - Biometric data interchange formats - Part 2: Finger minutiae data (ISO/IEC 19794-2:2005). IIRecord - Biometric data interchange formats - Part 6: Iris image data (ISO/IEC 19794-6:2005) and Iris Image Interchange Format (ANSI/INCITS 379-2004). 2. Common Biometric Exchange Formats Framework (Cbeff)* CbeffBdbFormatIdentifiers 8
4.2 Supported Biometric Standards CbeffBiometricOrganizations
Face BSS
* - Cbeff standard is not implemented yet and provides only constants from Cbeff registry. 3. Data Format for the Interchange of Fingerprint, Facial, & Other Biometric Information Part 1 (ANSI/NIST-ITL 1-2007)
4.2.1 Fingerprint BSS

The Fingerprint BSS component allows to integrate support for fingerprint template and image format standards and additional image formats with new or existing biometric systems based on VeriFinger SDK. These biometric standards are supported: ISO/IEC 19794-2:2005 (Fingerprint Minutiae Data) ISO/IEC 19794-4:2005 (Finger Image Data) ANSI/INCITS 378-2004 (Finger Minutiae Format for Data Interchange) ANSI/INCITS 381-2004 (Finger Image-Based Data Interchange Format) ANSI/NIST-CSL 1-1993 (Data Format for the Interchange of Fingerprint, Facial, & SMT Information) ANSI/NIST-ITL 1a-1997 (Data Format for the Interchange of Fingerprint, Facial, & SMT Information) ANSI/NIST-ITL 1-2000 (Data Format for the Interchange of Fingerprint, Facial, & SMT Information) ANSI/NIST-ITL 1-2007 (Data Format for the Interchange of Fingerprint, Facial, & Other Biometric Information) ANSI/NIST-ITL 1a-2009 (Data Format for the Interchange of Fingerprint, Facial, & Other Biometric Information) The Fingerprint BSS component allows conversion between Neurotechnology proprietary fingerprint templates, ISO/IEC 19794-2:2005, ANSI/INCITS 378-2004 and ANSI/NIST-ITL templates. The Fingerprint BSS component also includes: Fingerprint pattern classification module Additional image formats and fingerprint image quality algorithm Fingerprint pattern classification module allows to determine a fingerprint pattern class is included with Fingerprint BSS module. The classification is usually used in forensics, but also it can be used to increase fingerprint matching speed. The defined classes are: Left Slant Loop; Right Slant Loop; Tented Arch; Whorl; Scar; "Unknown" for the nondetermined classes. Image enhancements are: JPEG 2000 image format support module with 1000 dpi Fingerprint Profile; NIST IHead image format support module; module with NIST Fingerprint Image Quality (NFIQ) algorithm, a standard method to determine fingerprint image quality.
Iris BSS
4.2.2 Face BSS

The Face BSS (Biometric Standards Support) component allows to integrate support for facial image format standards and additional image formats with new or existing biometric systems based on VeriLook SDK or MegaMatcher SDK. These biometric standards are supported: BioAPI 2.0 (ISO/IEC 19784-1:2006) (Framework and Biometric Service Provider for Face Identification Engine), see: BioAPI section. ISO/IEC 19794-5:2005 (Face Image Data) ANSI/INCITS 385-2004 (Face Recognition Format for Data Interchange) Face BSS component also allows to integrate JPEG 2000 with Lossy and Lossless Face Profiles support into applications based on VeriLook SDK or MegaMatcher SDK. Neurotechnology Token Face Image (NTFI) module Neurotechnology Token Face Image (NTFI) module is included in the component. The NTFI module is intended to provide token* face images compatible with the Face Image Format as in ISO/IEC 19794 standard. This face image format enables range of applications on variety of devices, including devices that have limited resources required for data storage, and improves recognition accuracy by specifying data format, scene constraints (lighting, pose), photographic properties (positioning, camera focus) and digital image attributes (image resolution, image size). The NTFI module has the following features: Token face image creation from an image containing human face using eye coordinates which may be either hand marked or detected automatically using Neurotechnology VeriLook face detection algorithm. Face is detected and eye coordinates are acquired using state-of-the-art Neurotechnology face detection and recognition algorithm. Geometrical normalization of face image according to proportions and photographic properties in ISO/IEC 19794 standard. Intelligent image padding algorithm for cut of parts of token face image as in ISO/IEC 19794 standard. Evaluation of the created token face image for the following quality criteria suggested in ISO/IEC 19794 standard: Background uniformity the background in the token face image should be uniform, not cluttered. Sharpness the token face image should not be blurred. Too light or too dark images the token face image should not be too dark or too light. Exposure range of an image the token face image should have a reasonable exposure range to represent as much details of the subject in the image as possible. Evaluation of the token face image quality based on suggestions of ISO/IEC 19794 standard (using the quality criteria above).
*
Token in this context is used as "symbolic image, good enough image for machine recognition". Token Image as in ISO/IEC19794-5: "A Face Image Type that specifies frontal images with a specific geometric size and eye positioning based on the width and height of the image. This image type is suitable for minimizing the storage requirements for computer face recognition tasks such as verification while still offering vendor independence and human verification (versus human examination which requires more detail) capabilities."
4.2.3 Iris BSS

The Iris BSS (Biometric Standards Support) component allows to integrate support for iris image format standards and additional image formats with new or existing biometric systems based on VeriEye ( see page 45) SDK or MegaMatcher 10
4.4 Supported Devices SDK. These biometric standards are supported:
Fingerprint Scanners
ISO/IEC 19794-6:2005 (Iris Image Data) ANSI/INCITS 379-2004 (Iris Image Interchange Format) Iris BSS component also allows to integrate JPEG 2000 image format support into applications based on VeriEye ( page 45) SDK or MegaMatcher SDK. see
4.3 Required Libraries

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android use the following main libraries: Java package com.neurotec.biometrics ( see page 60) see page 214) Java archive (JAR) neurotec-biometrics-android.jar neurotec-biometrics-standards-android.jar neurotec-biometrics-tools-android.jar neurotec-core-android.jar
com.neurotec.biometrics.standards ( com.neurotec.biometrics.tools (
see page 556)
com.neurotec.event com.neurotec.geometry.jna com.neurotec.graphics com.neurotec.io com.neurotec.jna ( see page 659) com.neurotec.lang ( see page 663) com.neurotec.net com.neurotec.plugins ( see page 742) com.neurotec.util com.neurotec.devices ( see page 559) com.neurotec.devices.event com.neurotec.licensing ( com.neurotec.media ( see page 706)
neurotec-devices-android.jar neurotec-licensing-android.jar neurotec-media-android.jar see page 50) to
see page 716)
Java archives (JARs) are saved in Bin\Android folder. Read more about how to include JAR libraries ( your project.
4.4 Supported Devices
4.4.1 Fingerprint Scanners

The following fingerprint scanners are supported under Android:
11
4.4 Supported Devices
Fingerprint Scanners
Manufacturer Toplink Pacific
Model BlueFIN bluetooth fingerprint reader1
AutenTec (Upek) AutenTec (Upek) Eikon AutenTec (Upek) Eikon To Go AutenTec (Upek) Eikon Solo AutenTec (Upek) EikonTouch 300 AutenTec (Upek) EikonTouch 500 AutenTec (Upek) EikonTouch TCRU1C AutenTec (Upek) EikonTouch TCRU2C Futronic Futronic FS50 Futronic FS80 Futronic FS82 Futronic FS88 Futronic FS90
Notes USB fingerprint devices require root access to Android subsystem (set USB permissions for enabling application to use fingerprint scanner). 1 - When using BlueFIN scanner it is recommended to press capture button after a beep is heard. In this case fingerprint capture takes less time.
12
5.1 System Setup Instructions
5 Using
5.1 System Setup Instructions

Before start development using Android SDK and MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android you should prepare your computer. You might need to install the JDK, if you don't have it already. Also Android SDK v9 (Android 2.3 platform) or greater should be installed (read more information on how to install Android SDK). For developing Android applications it is recommended to use Eclipse IDE for Java Developers (Eclipse Indigo or greater). Maven 3.0.3 or greater is used to deploy and release Android applications (application package files - APK). Environment variables These environment variables should be added to the system: ANDROID_HOME - should be set to point Android SDK home directory (e.g C:\Program Files\Android\android-sdk) JAVA_HOME - should be set to point JDK home directory (e.g C:\Program Files\Java\jdk1.6.0_20) M2_HOME - should be set to point Maven home directory (e.g C:\Program Files\Maven_3.0) Add %ANDROID_HOME%/tools;%ANDROID_HOME%/platform-tools;%JAVA_HOME%/bin;%M2_HOME%/bin to PATH environment variable where bin is home directory. Compiling applications Samples and other source code is compiled using command line terminal. Use these commands to compile application for Android platform: CD %MegaMatcher Embedded Android SDK root directory% Change directory to where sample is saved: CD Samples Build sample application: mvn clean install Android application deployment Using Maven: Connect device to computer using USB cable. Install device drivers is applicable. Change directory (where built files are saved): E.g. Multi biometric sample directory: CD DISTRIBUTION_LOCATION/Samples/Biometrics/Android/multibiometric-sample Deploy your .apk file to the connected device: mvn android:deploy Using Android SDK platform tools: Connect device to computer using USB cable. 13
5.2 Android Activation Change directory to Android installation:
CD ANDROID_INSTALL_DIR/android-sdk/platform-tools Use Android Debug Bridge (Adb) to copy application from your development environment and install it on a device. You should specify path to compiled .apk file (in this example path to Face sample is provided): adb install DISTRIBUTION_LOCATION/Bin/Android/multibiometric-sample.apk Manually: Manually copy .apk file (e.g. multibiometric-sample.apk) to device internal storage. Locate and install this file using Android OS tools.
5.2 Android Activation

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android licenses should be activated before using product. Activation methods varies depending on what license you have. This section demonstrates how to activate license using Licensing manager for Android. 1. Install licensing-manager.apk from Bin\Android folder. 2. Start the licensing manager. Licensing manager application allows to manually configure, start, stop, restart licensing service and generate report. Trial version of SDK allows choosing Direct and From PC modes, while Non-Trial version of SDK allows From PC and From file modes. Licence activation/deactivation is available only in Non-trial version of SDK. 3a. Standard products activation. When you first start the Neurotechnology standard licensing application you will see this window:
14
By clicking Configure you will be able to choose the desired licensing mode: From PC or From File, and set licensing server (PC) address and port.
15
After choosing the mode you will be able to run the licensing service and choose the licenses you want to activate/deactivate in the Activation tab.
16
The default place for storing serial numbers and licenses is sdcard/Neurotechnology/Licenses directory. Serial numbers and licenses must be copied to this directory, otherwise they will not be available. Once license is activated, it will be stored near corresponding serial number. Note: User can define other path to license file (source code changes are required). Also you should note that when using Standard licenses temporary internet connection may be required. After you complete these steps, press Start to start the licensing service. Should the licensing be successful, you should see the following window:
17
Should you require a licensing report, press Generate Report. A text file will be generated in the Reports sub-folder of the Neurotechnology folder.
3b. Trial products activation. When you first start the Neurotechnology trial licensing application you will see this window:
18
If you are using Trial version of SDK sample application will try to activate licenses automatically (using Direct activation mode). When Trial version of MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android is used it is possible to select two license retrieval modes: Direct and From PC. Direct mode is used to obtain licenses directly from internet (this is the default option). From PC mode is used when license is obtained from computer in local network. You can change Licensing mode to From PC by launching Licensing preferences window from sample application:
19
In this window you should select licensing mode. If From PC mode is used you should set licensing server (PC) address and port. From PC mode is suitable for these situations when mobile device can not connect to the internet (only local network). Note, that the PC will still require internet connection. After you complete these steps, press Start to start the licensing service. Should the activation be successful, you will see the following window:
20
5.3 Matching Threshold and FAR/FRR
Note: Usage of Trial SDK is limited up-to 30 days. Trial SDK requires constant internet connection. Also PC should be connected to the Internet when the mobile device obtains a license from it.
4. License modes Direct mode retrieves license directly from Neurotechnology server. From File mode licenses come in two variants: 1. Internet Licenses - require periodic internet connection (e.g. once per week) they use to confirm they are still active. 2. Non-internet Licenses - require internet connection only at activation. They are also known as hardware licenses - each license works on one device only. From PC mode retrieves license from the Neurotechnology Licensing Service on the computer it is connected to.

Biometric features matching algorithm provides similarity score as a result. The higher is score, the higher is probability that 21
features collections are obtained from the same person. The strictness of matching algorithms is controlled by NMP_MATCHING_THRESHOLD (NMatcher.MatchingThreshold) parameter of NMatcher. The higher the threshold value, the more similar feature collections will have to be to yield positive result during matching. Matching threshold - the minimum score that verification and identification functions accept to assume that the compared finger fingerprints, face or iris belong to the same person. Matching threshold is linked to false acceptance rate (FAR, different subjects erroneously accepted as of the same) of matching algorithm. The higher is threshold, the lower is FAR and higher FRR (false rejection rate, same subjects erroneously accepted as different) and vice a versa. Matching threshold for NMatcher should be determined from this table (note: thresholds for MINEX mode are provided at the end): FAR (false acceptance rate) 100 % 10 % 1% 0.1 % 0.01 % 0.001 % 0.0001 % 0.00001 % 0.000001 % or using this formula: Threshold = -12 * log10(FAR); where FAR is NOT percentage value (e.g. 0.1% FAR is 0.001) Matching threshold should be selected according to desired FAR (False Acceptance Rate). FAR is calculated for single match (1:1) and during identification (1:N) false acceptance accumulates. Identification false acceptance probability can be calculated using this formula: (1-(1-FAR/100)^N)*100, where N - DB size For example: If FAR=0.001% then probability that false acceptance situation will occur during 1:N identification (where N=10 000) is 1-(1-0.00001)^10000=9.52%. If FAR=0.0001% then probability that false acceptance situation will occur during 1:N identification (where N=10 000) is 1-(1-0.000001)^10000=1.00%. Matching threshold/FAR should be selected according to the system's development requirements and taking into account mentioned identification false acceptance accumulation. Matching threshold for NMatcher when MINEX mode is used: FAR (false acceptance rate) 10 % 1% 0.1 % 0.01 % 0.001 % 0.0001 % MINEX matching threshold (score) 100 150 200 250 300 350 Matching threshold (score) 0 12 24 36 48 60 72 84 96
22
5.4 Quick Start
0.00001 % Notes
400
It is recommended to use NMatcher instead of using separate matchers like NlsMatcher, NLMatcher, NfsMatcher, NFMatcher, NesMatcher.
5.4 Quick Start

Quick Start 1. Copy licensing-manager.apk and multibiometric-sample.apk to the SD card. They can be found in the /Bin/Android subfolder of the MegaMatcher Embedded SDK folder. 2. Create folder(s) /sdcard/mnt/NeurotechnologyLicenses 3. Copy the serial number files to the folder from step 2. 4. Install licensing-manager.apk and multibiometric-sample.apk Installation instructions. ( see page 13)
5. Run Licensing manager activity. License activation instructions. ( see page 14)
6. In Activation tab select all the serial numbers and hit Activate. 7. In Services tab check if the service is running, if not - start it. 8. Run sample activity. Sample overview. ( see page 26)
23
6 Tutorials
This section contains a list of tutorials included in the MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android. Each tutorial is usually a small program which demonstrate specific functionality of Neurotechnology libraries in isolation. Developer can also refer to Samples ( see page 26) chapter for more elaborate example applications. Biometrics Tutorial CreateMultiFaceTemplate CreateMultiFingerTemplate CreateTokenFaceImage CreateTwoIrisTemplate DetectFacialFeatures EnrollFaceFromCamera EnrollFaceFromImage EnrollFaceFromStream EnrollFingerFromImage EnrollFingerFromScanner EnrollIrisFromImage EnrollIrisFromScanner EnrollPalmFromImage EnrollVoiceFromAudioFile Description Creates NTemplate that contains multiple faces templates (multiple NLRecord). Creates NTemplate that contains multiple fingerprint NFRecord templates. Demonstrates how to use Neurotechnology token face images library (see API Reference for Ntfi module or class). Demonstrates how to make packed NTemplate from images. Demonstrates how to detect facial features from images. Demonstrates face feature extraction from camera. Demonstrates how to enroll to database a single face image. Demonstrates how to enroll to database face from stream (image sequence). Demonstrates how to extract features from fingerprint image and enroll to database. Demonstrates how to extract fingerprint features as NFRecord from scanner and enroll to database. Demonstrates how to enroll to database a single iris image. Demonstrates enrollment from iris scanner. Demonstrates palmprint feature extraction from image. Demonstrates voices feature extraction from audio file.
EnrollVoiceFromMicrophone Demonstrates voices feature extraction from microphone. GeneralizeFinger GeneralizePalm Identify IdentifyFace IdentifyFinger IdentifyIris IdentifyPalm MatchMultipleFaces SegmentIris ShowTemplateContent Verify VerifyFace VerifyFinger VerifyIris VerifyPalm Generalizes count features collections to single features collection. Demonstrates palmprint generalization from templates or images. Demonstrates how to use 1:N matching. Demonstrates facial identification (matching of template extracted from image to gallery of serialized templates). Demonstrates how to use 1:N fingerprints matching. Demonstrates how identify subject's iris against all database. Demonstrates palmprint identification. Demonstrates how to convert face image to grayscale and match multiple face templates. Demonstrates how to use iris features segmenter. Demonstrates how to retrieve information about a template Demonstrates how to use 1:1 matching. Demonstrates how to match (verify) two faces templates. Demonstrates how to use 1:1 fingerprints matching. Demonstrates how to match (verify) two irises templates. Demonstrates palmprint verification.
24
Biometric Standards These tutorials are used to convert different biometric standards. Tutorial ANTemplateType10FromNImage ANTemplateType13FromNImage ANTemplateType14FromNImage ANTemplateType15FromNImage ANTemplateType16FromNImage ANTemplateType17FromNImage ANTemplateType3FromNImage ANTemplateType4FromNImage ANTemplateType5FromNImage ANTemplateType6FromNImage ANTemplateType8FromNImage ANTemplateType9FromNImage ANTemplateToNTemplate CreateMinexCompliantTemplate FCRecordFromNImage FCRecordToNTemplate FIRecordFromNImage FIRecordToNTemplate FMRecordToNTemplate IIRecordFromNImage IIRecordToNTemplate MatchMinexCompliantTemplates NTemplateToANTemplate NTemplateToFMRecord Biometric Tools Tutorial ClassifyFinger EvaluateFingerQuality Description Demonstrates fingerprint classification. Demonstrates fingerprint image quality evaluation. Description Demonstrates creation of ANTemplate with type 10 record in it. Demonstrates creation of ANTemplate with type 13 record in it. Demonstrates creation of ANTemplate with type 14 record in it. Demonstrates creation of ANTemplate with type 15 record in it. Demonstrates creation of ANTemplate with type 16 record in it. Demonstrates creation of ANTemplate with type 17 record in it. Demonstrates creation of ANTemplate with type 3 record in it. Demonstrates creation of ANTemplate with type 4 record in it. Demonstrates creation of ANTemplate with type 5 record in it. Demonstrates creation of ANTemplate with type 6 record in it. Demonstrates creation of ANTemplate with type 8 record in it. Demonstrates creation of ANTemplate with type 9 record in it. Demonstrates how to convert ANTemplate to NTemplate. Creates Minex compliant template. Demonstrates creation of FCRecord from image. Demonstrates how to convert face record FCRecord to NTemplate. Demonstrates how to create FIRecord from fingerprint image. Creates FIRecord from NTemplate. Demonstrates how to convert FMRecord to NTemplate. Demonstrates how to create IIRecord from iris image. Demonstrates how to convert iris record IIRecord to NTemplate. Demonstrates how to match Minex compliant templates. Demonstrates how to convert NTemplate to ANTemplate. Demonstrates how to convert NTemplate to FMRecord.
All tutorials are written for C programming language. Source files are located within Tutorials\ folder.
25
7 Samples
Samples are used to demonstrate the main functionality of MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android. Samples are developed using Java programming language. Source code of all sample applications is included into \Samples folder. You are allowed to use, change or adapt this source code for your applications. Also SDK contains .apk file which is a container for all Android samples. These samples from multibiometric-sample.apk (which is saved in Bin\Android folder) are installed: VeriLook Sample ( see page 27) - demonstrates how to use Neurotechnology VeriLook faces recognition algorithm on mobile devices running Android OS . VeriFinger Sample ( see page 32) - demonstrates how to use Neurotechnology VeriFinger fingers recognition algorithm on mobile devices running Android OS. Note: Fingerprint scanner ( see page 11) may be required to run this sample. VeriSpeak Sample ( see page 40) - demonstrates how to use Neurotechnology VeriSpeak voices recognition algorithm on mobile devices running Android OS. VeriEye Sample ( see page 45) - demonstrates how to use Neurotechnology VeriEye ( algorithm on mobile devices running Android OS. see page 45) irises recognition
Note: you should obtain license before using sample applications. Use licensing-manager.apk file from Bin\Android folder on your device to activate. Licensing service configuration and license activation/deactivation is integrated into multibiometric-sample as well (Preferences/Licensing). All samples allows selecting input from images, NTemplates, Biometric standard templates. Notes Every application must have an AndroidManifest.xml file (with precisely that name) in its root directory. The manifest presents essential information about the application to the Android system, information the system must have before it can run any of the application's code. Among other things, the manifest file for application developed with Neurotechnology libraries should include these permissions: <uses-permission android:name="android.permission.CAMERA"/> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.READ_LOGS" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.BLUETOOTH" /> <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" /> <uses-permission android:name="android.permission.WRITE_OWNER_DATA" /> <uses-permission android:name="android.permission.READ_OWNER_DATA" /> <uses-permission android:name="android.permission.RECORD_AUDIO"/> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/> <uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/> <uses-permission android:name="android.permission.READ_PHONE_STATE"/> <uses-permission android:name="android.permission.WRITE_SETTINGS"/> <uses-permission android:name="android.permission.WAKE_LOCK"/> AndroidManifest.xml Read more about http://developer.android.com/guide/topics/manifest/manifest-intro.html and permissions:
26
7.1 VeriLook See Also
System Setup Instructions ( see page 13) and Java Samples Compilation ( compile and run Java sample applications.
see page 50) for more information how to
7.1 VeriLook
MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android incorporates Neurotechnology face recognition algorithm. Using this demo application face images can be enrolled from live images captured by a camera and matching task performed. Note: before you start using VeriLook sample for Android (multibiometric-sample.apk) you need to activate it ( page 14). Starting and using application When VeriLook sample application was started you should see live view from camera. see
When a subject appears near the camera, the green rectangle on his face is drawn (subject was detected).
27
7.1 VeriLook
Tap screen to enroll new person. Faces sample performs as a common Android camera application. After user taps the screen the camera will autofocus. The extraction proceeds after user presses action button (camera icon).
In the next window extraction result is shown. If you want to enroll this subject (template) to internal database, press "Plus" button on the right. When you enroll new template it is required to enter new name:
28
7.1 VeriLook
If you press "Search" button you will be able to perform template identification. "Question" button performs verification.
29
7.1 VeriLook
Note: Currently VeriLook sample application doesn't support vertical camera orientation. Application preferences VeriLook sample for Android settings window can be accessed by pressing Menu button and choosing Preferences on the left corner in the main window. Preferences window is used to configure camera, extraction, enrollment, matching and licensing parameters.
30
7.1 VeriLook
Camera Camera resolution - allows to select camera resolution (only values supported by the device are enumerated). Use max camera resolution - allows to use better picture quality for extraction (maximum camera resolution is used). Camera flash mode - allows to turn on or off camera flash (if mobile device has). If On demand was selected flash will be used when necessary. Change camera - allows to select back or front camera to use. Set default values - allows to set all settings to its default values. Extraction Face quality threshold ( see page 149) - controls how strict rules are applied when determining the quality of a found face for extraction. If face quality score does not outscore. Face confidence threshold ( see page 149) - value which controls the requirements for face detection. The greater this value is the more strict rules are applied when looking for faces in an image. Detect multiple faces ( see page 149) - if checked, multiple faces in an image will be detected. Note that to detect multiple faces requires more device resources. Favor largest face ( see page 149) - if checked, the largest face found in an image will be used for facial feature extraction instead of the one with the highest face confidence threshold score. Liveness threshold ( see page 150) - value which controls the requirements for face liveness. The greater this value is the more strict rules are applied when deciding if the face is live. MinIod ( see page 151) - minimum distance between eyes. 31
7.2 VeriFinger MaxIod (
see page 150) - maximum distance between eyes.
Max yaw angle deviation ( see page 150) - this value is used to define the maximum value in degrees of pose yaw angle in a face image which can be enrolled or identified. Max roll angle deviation ( see page 150) - this value is used to define the maximum value in degrees of tilted face image which can be enrolled or identified. Enrollment template size ( see page 151) - controls face template size. If Small template was selected extraction takes less time but matching quality is not so good compared to Large template. When Large template is selected, matching results are the best, but extraction takes more time. Identification template size ( see page 151) - controls face template size for identification. If Small template was selected identification takes less time but quality is not so good compared to Large template. Detect gender ( see page 149) - if checked, application can identify gender of the captured face.
Gender confidence threshold ( see page 150) - value which controls the requirements for gender detection. The greater this value is the more strict rules are applied when identifying gender in an image. Enrollment Check for duplicates - allows to check duplicates when enrolling new subjects. Matching Speed ( see page 178) - matching speed. Can be chosen Low or High speed.
Verify threshold - threshold that separates identical from different templates. Matching threshold is linked to false acceptance rate (FAR, different templates erroneously accepted as of the same) of matching algorithm. The higher is threshold, the lower is FAR and higher FRR (false rejection rate, same templates erroneously accepted as different) and vice a versa. See: Matching Threshold and Score ( see page 21). Licensing Changes licenses obtain preferences. Read more about Licenses activation for Android ( DB View DB view shows all enrolled templates and allows to edited it. Notes Source code files of this sample application is saved in Samples\Biometrics\Android\face-sample directory of SDK. Compiled sample (face-sample.apk) is saved in Bin\Android directory of sDK. see page 14).
7.2 VeriFinger
VeriFinger fingerprint sample for Android demonstrates how to use MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android for working with subject's fingerprint images retrieved from a file or a fingerprint scanner. Note: before you start using VeriFinger sample for Android (multibiometric-sample.apk) you need to activate it ( page 14). Starting and using application Verifinger sample for Android is started from applications by selecting "VeriFinger". When application starts and license is successfully obtained you will see this window: see
32
7.2 VeriFinger
Using this sample application you can do the following: Enroll user fingerprint. Fingerprint can be enrolled from image or using fingerprint scanner. Press Load button and select image source.
33
7.2 VeriFinger
These load options are available: Finger scanners - fingerprint is loaded from one of supported fingerprint scanner ( see page 11).
Images - fingerprint images is loaded from specified directory (by selecting Browse...) or from sample images directory. NFRecord, FIRecord, FMRecord - by selecting this option NFrecord, FIRecord or FMRecord template is loaded (from specified or samples directory). FIRecord and FMRecord require BSS license. After image was loaded it can be enrolled into internal database by selecting Enroll button and entering user ID:
34
7.2 VeriFinger
Verification. Using this option one fingerprint can be verified against other (1:1 matching).
35
7.2 VeriFinger
36
7.2 VeriFinger
Identification. Using this option fingerprint is identified against internal database. (1:N matching).
37
7.2 VeriFinger
Application preferences VeriFinger sample for Android settings window can be accessed by pressing Menu button and choosing Preferences on the left corner in the main window. Preferences window is used to configure extraction, enrollment, matching and licensing parameters.
38
7.2 VeriFinger
Extraction Enrollment template size ( Returned image ( see page 98) - can be set to either Small or Large.
see page 98) - can be set to either None, Binarized or Skeletonized.
Ridge counts ( see page 97) - can be set to either None, Four neighbors, Eight neighbors, Four neighbors with indexes or Eight neighbors with indexes. Use minimal minutia count - sets whether minimal minutia count is used. Minimal minutia count ( Use quality threshold ( Quality threshold ( see page 98) - minimum number of minutia used. Can be set between 0 and 180. see page 98) - sets whether quality threshold is used.
see page 98) - quality threshold. Can be set between 0 and 100.
Set default values - when activated, sets all application preferences to factory defaults. Enrollment Check for duplicates - when checked, attempts to identify newly-enrolled images and prevents enrollment of images of already enrolled fingerprints. Set default values - when activated, sets all application preferences to factory defaults. Matching Speed ( see page 179) - can be set to either Low or Medium. see page 179) - sets the maximal rotation (in degrees) of the fingerprint image. 39
Maximal rotation (
7.3 VeriSpeak Minimal matched finger count (
see page 179) - sets the minimal count of matched fingerprints.
Minimal matched finger count threshold ( see page 179) - threshold that separates identical from different templates. Matching threshold is linked to false acceptance rate (FAR, different templates erroneously accepted as of the same) of matching algorithm. The higher is threshold, the lower is FAR and higher FRR (false rejection rate, same templates erroneously accepted as different) and vice a versa. See: Matching Threshold and Score ( see page 21). Set default values - when activated, sets all application preferences to factory defaults. Licensing Changes licenses obtain preferences. Read more about Licenses activation for Android ( Notes Source code files of this sample application is saved in Samples\Biometrics\Android\finger-sample directory of SDK. Compiled sample (multibiometric-sample.apk) is saved in Bin\Android directory of sDK. see page 14).
7.3 VeriSpeak
VeriSpeak sample application for Android demonstrates how to use Neurotechnology's voice recognition technology on Android powered device. Using this application user can enroll voice template and perform identification or verification tasks. Note: before you start using VeriSpeak sample for Android (multibiometric-sample.apk) you need to activate it ( page 14). Starting and using application When VeriSpeak (voices) sample application was started you should see such window: see
40
7.3 VeriSpeak
Buttons below allow to choose operation: Enroll - performs voice template extraction. Press this button, record a phrase and press Stop button. After template was extracted you can save it in local database by entering user id (template id). If Repeat button is pressed and the same phrase is repeated, recognition quality can be improved.
41
7.3 VeriSpeak
42
7.3 VeriSpeak
Verify - performs 2 templates verification. When this button is pressed user should record a phrase and choose a template to verify with. If verification succeeded verification score is displayed. Identify - performs recorded voice template identification with templates stored in local database. Preferences VeriSpeak sample for Android settings window can be accessed by pressing Menu button and choosing Preferences on the left corner in the main window. Preferences window is used to configure extraction, matching and licensing parameters.
43
7.3 VeriSpeak
Extraction Max phrase duration ( Use speak detection ( see page 200) - controls maximum duration of extracted phrase. see page 200) - if set the end of voice activity is detected automatically.
Max pause duration ( see page 200) -controls the duration of pause used to detect end of voice activity. If no voice was detected, application stops voice template extraction after this period. Matching Matching threshold - threshold that separates identical from different templates. Matching threshold is linked to false acceptance rate (FAR, different templates erroneously accepted as of the same) of matching algorithm. The higher is threshold, the lower is FAR and higher FRR (false rejection rate, same templates erroneously accepted as different) and vice a versa. See: Matching Threshold and Score ( see page 21). Use unique phrases only ( see page 181) - if this parameter is used user during verification can say only his unique phrase(-s) (which was enrolled to database). If not used user can say any phrase. Licensing Changes licenses obtain preferences. Read more about Licenses activation for Android ( DB View DB view shows all enrolled templates and allows to edited it. Notes Source code files of this sample application is saved in Samples\Biometrics\Android\voice-sample directory of 44 see page 14).
7.4 VeriEye SDK.
Compiled sample (multibiometric-sample.apk) is saved in Bin\Android directory of sDK.
7.4 VeriEye
VeriEye sample application for Android demonstrates how MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android can be used to work with subject's iris scans retrieved from an image file or an iris scanner. Note: before you start using VeriEye sample for Android (multibiometric-sample.apk) you need to activate it ( Starting and using the application When VeriEye sample application starts you should see this window: see page 14).
The buttons below have the following functions: Load - allows the user to choose and loads an image or an image scan to the application.
45
7.4 VeriEye
When an image is loaded into application, you should be able to see it, with the iris marked with a selection circle.
Enroll - saves the loaded image into database under a user-specified id. This function requires an image to be loaded into the application.
46
7.4 VeriEye
Identify - Compares the loaded image with the records in the database and finds the closest match. The closest match is then displayed along with its score. (1:N matching).
Verify - compares the currently loaded image with a selected iris candidate (record) (1:1 matching).
47
7.4 VeriEye
If the chosen iris image matches the current image, the application displays a success message and matching score.
If the chosen iris image doesn't match the current image, the application displays a failure message and matching score.
48
7.4 VeriEye
Application preferences VeriEye sample for Android settings window can be accessed by pressing Menu button and choosing Preferences on the left corner in the main window. Preferences window is used to configure extraction, enrollment, matching and licensing parameters.
Extraction Template size ( Deinterlace ( see page 71) - can be set to either Normal or Compact.
see page 70) - enables or disables deinterlacing. see page 70) - the minimal radius of the inner border.
Inner boundary from ( Inner boundary to (
see page 70) - the maximal radius of the inner border. see page 71) - the minimal radius of the outer border.
Outer boundary from ( Outer boundary to (
see page 71) - the maximal radius of the outer border.
49
7.5 Java Samples Compilation Use flexible boundary model (
see page 71) - can be checked in order to use a flexible boundary model.
Set default values - when activated, sets all application preferences to factory defaults. Enrollment Check for duplicates - when checked, attempts to identify newly-enrolled images and prevents enrollment of images of already enrolled irises. Set default values - when activated, sets all application preferences to factory defaults. Matching Speed ( see page 179) - can be set to either Low or Medium. see page 180) - sets the maximal rotation (in degrees) of the iris image. see page 180) - sets the minimal count of matched irises.
Maximal rotation (
Minimal matched iris count (
Minimal matched iris threshold ( see page 180) - threshold that separates identical from different templates. Matching threshold is linked to false acceptance rate (FAR, different templates erroneously accepted as of the same) of matching algorithm. The higher is threshold, the lower is FAR and higher FRR (false rejection rate, same templates erroneously accepted as different) and vice a versa. See: Matching Threshold and Score ( see page 21). Set default values - when activated, sets all application preferences to factory defaults. Licensing Changes licenses obtain preferences. Read more about Licenses activation for Android ( Notes Source code files of this sample application is saved in Samples\Biometrics\Android\iris-sample directory of SDK. Compiled sample (multibiometric-sample.apk) is saved in Bin\Android directory of sDK. see page 14).
7.5 Java Samples Compilation

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android Java projects (sample programs) are built and managed using Eclipse and Apache Maven tool. Instructions for compiling Java samples using Maven: 1. Run Eclipse IDE and change Java version in your Eclipse from Runtime Environment to Development Kit. To do so, go Windows->Preferences->Java->Installed JREs.
50
There, select the JRE and click Edit.
Click Directory and select the directory containing the Java Development Kit.
51
Click Finish. (Note: Eclipse Indigo or later has Apache Maven integrated. If you are using Eclipse Indigo or later it is not required to perform steps 2-3). 2. Download (http://maven.apache.org/download.html) and integrate Apache Maven for Eclipse (http://maven.apache.org/eclipse-plugin.html). Java projects require Apache Maven version 3.0.3 or later. Downloaded Maven package contains README.txt file with installation instructions. 3. Integrate Apache Maven to Eclipse IDE. (http://eclipse.org/m2e/). 4. Make sure that your Maven version is 3.0.3 or higher. To do so, go Windows->Preferences->Maven->Installations.
52
If the Maven version displayed there is lower than 3.0.3, click Add and select the higher version.
5. Install the 5. Import the Java project (one of sample application provided with SDK). Select File->Import->Maven->Existing Maven 53
7.5 Java Samples Compilation projects. Press Next button.
6. In the next dialog window browse for Samples root folder in the SDK select it and press Next. E.g.:
7
7. In the last window just select Finish button.
54
8. In Eclipse find imported project in Package Explorer and right click on the "samples" project. Select Run As -> Maven Build... In the Main tab find Goals field and type "clean install".
(Note: Maven may throw a warning or an error if the file path is too long. It is advisable to keep the file path as short as possible.). 9. In the Package Explorer of the Eclipse right-click on each of the projects. In the pop-up menu choose Properties.
55
Select the "..\utils-android" item and click Remove. Then click Add.
7
Select the "utils-android" project and click OK.
56
9. To deploy and run a project right click on it and select Run As -> Maven Build... In the Main tab find Goals field and type "android:redeploy android:run".
57
8 API Reference
This section provides MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.1 and VeriSpeak Embedded 1.1 SDK for Android documentation (API Reference) for Java programming language. Libraries dependency Before loading libraries in your applications you should note that dependent libraries should be loaded in an appropriate order before using the main library functionality. The image below shows libraries dependency:
E.g., if you need to load NDevices library you should load libraries in such order: NCore, NMedia and NBiometrics. Also all libraries shown in the image requires to load NLicensing. Neurotechnology native libraries for Android are saved in Lib\Android_armeabi and Lib\Android_armeabi-v7a directories of SDK. The table below lists down all native libraries: Java package com.neurotec.biometrics ( see page 60) see page 214) Native library for Android libNBiometrics.so libNBiometricStandards,so libNBiometricTools.so libNCore.so
com.neurotec.biometrics.standards ( com.neurotec.biometrics.tools (
see page 556)
com.neurotec.event com.neurotec.graphics com.neurotec.io com.neurotec.jna ( see page 659) com.neurotec.lang ( see page 663) com.neurotec.devices ( see page 559) com.neurotec.devices.event com.neurotec.licensing ( com.neurotec.media ( see page 706)
libNDevices.so libNLicensing.so libNMedia.so libNMediaProc.so libNSmartCards.so libSentiSight.so
see page 716)
com.neurotec.media.processing com.neurotec.smartcards com.neurotec.sentisight Android specific parameters Some parameters have different default values for Android: NLExtractor ( see page 143):
TemplateSize = NLETemplateSize.SMALL 58
8.1 Java Reference
com.neurotec.biometrics Package
FaceDetectionScaleCount = During detection value is set to 2, during extraction the value provided by user is used. NFExtractor ( see page 91):
TemplateSize = NFETemplateSize.SMALL UseQuality = false Parameter 990 (SubRecordQuality) = false ReturnedImage = NFEReturnedImage.NONE NEExtractor ( see page 68):
UseFlexibleBoundaryModel = false NMatcher ( see page 170)
FacesMatchingSpeed = NMatchingSpeed.HIGH FingersMatchingSpeed = NMatchingSpeed.MEDIUM IrisesMatchingSpeed = NMatchingSpeed.MEDIUM Modules Name Java Reference ( see page 59) Description
8.1 Java Reference

Packages Name com.neurotec.biometrics ( see page 60) Description Classes under this package provides methods and properties for working with biometrical data.
com.neurotec.biometrics.standards ( 214) com.neurotec.biometrics.tools ( com.neurotec.devices ( com.neurotec.images ( com.neurotec.jna ( com.neurotec.lang (
see page This package contains classes of supported biometrical standards.
see page 556) This package contains classes for using biometric tools. Provides functionality for managing devices, like cameras, fingerprint or irises scanners. Contains classes that provide functionality for loading, saving and converting images in various formats. Contains classes that provide functionality for working with Java Native Access (JNA). Contains classes that provide infrastructure for Neurotechnology components. Provides functionality for getting, releasing licenses. Provides functionality for working with various type of media items: images, audio and video. Classes under this package provides plugins management framework for use in other Neurotechnology components. Classes under this package provides methods for working with plugin events.
see page 559) see page 586)
see page 659) see page 663) see page 706)
com.neurotec.licensing ( com.neurotec.media ( com.neurotec.plugins (
com.neurotec.plugins.event (
59
8.1 Java Reference
8.1.1 com.neurotec.biometrics Package

Classes under this package provides methods and properties for working with biometrical data. Module Java Reference ( Classes Name NBiometricAttributes ( 61) NBiometrics ( NEAttributes ( NBiometricTypes ( see page Description Represents the biometric attributes. Provides methods for retrieving NBiometrics Library information. Specifies the type of biometric data. Provides methods to retrieve iris attributes (metadata .which is not saved in iris template). Provides information about segmentation details. Provides functions for iris features extraction into Neurotechnology Iris Record (NERecord ( see page 75)). Provides functionality for packing, unpacking and editing Neurotechnology iris Records (NERecords). Provides functionality for packing, unpacking and editing Neurotechnology iris templates (NETemplates). Provides methods to retrieve fingerprint attributes (metadatawhich is not saved in fingerprint template). The bean contains information of core. The bean contains information of delta. The bean contains information of double core. Provides functionality for extracting Neurotechnology Finger Records (NFRecords) from fingerprint images using algorithm/ encapsulated in Neurotechnology Fingerprint Features Extractor (NFExtractor) object. Represents Neurotechnology Fingerprint or Palmprint Records (NFRecord ( see page 110)) matching details. Contains information of minutia. The bean contains information of minutia neighbor. Provides functionality for packing, unpacking and editing Neurotechnology Finger Records (NFRecords). Provides functionality for packing, unpacking and editing Neurotechnology Fingers Templates (NFTemplates). Provides methods to retrieve face attributes (metadata which is not saved in face template). Structure containing face detection results. Defines information of an eye pair. Contains information of a face location in an image. Contains information of a face rotation in an image as a deviation from frontal face in degrees. Provides functionality for extracting Neurotechnology Face Records (NLRecord ( see page 163)) from face images. Provides functionality to retrieve face templates feature points. 60 see page 59)
see page 63) see page 63) see page 65) see
NEESegmentationDetails ( page 67) NEExtractor ( see page 68)
NEMatchingDetails ( NERecord ( NETemplate ( NFAttributes ( NFCore ( NFDelta (
see page 75) Represents iris templates matching details.
see page 85) see page 87) see page 90) see page 91)
NFDoubleCore ( NFExtractor (
NFMatchingDetails ( 105) NFMinutia ( NFMinutiaNeighbor ( 110) NFRecord ( NFTemplate ( NLAttributes (
see page
see page 106) see page
see page 110) see page 130) see page 135) see page
NLEDetectionDetails ( 136) NLEEyes ( NLEFace (
see page 140) see page 141) see page 142) see page 143) see page 161)
NLERotation ( NLExtractor (
NLFeaturePoint (
8.1 Java Reference NLMatchingDetails ( 163) NLRecord ( NLTemplate ( NMatcher (
see page
Provides functionality to retrieve face templates matching details. Provides functionality for packing, unpacking and editing Neurotechnology Face Records (NLRecords). Provides functionality for packing, unpacking and editing Neurotechnology Faces Templates (NLTemplates). Provides functionality for comparing all Neurotechnology Templates (NTemplates, NFTemplates, NFRecords, NLTemplates, NLRecords, NETemplates, NERecords), encapsulated in Neurotechnology Matcher (NMatcher) object.
see page 170)
NMatchingDetails (
see page 191) Provides functionality for retrieving Neurotechnology templates matching details. see page Base class for NMatchingDetails ( see page 191).
NMatchingDetailsBase ( 196) NSAttributes ( NSExtractor (
see page 197) see page 198) see page
Provides methods to retrieve sound template attributes. Provides functions for speaker features extraction into Neurotechnology Speaker Record (NSRecord ( see page 203)). Provides functionality to retrieve speaker matching details. Provides functionality for packing, unpacking and editing Neurotechnology Speaker Records (NSRecords). Provides functionality for packing, unpacking and editing Neurotechnology Speaker Templates (NSTemplates). Provides functionality for packing, unpacking and editing Neurotechnology Templates (NTemplates).
NSMatchingDetails ( 203) NSRecord ( NSTemplate ( NTemplate (
8.1.1.1 Classes
8.1.1.1.1 NBiometricAttributes Class
Represents the biometric attributes. Java public class NBiometricAttributes extends NObject; File NBiometricAttributes.java NBiometricAttributes Methods Name getBiometricType ( getQuality ( getStatus ( setQuality ( setStatus ( see page 61) see page 62) see page 62) see page 62) see page 62) see page 62) Description Gets the biometric type enumeration for the current object. Gets quality of the current object. Gets the biometric status of the current object. Retrieves a function that retrieves NType object for the enclosing type. Sets quality of the current object. Sets the biometric status of the current object.
nativeTypeOf (
8.1.1.1.1.1 NBiometricAttributes Methods

8.1.1.1.1.1.1 NBiometricAttributes.getBiometricType Method
Gets the biometric type enumeration for the current object.
61
8.1 Java Reference Java
public final EnumSet<NBiometricType> getBiometricType(); Returns The biometric type enum.
8.1.1.1.1.1.2 NBiometricAttributes.getQuality Method

Gets quality of the current object. Java public final byte getQuality(); Returns Quality in bytes.
8.1.1.1.1.1.3 NBiometricAttributes.getStatus Method

Gets the biometric status of the current object. Java public final NBiometricStatus getStatus(); Returns NBiometricStatus object.
8.1.1.1.1.1.4 NBiometricAttributes.nativeTypeOf Method

Retrieves a function that retrieves NType object for the enclosing type. Java public static NType nativeTypeOf(); Returns The function that retrieves NType object for the enclosing type.
8.1.1.1.1.1.5 NBiometricAttributes.setQuality Method

Sets quality of the current object. Java public final void setQuality(byte value); Parameters Parameters byte value Description Quality in bytes.
8.1.1.1.1.1.6 NBiometricAttributes.setStatus Method

Sets the biometric status of the current object. Java public final void setStatus(NBiometricStatus value); Parameters Parameters NBiometricStatus value Description NBiometricStatus object.
62
8.1 Java Reference
8.1.1.1.2 NBiometrics Class

Provides methods for retrieving NBiometrics Library information. Java public final class NBiometrics; File NBiometrics.java NBiometrics Fields Name DLL_NAME ( see page 63) NATIVE_LIBRARY ( NBiometrics Methods Name nativeModuleOf ( see page 63) Description Retrieves a function that retrieves NModule object for the enclosing module. Description Name of DLL containing unmanaged part of this component. see page 63) The object incapsulating the native library.
8.1.1.1.2.1 NBiometrics Fields

8.1.1.1.2.1.1 NBiometrics.DLL_NAME Field
Name of DLL containing unmanaged part of this component. Java public static final String DLL_NAME = "NBiometrics";
8.1.1.1.2.1.2 NBiometrics.NATIVE_LIBRARY Field

The object incapsulating the native library. Java public static final NativeLibrary NATIVE_LIBRARY;
8.1.1.1.2.2 NBiometrics Methods

8.1.1.1.2.2.1 NBiometrics.nativeModuleOf Method
Retrieves a function that retrieves NModule object for the enclosing module. Java public static NModule nativeModuleOf(); Returns The function that retrieves NModule object for the enclosing module.
8.1.1.1.3 NBiometricTypes Class

Specifies the type of biometric data. Java public class NBiometricTypes; File NBiometricTypes.java
63
8.1 Java Reference NBiometricTypes Fields Name PHRASE_ID_UNKNOWN ( page 64) QUALITY_FAILED ( QUALITY_MAX ( QUALITY_MIN (
Description see Specified that phrase ID is unknown.
see page 64) Defines the failed quality value. Defines the maximum quality value. Defines the minimum quality value.
QUALITY_UNKNOWN ( 64) NBiometricTypes Methods Name isQualityValid (
see page Defines the unknown quality value.
Description see page 64) Checks whether the quality value is valid.
8.1.1.1.3.1 NBiometricTypes Fields

8.1.1.1.3.1.1 NBiometricTypes.PHRASE_ID_UNKNOWN Field
Specified that phrase ID is unknown. Java public static final byte PHRASE_ID_UNKNOWN = (byte) 0;
8.1.1.1.3.1.2 NBiometricTypes.QUALITY_FAILED Field

Defines the failed quality value. Java public static final byte QUALITY_FAILED = (byte) 255;
8.1.1.1.3.1.3 NBiometricTypes.QUALITY_MAX Field

Defines the maximum quality value. Java public static final byte QUALITY_MAX = (byte) 100;
8.1.1.1.3.1.4 NBiometricTypes.QUALITY_MIN Field

Defines the minimum quality value. Java public static final byte QUALITY_MIN = (byte) 0;
8.1.1.1.3.1.5 NBiometricTypes.QUALITY_UNKNOWN Field

Defines the unknown quality value. Java public static final byte QUALITY_UNKNOWN = (byte) 254;
8.1.1.1.3.2 NBiometricTypes Methods

8.1.1.1.3.2.1 NBiometricTypes.isQualityValid Method
Checks whether the quality value is valid. Java public static boolean isQualityValid(byte value);
64
8.1 Java Reference Parameters Parameters byte value Returns true if the value is valid; else false.
Description Quality value.
8.1.1.1.4 NEAttributes Class

Provides methods to retrieve iris attributes (metadata .which is not saved in iris template). Java public class NEAttributes extends NBiometricAttributes; File NEAttributes.java Methods NEAttributes Class Name NEAttributes ( see page 65) Description Creates new instance of NEAttributes.
NBiometricAttributes Methods Name getBiometricType ( getQuality ( getStatus ( setQuality ( setStatus ( NEAttributes Class Name getBoundingRect ( getImageIndex ( getPosition ( nativeTypeOf ( setImageIndex ( see page 65) see page 66) see page 66) see page 66) see page 66) Description Gets the bounding rectangle that completely encloses scanned iris. Gets iris image index. Gets iris position. Retrieves a function that retrieves NType object for the enclosing type. Sets the bounding rectangle that completely encloses scanned iris. Sets iris image index. see page 61) see page 62) see page 62) see page 62) see page 62) see page 62) Description Gets the biometric type enumeration for the current object. Gets quality of the current object. Gets the biometric status of the current object. Retrieves a function that retrieves NType object for the enclosing type. Sets quality of the current object. Sets the biometric status of the current object.
nativeTypeOf (
see page 66)
setBoundingRect (
8.1.1.1.4.1 NEAttributes.NEAttributes Constructor

Creates new instance of NEAttributes. Java public NEAttributes(NEPosition position);
8.1.1.1.4.2 NEAttributes Methods

8.1.1.1.4.2.1 NEAttributes.getBoundingRect Method
Gets the bounding rectangle that completely encloses scanned iris.
65
public final Rectangle getBoundingRect(); Returns Rectangle type value containing coordinates, width and height.
8.1.1.1.4.2.2 NEAttributes.getImageIndex Method

Gets iris image index. Java public final int getImageIndex(); Returns Iris image index.
8.1.1.1.4.2.3 NEAttributes.getPosition Method

Gets iris position. Java public final NEPosition getPosition(); Returns Iris position value.
8.1.1.1.4.2.4 NEAttributes.nativeTypeOf Method

8.1.1.1.4.2.5 NEAttributes.setBoundingRect Method

Sets the bounding rectangle that completely encloses scanned iris. Java public final void setBoundingRect(Rectangle value); Parameters Parameters Rectangle value Description Rectangle type value containing coordinates, width and height.
8.1.1.1.4.2.6 NEAttributes.setImageIndex Method

Sets iris image index. Java public final void setImageIndex(int value); Parameters Parameters int value Description Iris image index.
66
8.1 Java Reference
8.1.1.1.5 NEESegmentationDetails Class

Provides information about segmentation details. Java public final class NEESegmentationDetails implements Serializable; File NEESegmentationDetails.java Methods Name NEESegmentationDetails ( page 67) NEESegmentationDetails Fields Name BOUNDARY_POINT_COUNT ( see page 67) innerBoundaryAvailable ( page 67) outerBoundaryAvailable ( page 67) NEESegmentationDetails Methods Name getInnerBoundaryPoints ( page 68) getOuterBoundaryPoints ( page 68) see see Description Gets list of inner boundary points. Gets list of outer boundary points. see see Description Int value indicating the number of boundary point count. Boolean value indicating if the inner boundary is available. Boolean value indicating if the outer boundary is available. see Description Creates new instance of NEESegmentationDetails.
8.1.1.1.5.1 NEESegmentationDetails.NEESegmentationDetails Constructor

Creates new instance of NEESegmentationDetails. Java public NEESegmentationDetails();
8.1.1.1.5.2 NEESegmentationDetails Fields

8.1.1.1.5.2.1 NEESegmentationDetails.BOUNDARY_POINT_COUNT Field
Int value indicating the number of boundary point count. Java public static final int BOUNDARY_POINT_COUNT = 32;
8.1.1.1.5.2.2 NEESegmentationDetails.innerBoundaryAvailable Field

Boolean value indicating if the inner boundary is available. Java public boolean innerBoundaryAvailable;
8.1.1.1.5.2.3 NEESegmentationDetails.outerBoundaryAvailable Field

Boolean value indicating if the outer boundary is available.
67
public boolean outerBoundaryAvailable;
8.1.1.1.5.3 NEESegmentationDetails Methods

8.1.1.1.5.3.1 NEESegmentationDetails.getInnerBoundaryPoints Method
Gets list of inner boundary points. Java public Point getInnerBoundaryPoints(); Returns List of inner boundary points.
8.1.1.1.5.3.2 NEESegmentationDetails.getOuterBoundaryPoints Method

Gets list of outer boundary points. Java public Point getOuterBoundaryPoints(); Returns List of outer boundary points.
8.1.1.1.6 NEExtractor Class

Provides functions for iris features extraction into Neurotechnology Iris Record (NERecord ( Java public final class NEExtractor extends NObject; File NEExtractor.java Methods Name NEExtractor ( NEExtractor Classes Name ExtractResult ( NEExtractor Fields Name PARAMETER_DEINTERLACE ( see page 70) see Description Parameter showing if deinterlacing of iris images is enabled. Parameter indicating the minimum size of the inner iris boundary. Parameter indicating the maximum size of the inner iris boundary. Parameter controlling the minimum size of the outer iris boundary. see page 69) Description Iris record extraction result. see page 69) Description Initializes a new instance of NEExtractor. see page 75)).
PARAMETER_INNER_BOUNDARY_FROM ( page 70) PARAMETER_INNER_BOUNDARY_TO ( 70)
see page see
PARAMETER_OUTER_BOUNDARY_FROM ( page 71) PARAMETER_OUTER_BOUNDARY_TO ( 71)
see page Parameter controlling the maximum size of the outer iris boundary.
68
8.1 Java Reference
PARAMETER_TEMPLATE_SIZE (
see page 71)
Identifier specifying template size parameter. Parameter value can be one of the TemplateSize enumeration members.
PARAMETER_USE_FLEXIBLE_BOUNDARY_MODEL Identifier specifying whether a more flexible boundary ( see page 71) model should be used during iris boundary segmentation. NEExtractor Methods Name compress ( extract ( see page 71) Description Compresses the extracted template to a format suitable for storing the template. Fully automatically extracts iris features template from the given iris image. see Gets the minimum size of the inner iris boundary. Gets the maximum size of the inner iris boundary. Gets the minimum size of the outer iris boundary. Gets the maximum size of the outer iris boundary. Gets a template size. Shows if deinterlacing of iris images is enabled. Shows whether a more flexible boundary model is used during iris boundary segmentation. Retrieves a function that retrieves NType object for the enclosing type. Shows if deinterlacing of iris images is enabled. Sets the minimum size of the inner iris boundary. Sets the maximum size of the inner iris boundary. Sets the minimum size of the outer iris boundary. Sets the maximum size of the outer iris boundary. Sets a template size. Shows whether a more flexible boundary model is used during iris boundary segmentation.
see page 71)
getInnerBoundaryFrom ( page 72) getInnerBoundaryTo ( 72)
see page see
getOuterBoundaryFrom ( page 72) getOuterBoundaryTo ( 72) getTemplateSize ( isDeinterlace (
see page
see page 73)
see page 73)
isUseFlexibleBoundaryModel ( see page 73) nativeTypeOf ( setDeinterlace ( see page 73) see page 73) see
setInnerBoundaryFrom ( page 73) setInnerBoundaryTo ( 74)
see page see
setOuterBoundaryFrom ( page 74) setOuterBoundaryTo ( 74) setTemplateSize (
see page
see page 74)
setUseFlexibleBoundaryModel ( see page 74)
8.1.1.1.6.1 NEExtractor.NEExtractor Constructor

Initializes a new instance of NEExtractor. Java public NEExtractor();
8.1.1.1.6.2 NEExtractor Classes

8.1.1.1.6.2.1 NEExtractor.ExtractResult Class
Iris record extraction result. Java public static final class ExtractResult; File NEExtractor.java 69
8.1 Java Reference ExtractResult Methods Name getRecord ( see page 70) getSegmentationDetails ( page 70) getStatus ( see page 70)
Description Gets extracted iris record. see Gets NERecord ( Gets NERecord ( see page 75) segmentation details. see page 75) extraction status.
8.1.1.1.6.2.1.1 ExtractResult Methods 8.1.1.1.6.2.1.1.1 NEExtractor.ExtractResult.getRecord Method

Gets extracted iris record. Java public NERecord getRecord(); Returns NERecord ( see page 75) object.
8.1.1.1.6.2.1.1.2 NEExtractor.ExtractResult.getSegmentationDetails Method

Gets NERecord ( Java public NEESegmentationDetails getSegmentationDetails(); Returns NEESegmentationDetails ( see page 67) object. see page 75) segmentation details.
8.1.1.1.6.2.1.1.3 NEExtractor.ExtractResult.getStatus Method

Gets NERecord ( Java public NEEExtractionStatus getStatus(); Returns NEEExtractionStatus object which holds information about iris record extraction status. see page 75) extraction status.
8.1.1.1.6.3 NEExtractor Fields

8.1.1.1.6.3.1 NEExtractor.PARAMETER_DEINTERLACE Field
Parameter showing if deinterlacing of iris images is enabled. Java public static final int PARAMETER_DEINTERLACE = 10001;
8.1.1.1.6.3.2 NEExtractor.PARAMETER_INNER_BOUNDARY_FROM Field

Parameter indicating the minimum size of the inner iris boundary. Java public static final int PARAMETER_INNER_BOUNDARY_FROM = 10002;
8.1.1.1.6.3.3 NEExtractor.PARAMETER_INNER_BOUNDARY_TO Field

Parameter indicating the maximum size of the inner iris boundary.
70
public static final int PARAMETER_INNER_BOUNDARY_TO = 10003;
8.1.1.1.6.3.4 NEExtractor.PARAMETER_OUTER_BOUNDARY_FROM Field

Parameter controlling the minimum size of the outer iris boundary. Java public static final int PARAMETER_OUTER_BOUNDARY_FROM = 10004;
8.1.1.1.6.3.5 NEExtractor.PARAMETER_OUTER_BOUNDARY_TO Field

Parameter controlling the maximum size of the outer iris boundary. Java public static final int PARAMETER_OUTER_BOUNDARY_TO = 10005;
8.1.1.1.6.3.6 NEExtractor.PARAMETER_TEMPLATE_SIZE Field

Identifier specifying template size parameter. Parameter value can be one of the TemplateSize enumeration members. Java public static final int PARAMETER_TEMPLATE_SIZE = 10160;
8.1.1.1.6.3.7 NEExtractor.PARAMETER_USE_FLEXIBLE_BOUNDARY_MODEL Field

Identifier specifying whether a more flexible boundary model should be used during iris boundary segmentation. Java public static final int PARAMETER_USE_FLEXIBLE_BOUNDARY_MODEL = 10006;
8.1.1.1.6.4 NEExtractor Methods

8.1.1.1.6.4.1 NEExtractor.compress Method
Compresses the extracted template to a format suitable for storing the template. Java public static NERecord compress(NERecord srcRecord, NEETemplateSize dstTemplateSize); Parameters Parameters template compressedTemplateSize Returns Compressed iris record template. Description Iris record template to be compressed. Compressed template size.
8.1.1.1.6.4.2 extract Method 8.1.1.1.6.4.2.1 NEExtractor.extract Method (NGrayscaleImage, NEEImageKind, NEPosition, boolean)
Fully automatically extracts iris features template from the given iris image. Java public ExtractResult extract(NGrayscaleImage image, NEEImageKind imageKind, NEPosition position, boolean retrieveSegmentationDetails); Parameters Parameters NGrayscaleImage image Description Source iris image to extract features. 71
8.1 Java Reference NEEImageKind imageKind NEPosition position boolean retrieveSegmentationDetails Returns
The kind of the source iris image. Eye position value (right, left or unknown eye). if set to
NEExtractorResult object which contains extracted features, segmentation details and extraction status.
8.1.1.1.6.4.2.2 NEExtractor.extract Method (NGrayscaleImage, NEPosition, boolean)

Fully automatically extracts iris features template from the given iris image. Java public ExtractResult extract(NGrayscaleImage image, NEPosition position, boolean retrieveSegmentationDetails); Parameters Parameters NGrayscaleImage image NEPosition position boolean retrieveSegmentationDetails Returns NEExtractorResult object which contains extracted features, segmentation details and extraction status. Description Source iris image to extract features. Eye position value (right, left or unknown eye). if set to
8.1.1.1.6.4.3 NEExtractor.getInnerBoundaryFrom Method

Gets the minimum size of the inner iris boundary. Java public int getInnerBoundaryFrom(); Returns The minimum size of the inner iris boundary.
8.1.1.1.6.4.4 NEExtractor.getInnerBoundaryTo Method

Gets the maximum size of the inner iris boundary. Java public int getInnerBoundaryTo(); Returns The maximum size of the inner iris boundary.
8.1.1.1.6.4.5 NEExtractor.getOuterBoundaryFrom Method

Gets the minimum size of the outer iris boundary. Java public int getOuterBoundaryFrom(); Returns The minimum size of the outer iris boundary.
8.1.1.1.6.4.6 NEExtractor.getOuterBoundaryTo Method

Gets the maximum size of the outer iris boundary.
72
public int getOuterBoundaryTo(); Returns The maximum size of the outer iris boundary.
8.1.1.1.6.4.7 NEExtractor.getTemplateSize Method

Gets a template size. Java public NEETemplateSize getTemplateSize(); Returns One of the NeeTemplateSize value.
8.1.1.1.6.4.8 NEExtractor.isDeinterlace Method

Shows if deinterlacing of iris images is enabled. Java public boolean isDeinterlace(); Returns Controls usage of deinterlace on iris images.
8.1.1.1.6.4.9 NEExtractor.isUseFlexibleBoundaryModel Method

Shows whether a more flexible boundary model is used during iris boundary segmentation. Java public boolean isUseFlexibleBoundaryModel(); Returns Controls flexibility of iris boundary model.
8.1.1.1.6.4.10 NEExtractor.nativeTypeOf Method

8.1.1.1.6.4.11 NEExtractor.setDeinterlace Method

Shows if deinterlacing of iris images is enabled. Java public void setDeinterlace(boolean value); Parameters Parameters boolean value Description Controls usage of deinterlace on iris images.
8
8.1.1.1.6.4.12 NEExtractor.setInnerBoundaryFrom Method
Sets the minimum size of the inner iris boundary. 73
public void setInnerBoundaryFrom(int value); Parameters Parameters int value Description The minimum size of the inner iris boundary.
8.1.1.1.6.4.13 NEExtractor.setInnerBoundaryTo Method

Sets the maximum size of the inner iris boundary. Java public void setInnerBoundaryTo(int value); Parameters Parameters int value Description The maximum size of the inner iris boundary.
8.1.1.1.6.4.14 NEExtractor.setOuterBoundaryFrom Method

Sets the minimum size of the outer iris boundary. Java public void setOuterBoundaryFrom(int value); Parameters Parameters int value Description The minimum size of the outer iris boundary.
8.1.1.1.6.4.15 NEExtractor.setOuterBoundaryTo Method

Sets the maximum size of the outer iris boundary. Java public void setOuterBoundaryTo(int value); Parameters Parameters int value Description The maximum size of the outer iris boundary.
8.1.1.1.6.4.16 NEExtractor.setTemplateSize Method

Sets a template size. Java public void setTemplateSize(NEETemplateSize value); Parameters Parameters NEETemplateSize value Returns One of the NeeTemplateSize value. Description [in] Specified size for template (neetsCompact can be used).
8.1.1.1.6.4.17 NEExtractor.setUseFlexibleBoundaryModel Method

Shows whether a more flexible boundary model is used during iris boundary segmentation.
74
public void setUseFlexibleBoundaryModel(boolean value); Parameters Parameters boolean value Description Controls flexibility of iris boundary model.
8.1.1.1.7 NEMatchingDetails Class

Represents iris templates matching details. Java public final class NEMatchingDetails extends NXMatchingDetails; File NEMatchingDetails.java NEMatchingDetails Methods Name nativeTypeOf ( see page 75) Description Retrieves a function that retrieves NType object for the enclosing type.
8.1.1.1.7.1 NEMatchingDetails Methods

8.1.1.1.7.1.1 NEMatchingDetails.nativeTypeOf Method
8.1.1.1.8 NERecord Class

Provides functionality for packing, unpacking and editing Neurotechnology iris Records (NERecords). Java public class NERecord extends NObject implements Cloneable; File NERecord.java Methods Name NERecord ( NERecord Methods Name check ( see page 77) see getCBEFFProductType ( page 77) getHeight ( getPosition ( getQuality ( see page 77) see page 78) see page 78) Description Checks if memory buffer contains a valid NERecord object. Gets the CBEFF product type of the NERecord. Height of iris image in NERecord object. Gets position of iris (left or right eye) in NERecord. Gets quality of iris image in NERecord object. 75 see page 76) Description Initializes a new instance of the NERecord class.
8.1 Java Reference getSize ( getWidth ( see page 79) see page 79)
Gets the size of NERecord object. Width of iris image in {@link NERecord} object. Retrieves a function that retrieves NType object for the enclosing type. Sets the CBEFF product type of the NERecord. Sets position of iris (left or right eye) in NERecord. Sets quality of iris image in NERecord object. see
nativeTypeOf (
see page 79)
setCBEFFProductType ( page 79) setPosition ( setQuality (
8.1.1.1.8.1 NERecord Constructor

8.1.1.1.8.1.1 NERecord.NERecord Constructor (ByteBuffer)
Initializes a new instance of the NERecord class. Java public NERecord(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing packed NERecord.
8.1.1.1.8.1.2 NERecord.NERecord Constructor (ByteBuffer, int)

Initializes a new instance of the NERecord class. Java public NERecord(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer containing packed NERecord. Bitwise combination of zero or more flags that controls behavior of the constructor. Should be zero.
8.1.1.1.8.1.3 NERecord.NERecord Constructor (short, short)

Initializes a new instance of the NERecord class. Java public NERecord(short width, short height); Parameters Parameters short width short height Description Width of original image which contains irises features. Height of original image which contains irises features.
8.1.1.1.8.1.4 NERecord.NERecord Constructor (short, short, int)

Initializes a new instance of the NERecord class. Java public NERecord(short width, short height, int flags); Parameters Parameters short width short height Description Width of original image which contains irises features. Height of original image which contains irises features. 76
8.1 Java Reference int flags
Bitwise combination of zero or more flags that controls behavior of the constructor. Should be zero.
8.1.1.1.8.2 NERecord Methods

8.1.1.1.8.2.1 NERecord.check Method
Checks if memory buffer contains a valid NERecord ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing NERecord ( see page 75) object. see page 75) object.
8.1.1.1.8.2.2 getCBEFFProductType Method 8.1.1.1.8.2.2.1 NERecord.getCBEFFProductType Method ()

Gets the CBEFF product type of the NERecord ( Java public final short getCBEFFProductType(); Returns The CBEFF product type. see page 75).
8.1.1.1.8.2.2.2 NERecord.getCBEFFProductType Method (ByteBuffer)

Retrieves the CBEFF product type of the NERecord ( Java public static short getCBEFFProductType(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The CBEFF product type. Description ByteBuffer containing NERecord ( see page 75) object. see page 75).
8.1.1.1.8.2.3 getHeight Method 8.1.1.1.8.2.3.1 NERecord.getHeight Method ()

Height of iris image in NERecord ( Java public final short getHeight(); Returns Height of the iris image. see page 75) object.
8.1.1.1.8.2.3.2 NERecord.getHeight Method (ByteBuffer)

Gets height of iris image in NERecord ( see page 75) object.
77
public static short getHeight(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Iris image height. Description ByteBuffer containing NERecord ( see page 75) object.
8.1.1.1.8.2.4 getPosition Method 8.1.1.1.8.2.4.1 NERecord.getPosition Method ()

Gets position of iris (left or right eye) in NERecord ( Java public final NEPosition getPosition(); Returns Position value of the iris (left or right iris). see page 75).
8.1.1.1.8.2.4.2 NERecord.getPosition Method (ByteBuffer)

Gets iris position in NERecord ( Java public static NEPosition getPosition(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns One of the NEPosition values. Description ByteBuffer containing NERecord ( see page 75) object. see page 75) object.
8.1.1.1.8.2.5 getQuality Method 8.1.1.1.8.2.5.1 NERecord.getQuality Method ()

Gets quality of iris image in NERecord ( Java public final short getQuality(); Returns Quality of iris image in NERecord ( see page 75) object. see page 75) object.
8.1.1.1.8.2.5.2 NERecord.getQuality Method (ByteBuffer)

Gets quality of iris image in NERecord ( Java public static short getQuality(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing NERecord ( see page 75) object. 78 see page 75) object.
8.1 Java Reference Returns Iris image quality value.
8.1.1.1.8.2.6 NERecord.getSize Method

Gets the size of NERecord ( Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of NERecord ( see page 75) object. Description ByteBuffer containing NERecord ( see page 75) object. see page 75) object.
8.1.1.1.8.2.7 getWidth Method 8.1.1.1.8.2.7.1 NERecord.getWidth Method ()

Width of iris image in {@link NERecord ( Java public final short getWidth(); Returns Width of the iris image. see page 75)} object.
8.1.1.1.8.2.7.2 NERecord.getWidth Method (ByteBuffer)

Gets width of iris image in NERecord ( Java public static short getWidth(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Iris image width. Description ByteBuffer containing NERecord ( see page 75) object. see page 75) object.
8.1.1.1.8.2.8 NERecord.nativeTypeOf Method

8.1.1.1.8.2.9 NERecord.setCBEFFProductType Method

Sets the CBEFF product type of the NERecord ( see page 75).
79
public final void setCBEFFProductType(short type); Parameters Parameters short type Description CBEFF product type
8.1.1.1.8.2.10 NERecord.setPosition Method

Sets position of iris (left or right eye) in NERecord ( Java public final void setPosition(NEPosition value); Parameters Parameters NEPosition value Description The position of iris (left or right eye) in NERecord ( page 75). see see page 75).
8.1.1.1.8.2.11 NERecord.setQuality Method

Sets quality of iris image in NERecord ( Java public final void setQuality(short value); Parameters Parameters short value Description The quality of iris image in NERecord ( see page 75) object. see page 75) object.
8.1.1.1.9 NETemplate Class

Provides functionality for packing, unpacking and editing Neurotechnology iris templates (NETemplates). Java public final class NETemplate extends NObject implements Cloneable; File NETemplate.java Methods Name NETemplate ( NETemplate Classes Name RecordCollection ( NETemplate Fields Name MAX_RECORD_COUNT ( page 82) see Description The maximum number of iris records NETemplate can contain. see page 82) Description Collection of NERecords. see page 81) Description Initializes a new instance of the NTemplate ( see page 210) class.
PROCESS_FIRST_RECORD_ONLY The flag indicating whether only the first iris record should be unpacked ( see page 82) or packed while unpacking or packing NETemplate.
80
8.1 Java Reference NETemplate Methods Name calculateSize ( check (
Description see page 82) see page 82) Calculates size of NETemplate object containing particular NERecords. Checks if memory buffer contains a valid NETemplate object. Gets record count in NETemplate. Gets collection of records in the NETemplate. Gets the size of specified memory buffer. see page 82) see page 83)
getRecordCount ( getRecords ( getSize (
see page 83)
8.1.1.1.9.1 NETemplate Constructor

8.1.1.1.9.1.1 NETemplate.NETemplate Constructor ()
Initializes a new instance of the NTemplate ( Java public NETemplate(); see page 210) class.
8.1.1.1.9.1.2 NETemplate.NETemplate Constructor (ByteBuffer)

Initializes a new instance of the NETemplate class. Java public NETemplate(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer that contains packed NETemlate.
8.1.1.1.9.1.3 NETemplate.NETemplate Constructor (ByteBuffer, int)

Initializes a new instance of the NETemplate class. Java public NETemplate(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer that contains packed NETemlate. Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero.
8.1.1.1.9.1.4 NETemplate.NETemplate Constructor (int)

Initializes a new instance of the NTemplate ( Java public NETemplate(int flags); Parameters Parameters int flags Description Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero. see page 210) class.
8.1.1.1.9.2 NETemplate Classes
81
8.1 Java Reference
8.1.1.1.9.2.1 NETemplate.RecordCollection Class

Collection of NERecords. Java public final class RecordCollection extends NObjectCollection<NERecord>; File NETemplate.java
8.1.1.1.9.3 NETemplate Fields

8.1.1.1.9.3.1 NETemplate.MAX_RECORD_COUNT Field
The maximum number of iris records NETemplate ( Java public static final int MAX_RECORD_COUNT = 255; see page 80) can contain.
8.1.1.1.9.3.2 NETemplate.PROCESS_FIRST_RECORD_ONLY Field

The flag indicating whether only the first iris record should be unpacked or packed while unpacking or packing NETemplate ( see page 80). Java public static final int PROCESS_FIRST_RECORD_ONLY = 0x00000100;
8.1.1.1.9.4 NETemplate Methods

8.1.1.1.9.4.1 NETemplate.calculateSize Method
Calculates size of NETemplate ( Java public static int calculateSize(int[] recordSizes); Parameters Parameters int[] recordSizes Returns Calculated size in bytes. Description Array of separate NERecord ( see page 75) sizes. see page 80) object containing particular NERecords.
8.1.1.1.9.4.2 NETemplate.check Method

Checks if memory buffer contains a valid NETemplate ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing a NETemplate ( see page 80). see page 80) object.
8.1.1.1.9.4.3 NETemplate.getRecordCount Method

Gets record count in NETemplate ( see page 80).
82
public static int getRecordCount(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Number of records in the NETemplate ( see page 80). Description ByteBuffer containing a NETemplate ( see page 80).
8.1.1.1.9.4.4 NETemplate.getRecords Method

Gets collection of records in the NETemplate ( Java public RecordCollection getRecords(); Returns A RecordCollection ( see page 82) collection. see page 80).
8.1.1.1.9.4.5 NETemplate.getSize Method

Gets the size of specified memory buffer. Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of specified memory buffer. Description ByteBuffer
8.1.1.1.10 NFAttributes Class

Provides methods to retrieve fingerprint attributes (metadatawhich is not saved in fingerprint template). Java public class NFAttributes extends NBiometricAttributes; File NFAttributes.java Methods NFAttributes Class Name NFAttributes ( see page 84) Description Creates new instance of NFAttributes.
NBiometricAttributes Methods Name getBiometricType ( getQuality ( getStatus ( setQuality ( see page 61) see page 62) see page 62) see page 62) see page 62) Description Gets the biometric type enumeration for the current object. Gets quality of the current object. Gets the biometric status of the current object. Retrieves a function that retrieves NType object for the enclosing type. Sets quality of the current object. 83
nativeTypeOf (
8.1 Java Reference setStatus ( NFAttributes Class Name getImageIndex ( getPosition ( nativeTypeOf ( setImageIndex ( see page 62)
Sets the biometric status of the current object.
Description see page 84) Gets fingerprint image index. Gets fingerprint position value. Retrieves a function that retrieves NType object for the enclosing type. Sets fingerprint image index. see page 84) Gets fingerprint impression type.
getImpressionType (
8.1.1.1.10.1 NFAttributes.NFAttributes Constructor

Creates new instance of NFAttributes. Java public NFAttributes(NFImpressionType impressionType, NFPosition position);
8.1.1.1.10.2 NFAttributes Methods

8.1.1.1.10.2.1 NFAttributes.getImageIndex Method
Gets fingerprint image index. Java public final int getImageIndex(); Returns Fingerprint image index.
8.1.1.1.10.2.2 NFAttributes.getImpressionType Method

Gets fingerprint impression type. Java public final NFImpressionType getImpressionType(); Returns Fingerprint impression type.
8.1.1.1.10.2.3 NFAttributes.getPosition Method

Gets fingerprint position value. Java public final NFPosition getPosition(); Returns Fingerprint position value.
8.1.1.1.10.2.4 NFAttributes.nativeTypeOf Method

84
8.1 Java Reference
8.1.1.1.10.2.5 NFAttributes.setImageIndex Method

Sets fingerprint image index. Java public final void setImageIndex(int value); Parameters Parameters int value Description Fingerprint image index.
8.1.1.1.11 NFCore Class

The bean contains information of core. Java public final class NFCore; File NFCore.java Methods Name NFCore ( NFCore Fields Name angle ( x( y( NFCore Methods Name getAngle ( setAngle ( see page 86) see page 86) Description Gets the angle ( Sets the angle ( see page 86) of the core. see page 86) of the core. see page 86) see page 86) see page 86) Description The angle of the core. The x coordinate of the core. The y coordinate of the core. see page 85) Description Initializes a new instance of the NFCore class.
8.1.1.1.11.1 NFCore Constructor

8.1.1.1.11.1.1 NFCore.NFCore Constructor (short, short)
Initializes a new instance of the NFCore class. Java public NFCore(short x, short y); Parameters Parameters short x short y Description The x ( The y ( see page 86) - coordinate of the core. see page 86) - coordinate of the core.
8.1.1.1.11.1.2 NFCore.NFCore Constructor (short, short, double)

Initializes a new instance of the NFCore class. Java public NFCore(short x, short y, double angle); 85
8.1 Java Reference Parameters Parameters short x short y double angle
Description The x ( The y ( see page 86) - coordinate of the core. see page 86) - coordinate of the core. see page 86) of the core.
The angle (
8.1.1.1.11.1.3 NFCore.NFCore Constructor (short, short, int)

Initializes a new instance of the NFCore class. Java public NFCore(short x, short y, int angle); Parameters Parameters short x short y int angle Description The x ( The y ( see page 86) - coordinate of the core. see page 86) - coordinate of the core. see page 86) of the core.
The angle (
8.1.1.1.11.2 NFCore Fields

8.1.1.1.11.2.1 NFCore.angle Field
The angle of the core. Java public int angle;
8.1.1.1.11.2.2 NFCore.x Field

The x coordinate of the core. Java public short x;
8.1.1.1.11.2.3 NFCore.y Field

The y coordinate of the core. Java public short y;
8.1.1.1.11.3 NFCore Methods

8.1.1.1.11.3.1 NFCore.getAngle Method
Gets the angle ( Java public double getAngle(); Returns The angle ( see page 86) of the core. see page 86) of the core.
8.1.1.1.11.3.2 NFCore.setAngle Method

Sets the angle ( see page 86) of the core.
86
public void setAngle(double value); Parameters Parameters angle Description The angle ( see page 86) of the core.
8.1.1.1.12 NFDelta Class

The bean contains information of delta. Java public final class NFDelta; File NFDelta.java Methods Name NFDelta ( NFDelta Fields Name angle1 ( angle2 ( angle3 ( y( NFDelta Methods Name getAngle1 ( see page 89) Description Gets the first angle of delta. The angle of the delta is specified in 180/128 degrees units in counterclockwise order and cannot be less than zero or greater than 256 minus one. The value of -1 can be specified if the first angle of the delta is unknown. Gets the second angle of delta. The angle of the delta is specified in 180/128 degrees units in counterclockwise order and cannot be less than zero or greater than 256 minus one. The value of -1 can be specified if the second angle of the delta is unknown. Gets the third angle of delta. The angle of the delta is specified in 180/128 degrees units in counterclockwise order and cannot be less than zero or greater than 256 minus one. The value of -1 can be specified if the third angle of the delta is unknown. Sets the first angle of delta. Sets the second angle of delta. Sets the third angle of delta. see page 88) see page 88) see page 89) Description The first angle of the delta. The second angle of the delta. The third angle of the delta. The y coordinate of the delta. see page 87) Description Initializes a new instance of the NFDelta class.
see page 89)
getAngle2 (
see page 89)
getAngle3 (
see page 89)
setAngle1 ( setAngle2 ( setAngle3 (
8.1.1.1.12.1 NFDelta Constructor

8.1.1.1.12.1.1 NFDelta.NFDelta Constructor ()
Initializes a new instance of the NFDelta class.
87
8.1 Java Reference Java public NFDelta();
8.1.1.1.12.1.2 NFDelta.NFDelta Constructor (short, short)

Initializes a new instance of the NFDelta class. Java public NFDelta(short x, short y); Parameters Parameters short x short y Description The x - coordinate of the core. The y ( see page 89) - coordinate of the core.
8.1.1.1.12.1.3 NFDelta.NFDelta Constructor (short, short, double, double, double)

Initializes a new instance of the NFDelta class. Java public NFDelta(short x, short y, double angle1, double angle2, double angle3); Parameters Parameters short x short y double angle1 double angle2 double angle3 Description The x - coordinate of the core. The y ( see page 89) - coordinate of the core. The first angle of the delta. The second angle of the delta. The third angle of the delta.
8.1.1.1.12.1.4 NFDelta.NFDelta Constructor (short, short, int, int, int)

Initializes a new instance of the NFDelta class. Java public NFDelta(short x, short y, int angle1, int angle2, int angle3); Parameters Parameters short x short y int angle1 int angle2 int angle3 Description The x - coordinate of the core. The y ( see page 89) - coordinate of the core. The first angle of the delta. The second angle of the delta. The third angle of the delta.
8.1.1.1.12.2 NFDelta Fields

8.1.1.1.12.2.1 NFDelta.angle1 Field
The first angle of the delta. Java public int angle1;

The second angle of the delta.
88
8.1 Java Reference Java public int angle2;

The third angle of the delta. Java public int angle3;
8.1.1.1.12.2.4 NFDelta.y Field

The y coordinate of the delta. Java public short y;
8.1.1.1.12.3 NFDelta Methods

8.1.1.1.12.3.1 NFDelta.getAngle1 Method
Gets the first angle of delta. The angle of the delta is specified in 180/128 degrees units in counterclockwise order and cannot be less than zero or greater than 256 minus one. The value of -1 can be specified if the first angle of the delta is unknown. Java public double getAngle1(); Returns The first angle of delta.

Gets the second angle of delta. The angle of the delta is specified in 180/128 degrees units in counterclockwise order and cannot be less than zero or greater than 256 minus one. The value of -1 can be specified if the second angle of the delta is unknown. Java public double getAngle2(); Returns The second angle of delta.

Gets the third angle of delta. The angle of the delta is specified in 180/128 degrees units in counterclockwise order and cannot be less than zero or greater than 256 minus one. The value of -1 can be specified if the third angle of the delta is unknown. Java public double getAngle3(); Returns The third angle of delta.
8.1.1.1.12.3.4 NFDelta.setAngle1 Method

Sets the first angle of delta.
89
public void setAngle1(double value); Parameters Parameters angle Description The first angle of delta.

Sets the second angle of delta. Java public void setAngle2(double value); Parameters Parameters angle Description The second angle of delta.

Sets the third angle of delta. Java public void setAngle3(double value); Parameters Parameters angle Description The third angle of delta.
8.1.1.1.13 NFDoubleCore Class

The bean contains information of double core. Java public final class NFDoubleCore; File NFDoubleCore.java Methods Name NFDoubleCore ( NFDoubleCore Fields Name y( see page 91) Description The Y coordinate of the double core. see page 90) Description Initializes a new instance of the NFDoubleCore class.
8.1.1.1.13.1 NFDoubleCore.NFDoubleCore Constructor

Initializes a new instance of the NFDoubleCore class. Java public NFDoubleCore(short x, short y); Parameters Parameters short x Description The x - coordinate of the double core. 90
8.1 Java Reference short y
The y (
see page 91) - coordinate of the double core.
8.1.1.1.13.2 NFDoubleCore Fields

8.1.1.1.13.2.1 NFDoubleCore.y Field
The Y coordinate of the double core. Java public short y;
8.1.1.1.14 NFExtractor Class

Provides functionality for extracting Neurotechnology Finger Records (NFRecords) from fingerprint images using algorithm/ encapsulated in Neurotechnology Fingerprint Features Extractor (NFExtractor) object. Java public final class NFExtractor extends NObject; File NFExtractor.java Methods Name NFExtractor ( NFExtractor Fields Name MODE_ATMEL_FINGER_CHIP ( MODE_AUTHENTEC_AES2501B ( MODE_AUTHENTEC_AES4000 ( MODE_AUTHENTEC_AFS2 ( see page 94) see page 94) see page 94) Description Atmel FingerChip scanner. AuthenTec AES2501B scanner. AuthenTec AES4000 scanner. AuthenTec AF-S2 scanner. BiometriKa FX 2000 scanner. BiometriKa FX 3000 scanner. BMF BLP100 scanner. see page 95) Cross Match Verifier 300 scanner. Digent Izzix 1000 scanner. see page 95) DigitalPersona U.are.U 2000 / 4000 / 4500 scanners. Ethentica scanner. Fujitsu MBF200 scanner. Futronic FS80 scanner. This mode is used when none of these ModeXXX modes suites. see page Identicator Technology DF90 scanner. see page 94) Description Initializes a new instance of NFExtractor.
MODE_BIOMETRIKA_FX2000 ( MODE_BIOMETRIKA_FX3000 ( MODE_BMF_BLP100 (
see page 95)
MODE_CROSS_MATCH_VERIFIER_300 ( MODE_DIGENT_IZZIX ( see page 95)
MODE_DIGITAL_PERSONA_U_ARE_U ( MODE_ETHENTICA ( see page 95) see page 95) see page 95)
MODE_FUJITSU_MBF200 ( MODE_FUTRONIC_FS80 ( MODE_GENERAL (
see page 96)
MODE_IDENTICATOR_TECHNOLOGY_DF90 ( 96)
91
8.1 Java Reference MODE_IDENTIX_DFR2090 (
Identix DFR 2090 scanner. Identix TouchView scanner.
MODE_IDENTIX_TOUCH_VIEW (
MODE_KEYTRONIC_SECURE_DESKTOP ( MODE_LIGHT_TUNING_LTT_C500 (
see page 96) Keytronic Secure Desktop scanner. LighTuning LTT-C500 Fingerprint Sensor. NITGEN Fingkey Hamster scanner. Precise Biometrics 100CS scanner. SecuGen Hamster scanner. Startek FM200 scanner. Tacoma CMOS scanner. Testech Bio-i scanner. UPEK TouchChip. Identifier specifying whether to extract ( see page 98) curvature value for each minutia. Identifier specifying whether to extract ( page 98) G value for each minutia. see see page 97)
MODE_NITGEN_FINGKEY_HAMSTER ( MODE_PRECISE_BIOMETRICS_100CS ( MODE_SECUGEN_HAMSTER ( MODE_STARTEK_FM200 ( MODE_TACOMA_CMOS ( MODE_TESTECH_BIO_I (
see page 96)
MODE_UPEK_TOUCH_CHIP (
PARAMETER_EXTRACT_CURVATURES ( PARAMETER_EXTRACT_GS (
see page 97) see page 97) see
PARAMETER_EXTRACT_QUALITIES (
Identifier specifying whether to extract ( see page 98) quality value for each minutia. Identifier specifying type of ridge counts extracted parameter of type int. Parameter value can be one of the NFRidgeCountsType enumeration members. Maximal rotation of two features collection to each other. Must be in range 0..180.
PARAMETER_EXTRACTED_RIDGE_COUNTS ( page 97)
PARAMETER_GENERALIZATION_MAXIMAL_ROTATION ( see page 97)
PARAMETER_GENERALIZATION_MIN_MINUTIA_COUNT Identifier specifying minimal minutiae count for ( see page 97) generalization. PARAMETER_GENERALIZATION_THRESHOLD ( page 98) PARAMETER_MIN_MINUTIA_COUNT ( PARAMETER_MODE ( see page 98) see Has the same meaning for features generalization as ParameterMatchingThreshold parameter for features matching. Identifier specifying minimal minutiae count. Identifier specifying mode (parameter value set) parameter of type uint. Parameter value can be one of the ModeXXX. see page 98) Identifier specifies image quality threshold. Identifier specifying kind of image returned after extraction parameter of type int. Parameter value can be one of the NFEReturnedImage enumeration members. Identifier specifying template size parameter. Parameter value can be one of the TemplateSize enumeration members. If identifier is set to true, then methods Extract, ExtractUnpacked determines the quality of the image. If the image quality is lower than ParameterQualityThreshold the method do not returns template. see page 98)
see page 98)
PARAMETER_QUALITY_THRESHOLD ( PARAMETER_RETURNED_IMAGE (
see page 98)
PARAMETER_USE_QUALITY (
see page 98)
92
8.1 Java Reference NFExtractor Methods Name extract ( see page 98)
Description Extracts a NFRecord ( see page 110) from a fingerprint image. position and impressionType are written to extracted NFRecord ( see page 110). Method accepts images with 50-5000 ppi. If image resolution is not equal 500 ppi it will be converted to 500 ppi. Recommended image resolution is 500 ppi. Generalizes count features collections to single features collection. see Gets extracted ridge counts. Gets maximal rotation of two features collection to each other. Maximal rotation of two features collection to each other. Must be in range 0..180. This parameter is important to Generalize, GeneralizeUnpacked methods. Gets minimal minutiae count required for generalization. Gets generalization threshold. Has the same meaning for features generalization as NFMP_MATCHING_THRESHOLD parameter for features matching. Gets minimal minutiae count. Gets scanners mode. Gets image quality threshold. Gets the image type. Gets a template size. Gets value indicating whether curvature value for each minutia is calculated. Gets value indicating whether G value for each minutia is calculated. Checks if the NFExtractor is a palmprint extractor. Checks if specified NFRecord ( NFETemplateSize.Small. see page 110) is of size
generalize (
see page 99)
getExtractedRidgeCounts ( page 99)
getGeneralizationMaximalRotation ( see page 99)
getGeneralizationMinMinutiaCount ( see page 99) getGeneralizationThreshold ( page 100) getMinMinutiaCount ( 100) getMode ( getQualityThreshold ( 100) getReturnedImage ( 100) getTemplateSize ( isExtractCurvatures ( 101) isExtractGs ( isPalm ( isExtractQualities ( isTemplateSmall ( isUseQuality ( see
see page
see page 100) see page see page see page 100) see page
see page 101)
see page 101) Gets value indicating whether quality value for each minutia is calculated. see page 101)
see page 101)
see page 101)
Gets value indicating whether image quality should be checked. If the image quality is lower than ParameterQualityThreshold the method do not returns template. Makes template for FingerCell matcher. Makes template for FingerCell matcher of NFETemplateSize.SMALL size. Gets value indicating whether curvature value for each minutia is calculated. Sets extracted ridge counts. Gets value indicating whether G value for each minutia is calculated. Sets value indicating whether quality value for each minutia is calculated. Sets maximal rotation of two features collection to each other. Sets minimal minutiae count required for generalization. Sets generalization threshold.
makeLightTemplate ( 102) makeSmallTemplate ( 102) setExtractCurvatures ( 102)
see page see page see page see
setExtractedRidgeCounts ( page 102) setExtractGs ( setExtractQualities ( 103)
setGeneralizationMaximalRotation ( see page 103) setGeneralizationMinMinutiaCount ( see page 103) setGeneralizationThreshold ( page 103) see
93
8.1 Java Reference setMinMinutiaCount ( 104) setMode ( setQualityThreshold ( 104) setReturnedImage ( 104) setTemplateSize ( setUseQuality ( updateTemplate (
see page
Sets minimal minutiae count. Sets scanners mode. Sets image quality threshold. Sets the image type. Sets a template size. Sets value indicating whether image quality should be checked. This method updates ridge counts and minutiae curvatures and Gs using the image provided.
see page 104) see page see page see page 104) see page 105)
see page 105)
8.1.1.1.14.1 NFExtractor Constructor

8.1.1.1.14.1.1 NFExtractor.NFExtractor Constructor ()
Initializes a new instance of NFExtractor. Java public NFExtractor();
8.1.1.1.14.1.2 NFExtractor.NFExtractor Constructor (boolean)

Initializes a new instance of NFExtractor. Java public NFExtractor(boolean isPalm); Parameters Parameters boolean isPalm Description NFExtractor is a palmprint extractor.
8.1.1.1.14.2 NFExtractor Fields

8.1.1.1.14.2.1 NFExtractor.MODE_ATMEL_FINGER_CHIP Field
Atmel FingerChip scanner. Java public static final int MODE_ATMEL_FINGER_CHIP = 900;
8.1.1.1.14.2.2 NFExtractor.MODE_AUTHENTEC_AES2501B Field

AuthenTec AES2501B scanner. Java public static final int MODE_AUTHENTEC_AES2501B = 811;
8.1.1.1.14.2.3 NFExtractor.MODE_AUTHENTEC_AES4000 Field

AuthenTec AES4000 scanner. Java public static final int MODE_AUTHENTEC_AES4000 = 810;
8.1.1.1.14.2.4 NFExtractor.MODE_AUTHENTEC_AFS2 Field

AuthenTec AF-S2 scanner.
94
public static final int MODE_AUTHENTEC_AFS2 = 800;
8.1.1.1.14.2.5 NFExtractor.MODE_BIOMETRIKA_FX2000 Field

BiometriKa FX 2000 scanner. Java public static final int MODE_BIOMETRIKA_FX2000 = 200;
8.1.1.1.14.2.6 NFExtractor.MODE_BIOMETRIKA_FX3000 Field

BiometriKa FX 3000 scanner. Java public static final int MODE_BIOMETRIKA_FX3000 = 201;
8.1.1.1.14.2.7 NFExtractor.MODE_BMF_BLP100 Field

BMF BLP100 scanner. Java public static final int MODE_BMF_BLP100 = 1000;
8.1.1.1.14.2.8 NFExtractor.MODE_CROSS_MATCH_VERIFIER_300 Field

Cross Match Verifier 300 scanner. Java public static final int MODE_CROSS_MATCH_VERIFIER_300 = 1300;
8.1.1.1.14.2.9 NFExtractor.MODE_DIGENT_IZZIX Field

Digent Izzix 1000 scanner. Java public static final int MODE_DIGENT_IZZIX = 1600;
8.1.1.1.14.2.10 NFExtractor.MODE_DIGITAL_PERSONA_U_ARE_U Field

DigitalPersona U.are.U 2000 / 4000 / 4500 scanners. Java public static final int MODE_DIGITAL_PERSONA_U_ARE_U = 100;
8.1.1.1.14.2.11 NFExtractor.MODE_ETHENTICA Field

Ethentica scanner. Java public static final int MODE_ETHENTICA = 1200;
8.1.1.1.14.2.12 NFExtractor.MODE_FUJITSU_MBF200 Field

Fujitsu MBF200 scanner. Java public static final int MODE_FUJITSU_MBF200 = 1800;
8.1.1.1.14.2.13 NFExtractor.MODE_FUTRONIC_FS80 Field

Futronic FS80 scanner. Java public static final int MODE_FUTRONIC_FS80 = 1900; 95
8.1 Java Reference
8.1.1.1.14.2.14 NFExtractor.MODE_GENERAL Field

This mode is used when none of these ModeXXX modes suites. Java public static final int MODE_GENERAL = 0;
8.1.1.1.14.2.15 NFExtractor.MODE_IDENTICATOR_TECHNOLOGY_DF90 Field

Identicator Technology DF90 scanner. Java public static final int MODE_IDENTICATOR_TECHNOLOGY_DF90 = 700;
8.1.1.1.14.2.16 NFExtractor.MODE_IDENTIX_DFR2090 Field

Identix DFR 2090 scanner. Java public static final int MODE_IDENTIX_DFR2090 = 401;
8.1.1.1.14.2.17 NFExtractor.MODE_IDENTIX_TOUCH_VIEW Field

Identix TouchView scanner. Java public static final int MODE_IDENTIX_TOUCH_VIEW = 400;
8.1.1.1.14.2.18 NFExtractor.MODE_KEYTRONIC_SECURE_DESKTOP Field

Keytronic Secure Desktop scanner. Java public static final int MODE_KEYTRONIC_SECURE_DESKTOP = 300;
8.1.1.1.14.2.19 NFExtractor.MODE_LIGHT_TUNING_LTT_C500 Field

LighTuning LTT-C500 Fingerprint Sensor. Java public static final int MODE_LIGHT_TUNING_LTT_C500 = 2000;
8.1.1.1.14.2.20 NFExtractor.MODE_NITGEN_FINGKEY_HAMSTER Field

NITGEN Fingkey Hamster scanner. Java public static final int MODE_NITGEN_FINGKEY_HAMSTER = 1400;
8.1.1.1.14.2.21 NFExtractor.MODE_PRECISE_BIOMETRICS_100CS Field

Precise Biometrics 100CS scanner. Java public static final int MODE_PRECISE_BIOMETRICS_100CS = 500;
8.1.1.1.14.2.22 NFExtractor.MODE_SECUGEN_HAMSTER Field

SecuGen Hamster scanner. Java public static final int MODE_SECUGEN_HAMSTER = 1100;
8.1.1.1.14.2.23 NFExtractor.MODE_STARTEK_FM200 Field

Startek FM200 scanner. 96
public static final int MODE_STARTEK_FM200 = 1700;
8.1.1.1.14.2.24 NFExtractor.MODE_TACOMA_CMOS Field

Tacoma CMOS scanner. Java public static final int MODE_TACOMA_CMOS = 2100;
8.1.1.1.14.2.25 NFExtractor.MODE_TESTECH_BIO_I Field

Testech Bio-i scanner. Java public static final int MODE_TESTECH_BIO_I = 1500;
8.1.1.1.14.2.26 NFExtractor.MODE_UPEK_TOUCH_CHIP Field

UPEK TouchChip. Java public static final int MODE_UPEK_TOUCH_CHIP = 600;
8.1.1.1.14.2.27 NFExtractor.PARAMETER_EXTRACT_CURVATURES Field

Identifier specifying whether to extract ( Java public static final int PARAMETER_EXTRACT_CURVATURES = 112; see page 98) curvature value for each minutia.
8.1.1.1.14.2.28 NFExtractor.PARAMETER_EXTRACT_GS Field

Identifier specifying whether to extract ( Java public static final int PARAMETER_EXTRACT_GS = 113; see page 98) G value for each minutia.
8.1.1.1.14.2.29 NFExtractor.PARAMETER_EXTRACT_QUALITIES Field

Identifier specifying whether to extract ( Java public static final int PARAMETER_EXTRACT_QUALITIES = 111; see page 98) quality value for each minutia.
8.1.1.1.14.2.30 NFExtractor.PARAMETER_EXTRACTED_RIDGE_COUNTS Field

Identifier specifying type of ridge counts extracted parameter of type int. Parameter value can be one of the NFRidgeCountsType enumeration members. Java public static final int PARAMETER_EXTRACTED_RIDGE_COUNTS = 120;
8.1.1.1.14.2.31 NFExtractor.PARAMETER_GENERALIZATION_MAXIMAL_ROTATION Field

Maximal rotation of two features collection to each other. Must be in range 0..180. Java public static final int PARAMETER_GENERALIZATION_MAXIMAL_ROTATION = 301;
8.1.1.1.14.2.32 NFExtractor.PARAMETER_GENERALIZATION_MIN_MINUTIA_COUNT Field

Identifier specifying minimal minutiae count for generalization.
97
public static final int PARAMETER_GENERALIZATION_MIN_MINUTIA_COUNT = 319;
8.1.1.1.14.2.33 NFExtractor.PARAMETER_GENERALIZATION_THRESHOLD Field

Has the same meaning for features generalization as ParameterMatchingThreshold parameter for features matching. Java public static final int PARAMETER_GENERALIZATION_THRESHOLD = 300;
8.1.1.1.14.2.34 NFExtractor.PARAMETER_MIN_MINUTIA_COUNT Field

Identifier specifying minimal minutiae count. Java public static final int PARAMETER_MIN_MINUTIA_COUNT = 119;
8.1.1.1.14.2.35 NFExtractor.PARAMETER_MODE Field

Identifier specifying mode (parameter value set) parameter of type uint. Parameter value can be one of the ModeXXX. Java public static final int PARAMETER_MODE = 1000;
8.1.1.1.14.2.36 NFExtractor.PARAMETER_QUALITY_THRESHOLD Field

Identifier specifies image quality threshold. Java public static final int PARAMETER_QUALITY_THRESHOLD = 910;
8.1.1.1.14.2.37 NFExtractor.PARAMETER_RETURNED_IMAGE Field

Identifier specifying kind of image returned after extraction parameter of type int. Parameter value can be one of the NFEReturnedImage enumeration members. Java public static final int PARAMETER_RETURNED_IMAGE = 190;
8.1.1.1.14.2.38 NFExtractor.PARAMETER_TEMPLATE_SIZE Field

8.1.1.1.14.2.39 NFExtractor.PARAMETER_USE_QUALITY Field

If identifier is set to true, then methods Extract, ExtractUnpacked determines the quality of the image. If the image quality is lower than ParameterQualityThreshold the method do not returns template. Java public static final int PARAMETER_USE_QUALITY = 900;
8.1.1.1.14.3 NFExtractor Methods

8.1.1.1.14.3.1 NFExtractor.extract Method
Extracts a NFRecord ( see page 110) from a fingerprint image.
position and impressionType are written to extracted NFRecord ( see page 110). Method accepts images with 50-5000 ppi. If image resolution is not equal 500 ppi it will be converted to 500 ppi. Recommended image resolution is 500 ppi.
98
public ExtractResult extract(NGrayscaleImage image, NFPosition position, NFImpressionType impressionType); Parameters Parameters NGrayscaleImage image NFPosition position NFImpressionType impressionType Returns NFExtractorResult object. Description The NGrayscaleImage image. The finger NFPosition. The finger NFImpressionType.
8.1.1.1.14.3.2 NFExtractor.generalize Method

Generalizes count features collections to single features collection. Java public ExtractResult generalize(NFRecord[] records); Parameters Parameters NFRecord[] records Returns Byte array that contains generalized NFRecord ( see page 110). Description The array of NFRecord ( see page 110) templates.
8.1.1.1.14.3.3 NFExtractor.getExtractedRidgeCounts Method

Gets extracted ridge counts. Java public NFRidgeCountsType getExtractedRidgeCounts(); Returns One of the NFRidgeCountsType values.
8.1.1.1.14.3.4 NFExtractor.getGeneralizationMaximalRotation Method

Gets maximal rotation of two features collection to each other. Maximal rotation of two features collection to each other. Must be in range 0..180. This parameter is important to Generalize, GeneralizeUnpacked methods. Java public int getGeneralizationMaximalRotation(); Returns The generalization maximal rotation.
8.1.1.1.14.3.5 NFExtractor.getGeneralizationMinMinutiaCount Method

Gets minimal minutiae count required for generalization. Java public int getGeneralizationMinMinutiaCount(); Returns The generalization minimal minutiae count. 99
8.1 Java Reference
8.1.1.1.14.3.6 NFExtractor.getGeneralizationThreshold Method

Gets generalization threshold. Has the same meaning for features generalization as NFMP_MATCHING_THRESHOLD parameter for features matching. Java public int getGeneralizationThreshold(); Returns Generalization threshold.
8.1.1.1.14.3.7 NFExtractor.getMinMinutiaCount Method

Gets minimal minutiae count. Java public int getMinMinutiaCount(); Returns minimal minutiae count.
8.1.1.1.14.3.8 NFExtractor.getMode Method

Gets scanners mode. Java public int getMode(); Returns One of the Mode constants.
8.1.1.1.14.3.9 NFExtractor.getQualityThreshold Method

Gets image quality threshold. Java public int getQualityThreshold(); Returns The image quality threshold. The value should be in range [0, 255].
8.1.1.1.14.3.10 NFExtractor.getReturnedImage Method

Gets the image type. Java public NFEReturnedImage getReturnedImage(); Returns One of the NFEReturnedImage value.
8.1.1.1.14.3.11 NFExtractor.getTemplateSize Method

Gets a template size. Java public NFETemplateSize getTemplateSize(); Returns One of the NFETemplateSize value. 100
8.1 Java Reference
8.1.1.1.14.3.12 NFExtractor.isExtractCurvatures Method

Gets value indicating whether curvature value for each minutia is calculated. Java public boolean isExtractCurvatures(); Returns Boolean identifier specifying whether to extract ( see page 98) curvature value for each minutia.
8.1.1.1.14.3.13 NFExtractor.isExtractGs Method

Gets value indicating whether G value for each minutia is calculated. Java public boolean isExtractGs(); Returns Boolean identifier specifying whether to extract ( see page 98) G value for each minutia.
8.1.1.1.14.3.14 NFExtractor.isExtractQualities Method

Gets value indicating whether quality value for each minutia is calculated. Java public boolean isExtractQualities(); Returns Boolean identifier specifying whether to extract ( see page 98) quality value for each minutia.
8.1.1.1.14.3.15 NFExtractor.isPalm Method

Checks if the NFExtractor ( Java public boolean isPalm(); Returns true if NFExtractor ( see page 91) is a palmprint extractor; otherwise, false see page 91) is a palmprint extractor.
8.1.1.1.14.3.16 NFExtractor.isTemplateSmall Method

Checks if specified NFRecord ( Java public static boolean isTemplateSmall(NFRecord record); Parameters Parameters NFRecord record Returns true if NFRecord ( see page 110) is of size NFETemplateSize.Small, false otherwise. Description NFRecord ( see page 110) object. see page 110) is of size NFETemplateSize.Small.
8.1.1.1.14.3.17 NFExtractor.isUseQuality Method

Gets value indicating whether image quality should be checked. If the image quality is lower than ParameterQualityThreshold the method do not returns template.
101
8.1 Java Reference Java public boolean isUseQuality(); Returns
true if then methods Extract, ExtractUnpacked determines the quality of the image.
8.1.1.1.14.3.18 NFExtractor.makeLightTemplate Method

Makes template for FingerCell matcher. Java public static NFRecord makeLightTemplate(NFRecord record, boolean makeSmallTemplate, boolean preserveRidgeCounts); Parameters Parameters NFRecord record boolean makeSmallTemplate Description NFRecord ( see page 110) object. Determinates template size. If parameter will be true then method returns NFETemplateSize.Small NFRecord ( see page 110) FingerCell template; otherwise, NFETemplateSize.Large NFRecord ( see page 110) FingerCell template. makeSmallTemplate ( see page 102) should be NFETemplateSize.Small for FingerCell matcher.
boolean preserveRidgeCounts Returns NFRecord ( see page 110) template for FingerCell matcher.
8.1.1.1.14.3.19 NFExtractor.makeSmallTemplate Method

Makes template for FingerCell matcher of NFETemplateSize.SMALL size. Java public static NFRecord makeSmallTemplate(NFRecord record); Parameters Parameters NFRecord record Returns NFRecord ( see page 110) template for FingerCell matcher. Description NFRecord ( see page 110) object.
8.1.1.1.14.3.20 NFExtractor.setExtractCurvatures Method

Gets value indicating whether curvature value for each minutia is calculated. Java public void setExtractCurvatures(boolean value); Parameters Parameters boolean value Description Boolean identifier specifying whether to extract ( 98) curvature value for each minutia. see page
8.1.1.1.14.3.21 NFExtractor.setExtractedRidgeCounts Method

Sets extracted ridge counts.
102
public void setExtractedRidgeCounts(NFRidgeCountsType value); Parameters Parameters NFRidgeCountsType value Description One of the NFRidgeCountsType values.
8.1.1.1.14.3.22 NFExtractor.setExtractGs Method

Gets value indicating whether G value for each minutia is calculated. Java public void setExtractGs(boolean value); Parameters Parameters boolean value Description Boolean identifier specifying whether to extract ( 98) G value for each minutia. see page
8.1.1.1.14.3.23 NFExtractor.setExtractQualities Method

Sets value indicating whether quality value for each minutia is calculated. Java public void setExtractQualities(boolean value); Parameters Parameters boolean value Description Boolean identifier specifying whether to extract ( 98) quality value for each minutia. see page
8.1.1.1.14.3.24 NFExtractor.setGeneralizationMaximalRotation Method

Sets maximal rotation of two features collection to each other. Java public void setGeneralizationMaximalRotation(int value); Parameters Parameters int value Description The generalization maximal rotation.
8.1.1.1.14.3.25 NFExtractor.setGeneralizationMinMinutiaCount Method

Sets minimal minutiae count required for generalization. Java public void setGeneralizationMinMinutiaCount(int value); Parameters Parameters int value Description The generalization minimal minutiae count.
8.1.1.1.14.3.26 NFExtractor.setGeneralizationThreshold Method

Sets generalization threshold. Java public void setGeneralizationThreshold(int value); 103
8.1 Java Reference Parameters Parameters int value
Description Generalization threshold.
8.1.1.1.14.3.27 NFExtractor.setMinMinutiaCount Method

Sets minimal minutiae count. Java public void setMinMinutiaCount(int value); Parameters Parameters int value Description minimum minutiae count.
8.1.1.1.14.3.28 NFExtractor.setMode Method

Sets scanners mode. Java public void setMode(int value); Parameters Parameters int value Description One of the Mode constants.
8.1.1.1.14.3.29 NFExtractor.setQualityThreshold Method

Sets image quality threshold. Java public void setQualityThreshold(int value); Parameters Parameters int value Description The image quality threshold. The value should be in range [0, 255].
8.1.1.1.14.3.30 NFExtractor.setReturnedImage Method

Sets the image type. Java public void setReturnedImage(NFEReturnedImage value); Parameters Parameters NFEReturnedImage value Description One of the NFEReturnedImage value.
8.1.1.1.14.3.31 NFExtractor.setTemplateSize Method

Sets a template size. Java public void setTemplateSize(NFETemplateSize value); Parameters Parameters NFETemplateSize value Description One of the NFETemplateSize value. 104
8.1 Java Reference
8.1.1.1.14.3.32 NFExtractor.setUseQuality Method

Sets value indicating whether image quality should be checked. Java public void setUseQuality(boolean value); Parameters Parameters boolean value Description true if then methods Extract, ExtractUnpacked determines the quality of the image.
8.1.1.1.14.3.33 NFExtractor.updateTemplate Method

This method updates ridge counts and minutiae curvatures and Gs using the image provided. Java public void updateTemplate(NGrayscaleImage image, NFRecord record); Parameters Parameters NGrayscaleImage image NFRecord record Description The NGrayscaleImage image. The NFRecord ( see page 110) object.
8.1.1.1.15 NFMatchingDetails Class

Represents Neurotechnology Fingerprint or Palmprint Records (NFRecord ( Java public final class NFMatchingDetails extends NXMatchingDetails; File NFMatchingDetails.java NFMatchingDetails Methods Name getCenterX ( getCenterY ( see page 105) see page 106) Description Gets X coordinate center of mass of the second NfmVerify matched template. Gets Y coordinate center of mass of the second NfmVerify matched template. see page 110)) matching details.
getMatedMinutiae ( getRotation (
see page 106) Gets an array of NIndexPair containing pairs of indexes of mated minutiae in first and second matched NFRecords. Gets rotation of second matched NFRecord ( first one. see page 110) against the see page
getTranslationX ( getTranslationY (
Gets horizontal translation of second matched NFRecord ( 110) against the first one. Gets vertical translation of second matched NFRecord ( against the first one.
see page 110)
8.1.1.1.15.1 NFMatchingDetails Methods

8.1.1.1.15.1.1 NFMatchingDetails.getCenterX Method
Gets X coordinate center of mass of the second NfmVerify matched template. Java public int getCenterX(); 105
8.1 Java Reference Returns
X coordinate center of mass of matched template.
8.1.1.1.15.1.2 NFMatchingDetails.getCenterY Method

Gets Y coordinate center of mass of the second NfmVerify matched template. Java public int getCenterY(); Returns Y coordinate of second matched template.
8.1.1.1.15.1.3 NFMatchingDetails.getMatedMinutiae Method

Gets an array of NIndexPair containing pairs of indexes of mated minutiae in first and second matched NFRecords. Java public NIndexPair getMatedMinutiae(); Returns Array of NIndexPair containing pairs of indexes of mated minutiae.
8.1.1.1.15.1.4 NFMatchingDetails.getRotation Method

Gets rotation of second matched NFRecord ( Java public int getRotation(); Returns Rotation of second matched NFRecord ( see page 110). see page 110) against the first one.
8.1.1.1.15.1.5 NFMatchingDetails.getTranslationX Method

Gets horizontal translation of second matched NFRecord ( Java public int getTranslationX(); Returns Horizontal translation of second matched NFRecord ( see page 110). see page 110) against the first one.
8.1.1.1.15.1.6 NFMatchingDetails.getTranslationY Method

Gets vertical translation of second matched NFRecord ( Java public int getTranslationY(); Returns Vertical translation of second matched NFRecord ( see page 110). see page 110) against the first one.
8.1.1.1.16 NFMinutia Class

Contains information of minutia. Java public final class NFMinutia; 106
8.1 Java Reference File NFMinutia.java Methods Name NFMinutia ( NFMinutia Fields Name angle ( g( see page 108) see page 108) curvature ( quality ( type ( y( see page 107)
Description Initializes a new instance of the NFMinutia class.
Description The angle of the minutia. The ridge curvature near minutia. The G (ridge density) near minutia. The quality of the minutia. One of the NFMinutiaType values. The Y coordinate of the minutia.
see page 109)
NFMinutia Methods Name getAngle ( see page 109) Description Gets the angle ( see page 108) of the minutia. The angle ( see page 108) of the minutia is specified in 180/128 degrees units in counterclockwise order and cannot be greater than 256 minus one. Sets the angle ( see page 108) of the minutia. The angle ( see page 108) of the minutia is specified in 180/128 degrees units in counterclockwise order and cannot be greater than 256 minus one.
setAngle (
see page 109)
8.1.1.1.16.1 NFMinutia Constructor

8.1.1.1.16.1.1 NFMinutia.NFMinutia Constructor ()
Initializes a new instance of the NFMinutia class. Java public NFMinutia();
8.1.1.1.16.1.2 NFMinutia.NFMinutia Constructor (short, short, NFMinutiaType, byte)

Initializes a new instance of the NFMinutia class. Java public NFMinutia(short x, short y, NFMinutiaType type, byte angle); Parameters Parameters short x short y NFMinutiaType type byte angle Description The x coordinate of the minutia. The y ( see page 109) coordinate of the minutia. see page 108) of the minutia. One of the NFMinutiaType values. The angle (
8.1.1.1.16.1.3 NFMinutia.NFMinutia Constructor (short, short, NFMinutiaType, byte, byte, short, short)
Initializes a new instance of the NFMinutia class. Java public NFMinutia(short x, short y, NFMinutiaType type, byte angle, byte quality, short 107
8.1 Java Reference curvature, short g); Parameters Parameters short x short y NFMinutiaType type byte angle byte quality short curvature short g
Description The x coordinate of the minutia. The y ( see page 109) coordinate of the minutia. see page 108) of the minutia. see page 109) of the minutia. see page 108) near minutia. One of the NFMinutiaType values. The angle ( The quality (
The ridge curvature (
The G (ridge density) near minutia.
8.1.1.1.16.1.4 NFMinutia.NFMinutia Constructor (short, short, NFMinutiaType, double)

Initializes a new instance of the NFMinutia class. Java public NFMinutia(short x, short y, NFMinutiaType type, double angle); Parameters Parameters short x short y NFMinutiaType type double angle Description The x coordinate of the minutia. The y ( see page 109) coordinate of the minutia. see page 108) of the minutia. One of the NFMinutiaType values. The angle (
8.1.1.1.16.1.5 NFMinutia.NFMinutia Constructor (short, short, NFMinutiaType, double, byte, short, short)
Initializes a new instance of the NFMinutia class. Java public NFMinutia(short x, short y, NFMinutiaType type, double angle, byte quality, short curvature, short g); Parameters Parameters short x short y NFMinutiaType type double angle byte quality short curvature short g Description The x coordinate of the minutia. The y ( see page 109) coordinate of the minutia. see page 108) of the minutia. see page 109) of the minutia. see page 108) near minutia. One of the NFMinutiaType values. The angle ( The quality (
The ridge curvature (
The G (ridge density) near minutia.
8.1.1.1.16.2 NFMinutia Fields

8.1.1.1.16.2.1 NFMinutia.angle Field
The angle of the minutia. Java public byte angle;
8.1.1.1.16.2.2 NFMinutia.curvature Field

The ridge curvature near minutia.
108
8.1 Java Reference Java public short curvature;
8.1.1.1.16.2.3 NFMinutia.g Field

The G (ridge density) near minutia. Java public short g;
8.1.1.1.16.2.4 NFMinutia.quality Field

The quality of the minutia. Java public byte quality;
8.1.1.1.16.2.5 NFMinutia.type Field

One of the NFMinutiaType values. Java public NFMinutiaType type;
8.1.1.1.16.2.6 NFMinutia.y Field

The Y coordinate of the minutia. Java public short y;
8.1.1.1.16.3 NFMinutia Methods

8.1.1.1.16.3.1 NFMinutia.getAngle Method
Gets the angle ( see page 108) of the minutia.
The angle ( see page 108) of the minutia is specified in 180/128 degrees units in counterclockwise order and cannot be greater than 256 minus one. Java public double getAngle(); Returns The angle ( see page 108) of the minutia.
8.1.1.1.16.3.2 NFMinutia.setAngle Method

Sets the angle ( see page 108) of the minutia.
The angle ( see page 108) of the minutia is specified in 180/128 degrees units in counterclockwise order and cannot be greater than 256 minus one. Java public void setAngle(double value); Parameters Parameters angle Description The angle ( see page 108) of the minutia.
109
8.1 Java Reference
8.1.1.1.17 NFMinutiaNeighbor Class

The bean contains information of minutia neighbor. Java public final class NFMinutiaNeighbor; File NFMinutiaNeighbor.java Methods Name NFMinutiaNeighbor ( 110) NFMinutiaNeighbor Fields Name EMPTY ( see page 110) see page 110) ridgeCount ( Description Represents a NFMinutiaNeighbor that is a null reference. The ridge count between the minutia and minutia neighbor. see page Description Initializes a new instance of the NFMinutiaNeighbor class.
8.1.1.1.17.1 NFMinutiaNeighbor.NFMinutiaNeighbor Constructor

Initializes a new instance of the NFMinutiaNeighbor class. Java public NFMinutiaNeighbor(int index, byte ridgeCount); Parameters Parameters int index byte ridgeCount Description The index of neighbor. The ridge count of neighbor.
8.1.1.1.17.2 NFMinutiaNeighbor Fields

8.1.1.1.17.2.1 NFMinutiaNeighbor.EMPTY Field
Represents a NFMinutiaNeighbor ( Java public static final NFMinutiaNeighbor EMPTY = new NFMinutiaNeighbor(-1, (byte)255); see page 110) that is a null reference.
8.1.1.1.17.2.2 NFMinutiaNeighbor.ridgeCount Field

The ridge count between the minutia and minutia neighbor. Java public byte ridgeCount;
8.1.1.1.18 NFRecord Class

Provides functionality for packing, unpacking and editing Neurotechnology Finger Records (NFRecords). Java public class NFRecord extends NObject implements Cloneable; File NFRecord.java
110
8.1 Java Reference Methods Name NFRecord ( NFRecord Classes Name CoreCollection ( DeltaCollection ( see page 113)
Description Initializes a new instance of the NFRecord class.
Description see page 115) see page 115) see page Represents the collection of NFCore ( Represents the collection of NFDelta ( see page 85). see page 87). see page 90).
DoubleCoreCollection ( 115) MinutiaCollection (
Represents the collection of NFDoubleCore ( Represents the collection of NFMinutia (
see page 115) see see
see page 106). see page 110).
MinutiaNeighborsCollection ( page 115) PossiblePositionCollection ( page 115) NFRecord Fields Name
Represents the collection of NFMinutiaNeighbor ( Represent collection of possible positions.
Description
FLAG_ALLOW_OUT_OF_BOUNDS_FEATURES The flag indicating whether NFRecord shall allow features ( see page 116) outside image dimensions. FLAG_SAVE_BLOCKED_ORIENTS ( 116) FLAG_SAVE_V1 ( FLAG_SAVE_V2 ( FLAG_SAVE_V3 ( see page 116) see page 116) see page 116) see page see page The flag indicating whether blocked orientations should be packed in NFRecord. The flag indicating whether NFRecord should be saved using version 1 algorithm. The flag indicating whether NFRecord should be saved using version 2 algorithm. The flag indicating whether NFRecord should be saved using version 3 algorithm. The flag indicating whether blocked orientations should be skipped while unpacking NFRecord. The flag indicating whether minutiae curvatures should be skipped while unpacking or packing NFRecord. The flag indicating whether G field should be skipped while unpacking or packing NFRecord. The flag indicating whether minutiae qualities should be skipped while unpacking or packing NFRecord.
FLAG_SKIP_BLOCKED_ORIENTS ( 116) FLAG_SKIP_CURVATURES ( FLAG_SKIP_GS (
see page 116)
FLAG_SKIP_QUALITIES (
FLAG_SKIP_RIDGE_COUNTS (
see page 117) The flag indicating whether ridge counts should be skipped while unpacking or packing NFRecord. see page The flag indicating whether singular points (cores, deltas and double cores) should be skipped while unpacking or packing NFRecord. The maximum number of deltas a NFRecord can contain. The maximum number of finger dimension.
FLAG_SKIP_SINGULAR_POINTS ( 117) MAX_FINGER_CORE_COUNT ( MAX_FINGER_DELTA_COUNT ( 117) MAX_FINGER_DIMENSION (
see page 117) The maximum number of cores a NFRecord can contain. see page
see page 117)
MAX_FINGER_DOUBLE_CORE_COUNT ( page 117) MAX_FINGER_MINUTIA_COUNT ( 117) MAX_PALM_CORE_COUNT ( MAX_PALM_DELTA_COUNT ( MAX_PALM_DIMENSION (
see The maximum number of double cores a NFRecord can contain. The maximum number of finger minutiae a NFRecord can contain. The maximum number of cores in a palmprint a NFRecord can contain. The maximum number of deltas in a palmprint a NFRecord can contain. The maximum number of a palmprint dimension. 111
see page
see page 118)
8.1 Java Reference
MAX_PALM_DOUBLE_CORE_COUNT ( page 118) MAX_PALM_MINUTIA_COUNT (
see
The maximum number of double cores in a palmprint a NFRecord can contain.
see page 118) The maximum number of minutiae in a palmprint a NFRecord can contain. see The maximum number of possible positions a NFRecord can contain. The resolution of minutiae, cores, deltas and double cores coordinates in a NFRecord.
MAX_POSSIBLE_POSITION_COUNT ( page 118) RESOLUTION ( NFRecord Methods Name check ( see page 118) see getCBEFFProductType ( page 118) getCores ( getDeltas ( getG ( see page 118)
Description Checks if format of packed NFRecord is correct. Gets the CBEFF product type of the NFRecord. Gets cores collection. Gets deltas collection. Gets double cores collection. Gets additional fingerprint coefficient. G - average fingerprint ridge density. It can have values from 0 to 255, so it occupies one byte. Gets the height of fingerprint image. Gets horizontal resolution of fingerprint image. Gets the impression type of the NFRecord. Calculates the maximal NFRecord size. Calculates the maximal version 1.0 NFRecord size. Gets minutiae collection. Gets minutia neighbors format from NFRecord.
getDoubleCores (
see page 119) see page 120) see page see page
getHeight (
getHorzResolution ( 120) getImpressionType ( 121) getMaxSize ( getMinutiae ( getMaxSizeV1 (
see page 121) see page 122) see page see page 123)
getMinutiaeNeighbors ( 123) getMinutiaFormat ( getPatternClass ( getPosition (
see page 123) Gets minutia format from NFRecord. see page 123) Gets pattern class. This property gets NFPatternClass if NFPatternClass was set before getting. Gets finger position. Gets possible position collection. Gets fingerprint quality. Gets ridge counts type. Gets the size of packed NFRecord. Calculates version 1.0 packed size of NFRecord. Behavior is controlled through flags. Gets width of fingerprint image. Retrieves a function that retrieves NType object for the enclosing type. Packs NFRecord to memory buffer in version 1.0 format. see Sets the CBEFF product type of the NFRecord. Sets additional fingerprint coefficient. Sets the impression type of the NFRecord.
getPossiblePositions ( 124) getQuality ( getRidgeCountsType ( 125) getSize ( getSizeV1 (
getVertResolution ( getWidth ( saveV1 ( nativeTypeOf (
see page 126) Gets vertical resolution of fingerprint image.
setCBEFFProductType ( page 128) setG ( see page 128) setImpressionType ( 128) setMinutiaFormat ( setPatternClass ( setPosition (
see page
see page 128) Sets minutia format from NFRecord. see page 129) Sets pattern class. Sets finger position. 112
see page 129)
8.1 Java Reference setQuality ( see page 129)
Sets fingerprint quality. Sets ridge counts type. Sorts minutiae in NFRecord by the specified order. Truncates minutiae in NFRecord by peeling off the minutiae convex hull while minutia count is greater than the specified maximal count. Truncates minutiae in NFRecord by removing minutiae which NFMinutia ( see page 106). Quality field value is less than the specified threshold while minutia count is greater than the specified maximal count.
setRidgeCountsType ( 129) sortMinutiae ( truncateMinutiae (
see page
truncateMinutiaeByQuality ( page 130)
8.1.1.1.18.1 NFRecord Constructor

8.1.1.1.18.1.1 NFRecord.NFRecord Constructor (ByteBuffer)
Initializes a new instance of the NFRecord class. Java public NFRecord(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer that contains packed NFRecord.
8.1.1.1.18.1.2 NFRecord.NFRecord Constructor (ByteBuffer, int)

Initializes a new instance of the NFRecord class. Java public NFRecord(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer that contains packed NFRecord. Bitwise combination of zero or more flags that controls behavior of the constructor. The following flags are supported: FlagSkipBlockedOrients, FlagSkipCurvatures, FlagSkipGs, FlagSkipQualities, FlagSkipRidgeCounts, FlagSkipSingularPoints.
8.1.1.1.18.1.3 NFRecord.NFRecord Constructor (boolean, short, short, short, short)

Initializes a new instance of the NFRecord class. Java public NFRecord(boolean isPalm, short width, short height, short horzResolution, short vertResolution); Parameters Parameters boolean isPalm short width short height short horzResolution short vertResolution Description Indicates that NFRecord was created for palmprints. The fingerprint image width. The fingerprint image height. Horizontal resolution in pixels per inch of fingerprint image. Vertical resolution in pixels per inch of fingerprint image.
8.1.1.1.18.1.4 NFRecord.NFRecord Constructor (boolean, short, short, short, short, int)

Initializes a new instance of the NFRecord class. 113
public NFRecord(boolean isPalm, short width, short height, short horzResolution, short vertResolution, int flags); Parameters Parameters boolean isPalm short width short height short horzResolution short vertResolution int flags Description Indicates that NFRecord was created for palmprints. The fingerprint image width. The fingerprint image height. Horizontal resolution in pixels per inch of fingerprint image. Vertical resolution in pixels per inch of fingerprint image. Bitwise combination of zero or more flags that controls behavior of the constructor.
8.1.1.1.18.1.5 NFRecord.NFRecord Constructor (short, short, short, short)

Initializes a new instance of the NFRecord class. Java public NFRecord(short width, short height, short horzResolution, short vertResolution); Parameters Parameters short width short height short horzResolution short vertResolution Description The fingerprint image width. The fingerprint image height. Horizontal resolution in pixels per inch of fingerprint image. Vertical resolution in pixels per inch of fingerprint image.
8.1.1.1.18.1.6 NFRecord.NFRecord Constructor (short, short, short, short, int)

Initializes a new instance of the NFRecord class. Java public NFRecord(short width, short height, short horzResolution, short vertResolution, int flags); Parameters Parameters short width short height short horzResolution short vertResolution int flags Description The fingerprint image width. The fingerprint image height. Horizontal resolution in pixels per inch of fingerprint image. Vertical resolution in pixels per inch of fingerprint image. Bitwise combination of zero or more flags that controls behavior of the constructor. The following flags are supported: FlagSkipBlockedOrients FlagSkipCurvatures FlagSkipGs FlagSkipQualities FlagSkipRidgeCounts FlagSkipSingularPoints.
8 8.1.1.1.18.2 NFRecord Classes

114
8.1 Java Reference
8.1.1.1.18.2.1 NFRecord.CoreCollection Class

Represents the collection of NFCore ( Java public final class CoreCollection extends NStructureCollection<NFCore, NFCoreData>; File NFRecord.java see page 85).
8.1.1.1.18.2.2 NFRecord.DeltaCollection Class

Represents the collection of NFDelta ( Java public final class DeltaCollection extends NStructureCollection<NFDelta, NFDeltaData>; File NFRecord.java see page 87).
8.1.1.1.18.2.3 NFRecord.DoubleCoreCollection Class

Represents the collection of NFDoubleCore ( Java public final class DoubleCoreCollection extends NStructureCollection<NFDoubleCore, NFDoubleCoreData>; File NFRecord.java see page 90).
8.1.1.1.18.2.4 NFRecord.MinutiaCollection Class

Represents the collection of NFMinutia ( Java public final class MinutiaCollection extends NStructureCollection<NFMinutia, NFMinutiaData>; File NFRecord.java see page 106).
8.1.1.1.18.2.5 NFRecord.MinutiaNeighborsCollection Class

Represents the collection of NFMinutiaNeighbor ( Java public final class MinutiaNeighborsCollection extends NStructureArrayCollection<NFMinutiaNeighbor, NFMinutiaNeighborData, NFMinutia>; File NFRecord.java see page 110).
8.1.1.1.18.2.6 NFRecord.PossiblePositionCollection Class

Represent collection of possible positions. Java public final class PossiblePositionCollection extends NEnumCollection<NFPosition>; File NFRecord.java 115
8.1 Java Reference
8.1.1.1.18.3 NFRecord Fields

8.1.1.1.18.3.1 NFRecord.FLAG_ALLOW_OUT_OF_BOUNDS_FEATURES Field
The flag indicating whether NFRecord ( Java public static final int FLAG_ALLOW_OUT_OF_BOUNDS_FEATURES = 0x00080000; see page 110) shall allow features outside image dimensions.
8.1.1.1.18.3.2 NFRecord.FLAG_SAVE_BLOCKED_ORIENTS Field

The flag indicating whether blocked orientations should be packed in NFRecord ( Java public static final int FLAG_SAVE_BLOCKED_ORIENTS = 0x00040000; see page 110).
8.1.1.1.18.3.3 NFRecord.FLAG_SAVE_V1 Field

The flag indicating whether NFRecord ( Java public static final int FLAG_SAVE_V1 = 0x10000000; see page 110) should be saved using version 1 algorithm.


8.1.1.1.18.3.6 NFRecord.FLAG_SKIP_BLOCKED_ORIENTS Field

The flag indicating whether blocked orientations should be skipped while unpacking NFRecord ( Java public static final int FLAG_SKIP_BLOCKED_ORIENTS = 0x00040000; see page 110).
8.1.1.1.18.3.7 NFRecord.FLAG_SKIP_CURVATURES Field

The flag indicating whether minutiae curvatures should be skipped while unpacking or packing NFRecord ( Java public static final int FLAG_SKIP_CURVATURES = 0x00200000; see page 110).
8.1.1.1.18.3.8 NFRecord.FLAG_SKIP_GS Field

The flag indicating whether G field should be skipped while unpacking or packing NFRecord ( Java public static final int FLAG_SKIP_GS = 0x00400000; see page 110).
8.1.1.1.18.3.9 NFRecord.FLAG_SKIP_QUALITIES Field

The flag indicating whether minutiae qualities should be skipped while unpacking or packing NFRecord ( Java public static final int FLAG_SKIP_QUALITIES = 0x00100000; 116 see page 110).
8.1 Java Reference
8.1.1.1.18.3.10 NFRecord.FLAG_SKIP_RIDGE_COUNTS Field

The flag indicating whether ridge counts should be skipped while unpacking or packing NFRecord ( Java public static final int FLAG_SKIP_RIDGE_COUNTS = 0x00010000; see page 110).
8.1.1.1.18.3.11 NFRecord.FLAG_SKIP_SINGULAR_POINTS Field

The flag indicating whether singular points (cores, deltas and double cores) should be skipped while unpacking or packing NFRecord ( see page 110). Java public static final int FLAG_SKIP_SINGULAR_POINTS = 0x00020000;
8.1.1.1.18.3.12 NFRecord.MAX_FINGER_CORE_COUNT Field

The maximum number of cores a NFRecord ( Java public static final int MAX_FINGER_CORE_COUNT = 15; see page 110) can contain.
8.1.1.1.18.3.13 NFRecord.MAX_FINGER_DELTA_COUNT Field

The maximum number of deltas a NFRecord ( Java public static final int MAX_FINGER_DELTA_COUNT = 15; see page 110) can contain.
8.1.1.1.18.3.14 NFRecord.MAX_FINGER_DIMENSION Field

The maximum number of finger dimension. Java public static final int MAX_FINGER_DIMENSION = 2047;
8.1.1.1.18.3.15 NFRecord.MAX_FINGER_DOUBLE_CORE_COUNT Field

The maximum number of double cores a NFRecord ( Java public static final int MAX_FINGER_DOUBLE_CORE_COUNT = 15; see page 110) can contain.
8.1.1.1.18.3.16 NFRecord.MAX_FINGER_MINUTIA_COUNT Field

The maximum number of finger minutiae a NFRecord ( Java public static final int MAX_FINGER_MINUTIA_COUNT = 255; see page 110) can contain.
8.1.1.1.18.3.17 NFRecord.MAX_PALM_CORE_COUNT Field

The maximum number of cores in a palmprint a NFRecord ( Java public static final int MAX_PALM_CORE_COUNT = 255; see page 110) can contain.
8.1.1.1.18.3.18 NFRecord.MAX_PALM_DELTA_COUNT Field

The maximum number of deltas in a palmprint a NFRecord ( Java public static final int MAX_PALM_DELTA_COUNT = 255; see page 110) can contain.
117
8.1 Java Reference
8.1.1.1.18.3.19 NFRecord.MAX_PALM_DIMENSION Field

The maximum number of a palmprint dimension. Java public static final int MAX_PALM_DIMENSION = 16383;
8.1.1.1.18.3.20 NFRecord.MAX_PALM_DOUBLE_CORE_COUNT Field

The maximum number of double cores in a palmprint a NFRecord ( Java public static final int MAX_PALM_DOUBLE_CORE_COUNT = 255; see page 110) can contain.
8.1.1.1.18.3.21 NFRecord.MAX_PALM_MINUTIA_COUNT Field

The maximum number of minutiae in a palmprint a NFRecord ( Java public static final int MAX_PALM_MINUTIA_COUNT = 65535; see page 110) can contain.
8.1.1.1.18.3.22 NFRecord.MAX_POSSIBLE_POSITION_COUNT Field

The maximum number of possible positions a NFRecord ( Java public static final int MAX_POSSIBLE_POSITION_COUNT = 255; see page 110) can contain.
8.1.1.1.18.3.23 NFRecord.RESOLUTION Field

The resolution of minutiae, cores, deltas and double cores coordinates in a NFRecord ( Java public static final int RESOLUTION = 500; see page 110).
8.1.1.1.18.4 NFRecord Methods

8.1.1.1.18.4.1 NFRecord.check Method
Checks if format of packed NFRecord ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing NFRecord ( see page 110) object. see page 110) is correct.
8.1.1.1.18.4.2 getCBEFFProductType Method 8.1.1.1.18.4.2.1 NFRecord.getCBEFFProductType Method ()

Gets the CBEFF product type of the NFRecord ( Java public final short getCBEFFProductType(); Returns The CBEFF product type. see page 110).
118
8.1 Java Reference
8.1.1.1.18.4.2.2 NFRecord.getCBEFFProductType Method (ByteBuffer)

Retrieves the CBEFF product type of the NFRecord ( Java public static short getCBEFFProductType(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The CBEFF product type. Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.3 NFRecord.getCores Method

Gets cores collection. Java public final CoreCollection getCores(); Returns A CoreCollection ( see page 115) that contains cores.
8.1.1.1.18.4.4 NFRecord.getDeltas Method

Gets deltas collection. Java public final DeltaCollection getDeltas(); Returns A DeltaCollection ( see page 115) that contains deltas.
8.1.1.1.18.4.5 NFRecord.getDoubleCores Method

Gets double cores collection. Java public final DoubleCoreCollection getDoubleCores(); Returns A DoubleCoreCollection ( see page 115) that contains double cores.
8.1.1.1.18.4.6 getG Method 8.1.1.1.18.4.6.1 NFRecord.getG Method ()

Gets additional fingerprint coefficient. G - average fingerprint ridge density. It can have values from 0 to 255, so it occupies one byte. Java public final short getG(); Returns additional fingerprint coefficient.
119
8.1 Java Reference
8.1.1.1.18.4.6.2 NFRecord.getG Method (ByteBuffer)

Retrieves G from packed NFRecord ( Java public static short getG(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The G from packed NFRecord ( occupies one byte. see page 110). G - average fingerprint ridge density. It can have values from 0 to 255, so it Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.7 getHeight Method 8.1.1.1.18.4.7.1 NFRecord.getHeight Method ()

Gets the height of fingerprint image. Java public final short getHeight(); Returns Height of fingerprint image.
8.1.1.1.18.4.7.2 NFRecord.getHeight Method (ByteBuffer)

Retrieves height of fingerprint image from packed NFRecord ( Java public static short getHeight(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The height of fingerprint image. Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.8 getHorzResolution Method 8.1.1.1.18.4.8.1 NFRecord.getHorzResolution Method ()

Gets horizontal resolution of fingerprint image. Java public final short getHorzResolution(); Returns Horizontal resolution in pixels per inch of fingerprint image.
8.1.1.1.18.4.8.2 NFRecord.getHorzResolution Method (ByteBuffer)

Retrieves horizontal resolution in pixels per inch of fingerprint image from packed NFRecord ( see page 110).
120
public static short getHorzResolution(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The horizontal resolution in pixels per inch of fingerprint image. Description ByteBuffer containing NFRecord ( see page 110) object.
8.1.1.1.18.4.9 getImpressionType Method 8.1.1.1.18.4.9.1 NFRecord.getImpressionType Method ()

Gets the impression type of the NFRecord ( Java public final NFImpressionType getImpressionType(); Returns One of the NFImpressionType values. The default is NFImpressionType.LiveScanPlain. see page 110).
8.1.1.1.18.4.9.2 NFRecord.getImpressionType Method (ByteBuffer)

Retrieves impression type from packed NFRecord ( Java public static NFImpressionType getImpressionType(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns A NFImpressionType enumeration member specifying impression type of fingerprint. Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.10 getMaxSize Method 8.1.1.1.18.4.10.1 NFRecord.getMaxSize Method (NFMinutiaFormat, int, NFRidgeCountsType, int, int, int)
Calculates the maximal NFRecord ( Java public static int getMaxSize(NFMinutiaFormat minutiaFormat, int minutiaCount, NFRidgeCountsType ridgeCountsType, int coreCount, int deltaCount, int doubleCoreCount); Parameters Parameters NFMinutiaFormat minutiaFormat int minutiaCount NFRidgeCountsType ridgeCountsType int coreCount int deltaCount int doubleCoreCount Returns The maximal NFRecord ( see page 110) size. The size depends on method parameters. 121 Description One of the NFMinutiaFormat values. The minutiae count. One of the NFRidgeCountsType values. The cores count. The deltas count. The double cores count. see page 110) size.
8.1 Java Reference
8.1.1.1.18.4.10.2 NFRecord.getMaxSize Method (int, boolean, NFMinutiaFormat, int, NFRidgeCountsType, int, int, int, int, int)
Calculates the maximal NFRecord ( Java public static int getMaxSize(int version, boolean isPalm, NFMinutiaFormat minutiaFormat, int minutiaCount, NFRidgeCountsType ridgeCountsType, int coreCount, int deltaCount, int doubleCoreCount, int boWidth, int boHeight); Parameters Parameters int version Description Specifies algorithm version used by this function. Can have these values: 0, 1, 2,3. The default value is 0 (in this case third version of algorithm will be used). Boolean value indicating the type of the NFRecord ( see page 110). If set to true, NFRecord ( see page 110) contains palmprint record. One of the NFMinutiaFormat values. The minutiae count. One of the NFRidgeCountsType values. The cores count. The deltas count. The double cores count. The width of blocked orientations. The height of blocked orientations. see page 110) size.
boolean isPalm
NFMinutiaFormat minutiaFormat int minutiaCount NFRidgeCountsType ridgeCountsType int coreCount int deltaCount int doubleCoreCount int boWidth int boHeight Returns The maximal NFRecord (
see page 110) size. The size depends on method parameters.
8.1.1.1.18.4.11 getMaxSizeV1 Method 8.1.1.1.18.4.11.1 NFRecord.getMaxSizeV1 Method (NFMinutiaFormat, int, int, int, int)
Calculates the maximal version 1.0 NFRecord ( Java public static int getMaxSizeV1(NFMinutiaFormat minutiaFormat, int minutiaCount, int coreCount, int deltaCount, int doubleCoreCount); Parameters Parameters NFMinutiaFormat minutiaFormat int minutiaCount int coreCount int deltaCount int doubleCoreCount Returns The maximal version 1.0 NFRecord ( see page 110) size. The size depends on method parameters. Description One of the NFMinutiaFormat values. The minutiae count. The cores count. The deltas count. The double cores count. see page 110) size.
8.1.1.1.18.4.11.2 NFRecord.getMaxSizeV1 Method (NFMinutiaFormat, int, int, int, int, int, int)
Calculates the maximal version 1.0 NFRecord ( see page 110) size.
122
public static int getMaxSizeV1(NFMinutiaFormat minutiaFormat, int minutiaCount, int coreCount, int deltaCount, int doubleCoreCount, int boWidth, int boHeight); Parameters Parameters NFMinutiaFormat minutiaFormat int minutiaCount int coreCount int deltaCount int doubleCoreCount int boWidth int boHeight Returns The maximal version 1.0 NFRecord ( see page 110) size. The size depends on method parameters. Description One of the NFMinutiaFormat values. The minutiae count. The cores count. The deltas count. The double cores count. The width of blocked orientations. The height of blocked orientations.
8.1.1.1.18.4.12 NFRecord.getMinutiae Method

Gets minutiae collection. Java public final MinutiaCollection getMinutiae(); Returns A MinutiaCollection ( see page 115) that contains minutiae.
8.1.1.1.18.4.13 NFRecord.getMinutiaeNeighbors Method

Gets minutia neighbors format from NFRecord ( Java public final MinutiaNeighborsCollection getMinutiaeNeighbors(); Returns A MinutiaNeighborsCollection ( see page 115) collection. see page 110).
8.1.1.1.18.4.14 NFRecord.getMinutiaFormat Method

Gets minutia format from NFRecord ( Java public final EnumSet<NFMinutiaFormat> getMinutiaFormat(); Returns One of the NFMinutiaFormat values. The default is NFMinutiaFormat.HasCurvature. see page 110).
8.1.1.1.18.4.15 getPatternClass Method 8.1.1.1.18.4.15.1 NFRecord.getPatternClass Method ()

Gets pattern class. This property gets NFPatternClass if NFPatternClass was set before getting. Java public final NFPatternClass getPatternClass(); Returns One of the NFPatternClass values. By default is NFPatternClass.Unknown. 123
8.1 Java Reference
8.1.1.1.18.4.15.2 NFRecord.getPatternClass Method (ByteBuffer)

Retrieves fingerprint pattern class from packed NFRecord ( 1. This function supports both NFRecord ( see page 110).
see page 110) version 1.0 and 2.0 formats.
Always returns NFPatternClass.Unknown for version 1.0 format. 2. This method returns NFPatternClass if NFPatternClass was set using PatternClass. Java public static NFPatternClass getPatternClass(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns One of the NFPatternClass values. Description ByteBuffer containing NFRecord ( see page 110) object.
8.1.1.1.18.4.16 getPosition Method 8.1.1.1.18.4.16.1 NFRecord.getPosition Method ()

Gets finger position. Java public final NFPosition getPosition(); Returns One of the NFPosition values. By default is NFPosition.Unknown.
8.1.1.1.18.4.16.2 NFRecord.getPosition Method (ByteBuffer)

Retrieves finger position from packed NFRecord ( Java public static NFPosition getPosition(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns One of the NFPosition values. Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.17 NFRecord.getPossiblePositions Method

Gets possible position collection. Java public final PossiblePositionCollection getPossiblePositions(); Returns A PossiblePositionCollection ( see page 115) that contains possible positions.
8.1.1.1.18.4.18 getQuality Method
124
8.1 Java Reference
8.1.1.1.18.4.18.1 NFRecord.getQuality Method ()

Gets fingerprint quality. Java public final short getQuality(); Returns Fingerprint quality.
8.1.1.1.18.4.18.2 NFRecord.getQuality Method (ByteBuffer)

Retrieves fingerprint quality from packed NFRecord ( Java public static short getQuality(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The value of fingerprint quality. Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.19 NFRecord.getRidgeCountsType Method

Gets ridge counts type. Java public final NFRidgeCountsType getRidgeCountsType(); Returns One of the NFRidgeCountsType values.
8.1.1.1.18.4.20 NFRecord.getSize Method

Gets the size of packed NFRecord ( Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of packed NFRecord ( see page 110). Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.21 getSizeV1 Method 8.1.1.1.18.4.21.1 NFRecord.getSizeV1 Method ()

Calculates version 1.0 packed size of NFRecord ( Java public final int getSizeV1(); Returns The packed size of NFRecord ( see page 110). 125 see page 110). Behavior is controlled through flags.
8.1 Java Reference
8.1.1.1.18.4.21.2 NFRecord.getSizeV1 Method (int)

Calculates version 1.0 packed size of NFRecord ( Java public final int getSizeV1(int flags); Parameters Parameters int flags Returns The packed size of NFRecord ( method. see page 110). For the list of flags that are supported see saveV1 ( see page 127)() Description Bitwise combination of zero or more flags that controls behavior of the method. see page 110). Behavior is controlled through flags.
8.1.1.1.18.4.22 getVertResolution Method 8.1.1.1.18.4.22.1 NFRecord.getVertResolution Method ()

Gets vertical resolution of fingerprint image. Java public final short getVertResolution(); Returns Vertical resolution in pixels per inch of fingerprint image.
8.1.1.1.18.4.22.2 NFRecord.getVertResolution Method (ByteBuffer)

Retrieves vertical resolution in pixels per inch of fingerprint image from packed NFRecord ( Java public static short getVertResolution(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The vertical resolution in pixels per inch of fingerprint image. Description ByteBuffer containing NFRecord ( see page 110) object. see page 110).
8.1.1.1.18.4.23 getWidth Method 8.1.1.1.18.4.23.1 NFRecord.getWidth Method ()

Gets width of fingerprint image. Java public final short getWidth(); Returns Width of fingerprint image.
8.1.1.1.18.4.23.2 NFRecord.getWidth Method (ByteBuffer)

Retrieves width of fingerprint image from packed NFRecord ( see page 110).
126
public static short getWidth(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The width of fingerprint image. Description ByteBuffer containing NFRecord ( see page 110) object.
8.1.1.1.18.4.24 NFRecord.nativeTypeOf Method

8.1.1.1.18.4.25 saveV1 Method 8.1.1.1.18.4.25.1 NFRecord.saveV1 Method ()

Packs NFRecord ( Java public final ByteBuffer saveV1(); Returns ByteBuffer containing saved NERecord ( see page 75). see page 110) to memory buffer in version 1.0 format.
8.1.1.1.18.4.25.2 NFRecord.saveV1 Method (ByteBuffer)

Packs NFRecord ( Java public final int saveV1(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Number of bytes written to the memory. Description ByteBuffer to which NERecord ( saved. see page 75) will be see page 110) to memory buffer in version 1.0 format.
8.1.1.1.18.4.25.3 NFRecord.saveV1 Method (ByteBuffer, int)

Packs NFRecord ( Java public final int saveV1(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer Description ByteBuffer to which NERecord ( saved. see page 75) will be see page 110) to memory buffer in version 1.0 format.
127
8.1 Java Reference int flags Returns Number of bytes written to the memory.
Bitwise combination of zero or more flags that controls behavior of the method.
8.1.1.1.18.4.25.4 NFRecord.saveV1 Method (int)

Packs NFRecord ( Java public final ByteBuffer saveV1(int flags); Parameters Parameters int flags Returns ByteBuffer containing saved NERecord ( see page 75). Description Bitwise combination of zero or more flags that controls behavior of the method. see page 110) to memory buffer in version 1.0 format.
8.1.1.1.18.4.26 NFRecord.setCBEFFProductType Method

Sets the CBEFF product type of the NFRecord ( Java public final void setCBEFFProductType(short type); Parameters Parameters short type Description CBEFF product type see page 110).
8.1.1.1.18.4.27 NFRecord.setG Method

Sets additional fingerprint coefficient. Java public final void setG(short value); Parameters Parameters short value Description Fingerprint coefficient.
8.1.1.1.18.4.28 NFRecord.setImpressionType Method

Sets the impression type of the NFRecord ( Java public final void setImpressionType(NFImpressionType type); Parameters Parameters NFImpressionType type Description impression type of the NFRecord ( see page 110). see page 110).
8.1.1.1.18.4.29 NFRecord.setMinutiaFormat Method

Sets minutia format from NFRecord ( see page 110).
128
public final void setMinutiaFormat(EnumSet<NFMinutiaFormat> format); Parameters Parameters EnumSet<NFMinutiaFormat> format Description minutia format from NFRecord ( see page 110).
8.1.1.1.18.4.30 NFRecord.setPatternClass Method

Sets pattern class. Java public final void setPatternClass(NFPatternClass type); Parameters Parameters NFPatternClass type Description impression type of the NFRecord ( see page 110).
8.1.1.1.18.4.31 NFRecord.setPosition Method

Sets finger position. Java public final void setPosition(NFPosition position); Parameters Parameters NFPosition position Description finger position.
8.1.1.1.18.4.32 NFRecord.setQuality Method

Sets fingerprint quality. Java public final void setQuality(short quality); Parameters Parameters short quality Description Fingerprint quality.
8.1.1.1.18.4.33 NFRecord.setRidgeCountsType Method

Sets ridge counts type. Java public final void setRidgeCountsType(NFRidgeCountsType value); Parameters Parameters NFRidgeCountsType value Description ridge counts type.
8.1.1.1.18.4.34 NFRecord.sortMinutiae Method

Sorts minutiae in NFRecord ( Java public final void sortMinutiae(NFMinutiaOrder order); see page 110) by the specified order.
129
8.1 Java Reference Parameters Parameters NFMinutiaOrder order
Description NFMinutiaOrder value.
8.1.1.1.18.4.35 NFRecord.truncateMinutiae Method

Truncates minutiae in NFRecord ( the specified maximal count. Java public final void truncateMinutiae(int maxCount); Parameters Parameters int maxCount Description Maximal minutia count to be present in the NFRecord ( page 110) after truncation. see see page 110) by peeling off the minutiae convex hull while minutia count is greater than
8.1.1.1.18.4.36 NFRecord.truncateMinutiaeByQuality Method

Truncates minutiae in NFRecord ( see page 110) by removing minutiae which NFMinutia ( see page 106). Quality field value is less than the specified threshold while minutia count is greater than the specified maximal count. Java public final void truncateMinutiaeByQuality(byte threshold, int maxCount); Parameters Parameters byte threshold int maxCount Description Specifies minimal NFMinutia.Quality field value of minutiae not to be removed. Maximal minutia count to be present in the NFRecord ( page 110) after truncation. see
8.1.1.1.19 NFTemplate Class

Provides functionality for packing, unpacking and editing Neurotechnology Fingers Templates (NFTemplates). Java public final class NFTemplate extends NObject implements Cloneable; File NFTemplate.java Methods Name NFTemplate ( NFTemplate Classes Name RecordCollection ( NFTemplate Fields Name MAX_RECORD_COUNT ( page 132) see Description The maximum number of finger records NFTemplate can contain. see page 132) Description Collection of NFRecords. see page 131) Description Initializes a new instance of the NFTemplate class.
PROCESS_FIRST_RECORD_ONLY The flag indicating whether only the first finger record should be ( see page 132) unpacked or packed while unpacking or packing NFTemplate.
130
8.1 Java Reference NFTemplate Methods Name calculateSize ( check (
Description see page 133) see page 133) Calculates NFTemplate size. Checks if memory buffer contains a valid NFTemplate object. Retrieves records count. Gets collection of records in the NFTemplate. Gets the size of packed NFTemplate. Checks if the NFTemplate contains palm records. Retrieves a function that retrieves NType object for the enclosing type. see page 133) see page 134)
getRecordCount ( getRecords ( getSize ( isPalm (
nativeTypeOf (
8.1.1.1.19.1 NFTemplate Constructor

8.1.1.1.19.1.1 NFTemplate.NFTemplate Constructor ()
Initializes a new instance of the NFTemplate class. Java public NFTemplate();
8.1.1.1.19.1.2 NFTemplate.NFTemplate Constructor (ByteBuffer)

Initializes a new instance of the NFTemplate class. Java public NFTemplate(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer that contains packed NFTemplate.
8.1.1.1.19.1.3 NFTemplate.NFTemplate Constructor (ByteBuffer, int)

Initializes a new instance of the NFTemplate class. Java public NFTemplate(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer that contains packed NFTemplate. Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero.
8.1.1.1.19.1.4 NFTemplate.NFTemplate Constructor (boolean)

Initializes a new instance of the NFTemplate class. Java public NFTemplate(boolean isPalm); Parameters Parameters boolean isPalm Description Boolean value indicating the type of NFTemplate. If set to true, NFTemplate contains palmprint record. If set to false, NFTemplate contains fingerprint record.
131
8.1 Java Reference
8.1.1.1.19.1.5 NFTemplate.NFTemplate Constructor (boolean, int)

Initializes a new instance of the NFTemplate class. Java public NFTemplate(boolean isPalm, int flags); Parameters Parameters boolean isPalm int flags Description Boolean value indicating the type of NFTemplate. Bitwise combination of zero or more flags that controls behavior of the constructor. If set to true, NFTemplate contains palmprint record. If set to false, NFTemplate contains fingerprint record.
8.1.1.1.19.1.6 NFTemplate.NFTemplate Constructor (int)

Initializes a new instance of the NFTemplate class. The following flags are supported: FlagProcessFirstRecordOnlyFlagSkipBlockedOrientsFlagSkipCurvaturesFlagSkipGsFlagSkipQualitiesFlagSkipRidgeCounts FlagSkipSingularPointsare applied to each finger record contained in the NFTemplate. Java public NFTemplate(int flags); Parameters Parameters int flags Description Bitwise combination of zero or more flags that controls behavior of the constructor.
8.1.1.1.19.2 NFTemplate Classes

8.1.1.1.19.2.1 NFTemplate.RecordCollection Class
Collection of NFRecords. Java public final class RecordCollection extends NObjectCollection<NFRecord>; File NFTemplate.java
8.1.1.1.19.3 NFTemplate Fields

8.1.1.1.19.3.1 NFTemplate.MAX_RECORD_COUNT Field
The maximum number of finger records NFTemplate ( Java public static final int MAX_RECORD_COUNT = 255; see page 130) can contain.
8.1.1.1.19.3.2 NFTemplate.PROCESS_FIRST_RECORD_ONLY Field

The flag indicating whether only the first finger record should be unpacked or packed while unpacking or packing NFTemplate ( see page 130).
132
public static final int PROCESS_FIRST_RECORD_ONLY = 0x00000100;
8.1.1.1.19.4 NFTemplate Methods

8.1.1.1.19.4.1 calculateSize Method 8.1.1.1.19.4.1.1 NFTemplate.calculateSize Method (boolean, int[])
Calculates NFTemplate ( Java public static int calculateSize(boolean isPalm, int[] recordSizes); Parameters Parameters boolean isPalm int[] recordSizes Returns Calculated size in bytes. Description Indicates if the record contains palms. An array that contains NFRecords sizes. see page 130) size.
8.1.1.1.19.4.1.2 NFTemplate.calculateSize Method (int[])

Calculates NFTemplate ( Java public static int calculateSize(int[] recordSizes); Parameters Parameters int[] recordSizes Returns Calculated size in bytes. Description An array that contains NFRecords sizes. see page 130) size.
8.1.1.1.19.4.2 NFTemplate.check Method

Checks if memory buffer contains a valid NFTemplate ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing a NFTemplate ( see page 130). see page 130) object.
8.1.1.1.19.4.3 NFTemplate.getRecordCount Method

Retrieves records count. Java public static int getRecordCount(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer that contains packed NFTemplate ( 130). see page
133
8.1 Java Reference Returns Records count.
8.1.1.1.19.4.4 NFTemplate.getRecords Method

Gets collection of records in the NFTemplate ( Java public RecordCollection getRecords(); Returns A RecordCollection ( see page 132) collection. see page 130).
8.1.1.1.19.4.5 NFTemplate.getSize Method

Gets the size of packed NFTemplate ( Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of NFTemplate ( see page 130). Description ByteBuffer that contains packed NFTemplate ( 130). see page see page 130).
8.1.1.1.19.4.6 isPalm Method 8.1.1.1.19.4.6.1 NFTemplate.isPalm Method ()

Checks if the NFTemplate ( Java public boolean isPalm(); Returns true if NFTemplate ( false . see page 130) contains palm records; otherwise, see page 130) contains palm records.
8.1.1.1.19.4.6.2 NFTemplate.isPalm Method (ByteBuffer)

Checks if the NFTemplate ( Java public static boolean isPalm(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns true if the NFTemplate ( see page 130) contains palm records; otherwise, false. 134 Description ByteBuffer that contains packed NFTemplate ( 130). see page see page 130) contains packed palm records.
8.1 Java Reference
8.1.1.1.19.4.7 NFTemplate.nativeTypeOf Method

8.1.1.1.20 NLAttributes Class

Provides methods to retrieve face attributes (metadata which is not saved in face template). Java public class NLAttributes extends NBiometricAttributes; File NLAttributes.java Methods NLAttributes Class Name NLAttributes ( see page 135) Description Creates new instance of NLAttributes.
NBiometricAttributes Methods Name getBiometricType ( getQuality ( getStatus ( setQuality ( setStatus ( NLAttributes Class Name nativeTypeOf ( see page 135) Description Retrieves a function that retrieves NType object for the enclosing type. see page 61) see page 62) see page 62) see page 62) see page 62) see page 62) Description Gets the biometric type enumeration for the current object. Gets quality of the current object. Gets the biometric status of the current object. Retrieves a function that retrieves NType object for the enclosing type. Sets quality of the current object. Sets the biometric status of the current object.
nativeTypeOf (
8.1.1.1.20.1 NLAttributes.NLAttributes Constructor

Creates new instance of NLAttributes. Java public NLAttributes();
8.1.1.1.20.2 NLAttributes Methods

8.1.1.1.20.2.1 NLAttributes.nativeTypeOf Method
Retrieves a function that retrieves NType object for the enclosing type. Java public static NType nativeTypeOf(); Returns The function that retrieves NType object for the enclosing type. 135
8.1 Java Reference
8.1.1.1.21 NLEDetectionDetails Class

Structure containing face detection results. Java public final class NLEDetectionDetails implements Serializable; File NLEDetectionDetails.java Methods Name NLEDetectionDetails ( 137) NLEDetectionDetails Fields Name expression ( see page 137) see page expressionConfidence ( 137) faceAvailable ( gender ( see page 137) see page Description Gets or sets the facial expression. Gets or sets the expression ( see page 137) confidence. see page Description Creates new NLEDetectionDetails object.
see page 137)
Gets or sets a boolean value determining if face was found. Gets or sets the gender. see page 137) confidence. Gets or sets the glasses confidence. Defines the number of points. Gets or sets the face properties. Reserved for future or internal use. Reserved for future or internal use. Reserved for future or internal use. Reserved for future or internal use. Reserved for future or internal use. Reserved for future or internal use. Reserved for future or internal use. Reserved for future or internal use. Reserved for future or internal use.
genderConfidence ( glassesConfidence ( 137) POINT_COUNT ( properties (
see page 137) Gets or sets the gender (
see page 137) see page see page see page see page see page see page see page see page see page
see page 138)
reservedConfidence1 ( 138) reservedConfidence2 ( 138) reservedConfidence3 ( 138) reservedConfidence4 ( 138) reservedConfidence5 ( 138) reservedConfidence6 ( 138) reservedConfidence7 ( 138) reservedConfidence8 ( 138) reservedConfidence9 ( 138) NLEDetectionDetails Methods Name getFace (
Description see page 139) see page 139) Gets information of the found face. Retrieves the posisition of the mouth center. Retrieves the position of the nose tip. Gets the feature points. Reserved for future/internal use. 136 see page 139) Retrieves the position of the right eye's center.
getLeftEyeCenter ( getMouthCenter ( getNoseTip ( getPoints (
getReserved1 (
8.1 Java Reference getReserved2 ( getReserved3 ( getReserved4 (
Reserved for future/internal use. Reserved for future/internal use. Reserved for future/internal use. Retrieves the position of the right eye's center.
getRightEyeCenter ( 140)
8.1.1.1.21.1 NLEDetectionDetails.NLEDetectionDetails Constructor

Creates new NLEDetectionDetails object. Java public NLEDetectionDetails();
8.1.1.1.21.2 NLEDetectionDetails Fields

8.1.1.1.21.2.1 NLEDetectionDetails.expression Field
Gets or sets the facial expression. Java public NLExpression expression;
8.1.1.1.21.2.2 NLEDetectionDetails.expressionConfidence Field

Gets or sets the expression ( Java public byte expressionConfidence; see page 137) confidence.
8.1.1.1.21.2.3 NLEDetectionDetails.faceAvailable Field

Gets or sets a boolean value determining if face was found. Java public boolean faceAvailable;
8.1.1.1.21.2.4 NLEDetectionDetails.gender Field

Gets or sets the gender. Java public NGender gender;
8.1.1.1.21.2.5 NLEDetectionDetails.genderConfidence Field

Gets or sets the gender ( Java public byte genderConfidence; see page 137) confidence.
8.1.1.1.21.2.6 NLEDetectionDetails.glassesConfidence Field

Gets or sets the glasses confidence. Java public byte glassesConfidence;
8.1.1.1.21.2.7 NLEDetectionDetails.POINT_COUNT Field

Defines the number of points. Java public static int POINT_COUNT = 68; 137
8.1 Java Reference
8.1.1.1.21.2.8 NLEDetectionDetails.properties Field

Gets or sets the face properties. Java public EnumSet<NLProperty> properties;
8.1.1.1.21.2.9 NLEDetectionDetails.reservedConfidence1 Field

Reserved for future or internal use. Java public byte reservedConfidence1;








Reserved for future or internal use. 138
public byte reservedConfidence9;
8.1.1.1.21.3 NLEDetectionDetails Methods

8.1.1.1.21.3.1 NLEDetectionDetails.getFace Method
Gets information of the found face. Java public NLEFace getFace(); Returns A NLEFace ( see page 141) object.
8.1.1.1.21.3.2 NLEDetectionDetails.getLeftEyeCenter Method

Retrieves the position of the right eye's center. Java public NLFeaturePoint getLeftEyeCenter(); Returns leftEyeCenter The center of the left eye.
8.1.1.1.21.3.3 NLEDetectionDetails.getMouthCenter Method

Retrieves the posisition of the mouth center. Java public NLFeaturePoint getMouthCenter(); Returns mouthCenter The center of the mouth.
8.1.1.1.21.3.4 NLEDetectionDetails.getNoseTip Method

Retrieves the position of the nose tip. Java public NLFeaturePoint getNoseTip(); Returns noseTip The tip of the nose.
8.1.1.1.21.3.5 NLEDetectionDetails.getPoints Method

Gets the feature points. Java public NLFeaturePoint getPoints(); Returns NLFeaturePoint ( see page 161) array.
8.1.1.1.21.3.6 NLEDetectionDetails.getReserved1 Method

Reserved for future/internal use.
139
public NLFeaturePoint getReserved1();

Reserved for future/internal use. Java public NLFeaturePoint getReserved2();


8.1.1.1.21.3.10 NLEDetectionDetails.getRightEyeCenter Method

Retrieves the position of the right eye's center. Java public NLFeaturePoint getRightEyeCenter(); Returns rightEyeCenter The center of the right eye.
8.1.1.1.22 NLEEyes Class

Defines information of an eye pair. Java public final class NLEEyes; File NLEEyes.java Methods Name NLEEyes ( NLEEyes Fields Name firstConfidence ( see page 141) see page secondConfidence ( 141) NLEEyes Methods Name getFirst ( see page 141) see page 141) getSecond ( Description Gets first eye coordinates. Gets second eye coordinates. Description Double value which represents first eye coordinates confidence. Double value which represents second eye coordinates confidence. see page 141) Description Creates new NLEEyes object.
140
8.1 Java Reference
8.1.1.1.22.1 NLEEyes.NLEEyes Constructor

Creates new NLEEyes object. Java public NLEEyes();
8.1.1.1.22.2 NLEEyes Fields

8.1.1.1.22.2.1 NLEEyes.firstConfidence Field
Double value which represents first eye coordinates confidence. Java public double firstConfidence;
8.1.1.1.22.2.2 NLEEyes.secondConfidence Field

Double value which represents second eye coordinates confidence. Java public double secondConfidence;
8.1.1.1.22.3 NLEEyes Methods

8.1.1.1.22.3.1 NLEEyes.getFirst Method
Gets first eye coordinates. Java public Point getFirst(); Returns A Point object.
8.1.1.1.22.3.2 NLEEyes.getSecond Method

Gets second eye coordinates. Java public Point getSecond(); Returns A Point object.
8.1.1.1.23 NLEFace Class

Contains information of a face location in an image. Java public final class NLEFace; File NLEFace.java Methods Name NLEFace ( see page 142) Description Creates new NLEFace object.
141
8.1 Java Reference NLEFace Fields Name confidence ( NLEFace Methods Name getRotation ( see page 142)
Description Determines how confident the face region was found.
Description see page 142) Gets information on face rotation in the image.
8.1.1.1.23.1 NLEFace.NLEFace Constructor

Creates new NLEFace object. Java public NLEFace();
8.1.1.1.23.2 NLEFace Fields

8.1.1.1.23.2.1 NLEFace.confidence Field
Determines how confident the face region was found. Java public double confidence;
8.1.1.1.23.3 NLEFace Methods

8.1.1.1.23.3.1 NLEFace.getRotation Method
Gets information on face rotation in the image. Java public NLERotation getRotation(); Returns NleRotation object that represent rotation of the face in the image in degrees.
8.1.1.1.24 NLERotation Class

Contains information of a face rotation in an image as a deviation from frontal face in degrees. Java public final class NLERotation; File NLERotation.java Methods Name NLERotation ( NLERotation Fields Name pitch ( roll ( yaw ( see page 143) see page 143) see page 143) Description Face pitch angle in degrees. Face roll angle in degrees. Face yaw angle in degrees. see page 143) Description Creates a new NLERotation object.
142
8.1 Java Reference
8.1.1.1.24.1 NLERotation Constructor

8.1.1.1.24.1.1 NLERotation.NLERotation Constructor ()
Creates a new NLERotation object. Java public NLERotation();
8.1.1.1.24.1.2 NLERotation.NLERotation Constructor (short, short, short)

Creates new instance of NleRotation object. Java public NLERotation(short yaw, short pitch, short roll); Parameters Parameters short yaw short pitch short roll Description Face yaw ( Face pitch ( Face roll ( see page 143) angle in degrees. see page 143) angle in degrees. see page 143) angle in degrees.
8.1.1.1.24.2 NLERotation Fields

8.1.1.1.24.2.1 NLERotation.pitch Field
Face pitch angle in degrees. Java public short pitch;
8.1.1.1.24.2.2 NLERotation.roll Field

Face roll angle in degrees. Java public short roll;
8.1.1.1.24.2.3 NLERotation.yaw Field

Face yaw angle in degrees. Java public short yaw;
8.1.1.1.25 NLExtractor Class

Provides functionality for extracting Neurotechnology Face Records (NLRecord ( Java public final class NLExtractor extends NObject; File NLExtractor.java Methods Name NLExtractor ( see page 147) Description Initializes a new instance of NLExtractor. see page 163)) from face images.
143
8.1 Java Reference NLExtractor Classes Name ExtractResult ( NLExtractor Fields Name
Description see page 147) Face record extraction result.
Description Boolean value indicating whether all facial feature points should be detected. If the value is false, only centers of eyes or base facial features are detected, otherwise all supported facial feature points are detected. The default value is false. Identifier specifying whether base facial feature points should be detected during facial feature detection. Currently, base facial feature points are: center of right eye, center of left eye, nose tip and center of mouth. The default value is false. Boolean value indicating whether to use gender detection procedure. Boolean value indicating whether to use face detection procedure, which has a higher recall rate (but also a lower precision rate - more false detections). Specifies the threshold which is considered when looking for faces in an image. For each face candidate confidence parameter is calculated. With higher threshold value faces are selected more strictly by the face detection method. sets face detection scale count (identifier specifying number of scales in one octave when constructing scale space for face detection. Higher values mean slower face detection but higher recall rate). Values are in range [1..16]. The defaul value is Identifier specifying the threshold which is considered when extracting facial features from the image. With higher threshold better quality of face image is required to successfully extract ( see page 152) facial features. The value of this parameter can be in range [0..255]. The default value is 128.
PARAMETER_DETECT_ALL_FEATURE_POINTS ( see page 148)
PARAMETER_DETECT_BASE_FEATURE_POINTS ( see page 148)
PARAMETER_DETECT_GENDER (
PARAMETER_DETECT_MORE_FACES ( 149)
PARAMETER_FACE_CONFIDENCE_THRESHOLD ( see page 149)
PARAMETER_FACE_DETECTION_SCALE_COUNT ( see page 149)
PARAMETER_FACE_QUALITY_THRESHOLD ( page 149)
see
PARAMETER_FACE_ROLL_ANGLE_BASE ( 149)
see page Identifier specifying a base angle for faces roll angle in the image to search. Available values are these: -180; -90; 0; 90; 180. The default value is 0. Identifier is used to set extractor base angle to support mobile devices with orientation sensor. If set to true the largest face found in an image will be used for facial feature extraction instead of the one with the highest face confidence score. The default value is true. This threshold checks the gender of the captured face. The higher the value of this parameter, the more strictly the gender of the face is checked. The value of this parameter can be in range [0..100].
PARAMETER_FAVOR_LARGEST_FACE ( 149)
see page
PARAMETER_GENDER_CONFIDENCE_THRESHOLD ( see page 150)
144
8.1 Java Reference
PARAMETER_LIVENESS_THRESHOLD ( 150)
see page
This threshold checks if faces are extracted from a live image stream. The higher the value of this parameter, the more strictly the stream is checked if the face in it is real (for example if it's not forged by showing a photo of a person in front a camera). The value of this parameter can be in range [0..100]. The default value is 50. Identifier specifying maximum distance between eyes in face. Faces which have greater distance between eyes than this parameter, won't be returned by the face detection methods. Sets the maximum number of records an extraction method can return in one NLTemplate ( see page 167). The value of this parameter can be in range [2..16]. The default value is 5.
PARAMETER_MAX_IOD (
see page 150)
PARAMETER_MAX_RECORDS_PER_TEMPLATE ( see page 150)
PARAMETER_MAX_ROLL_ANGLE_DEVIATION ( page 150)
see
Identifier specifying the maximum roll angle deviation from frontal face in degrees. The value of this parameter can be in range [0..180]. The default value is 15.
PARAMETER_MAX_STREAM_DURATION_IN_FRAMES Sets the identifier specifying maximum number of ( see page 150) frames to use for extraction from stream. PARAMETER_MAX_YAW_ANGLE_DEVIATION ( page 150) PARAMETER_MIN_IOD ( see page 151) see Short value which represents maximum face yaw angle deviation value. Must be in range [0..180]. Default value is . Identifier specifying minimum distance between eyes in face. Faces which have smaller distance between eyes than this parameter, won't be returned by the face detection methods. Identifier specifying template size parameter. Parameter value can be one of the TemplateSize enumeration members. If set to true liveness check is performed while doing facial feature extraction from an image stream.
see page 151)
PARAMETER_USE_LIVENESS_CHECK ( 151) NLExtractor Methods Name compress ( detectFace ( detectFaces ( see page 151) see page 151) see page 152) see page
see page
Description Compresses the extracted template to a format suitable for storing the template. Method to detect a face in an image, that best fits the requirements for the face enrollment requirements. Method to detect all faces in a given image. Finds locations of facial feature points. Describes the extract method of the NLExtractor, which is used to extract face feature templates form the images. Ends extracting face features. Describes the extract ( see page 152) method of the NLExtractor, which is used to extract ( see page 152) face feature templates form the images. Extraction from an image set initialization method. Extracts feature template from the face with given detection details from an image. Method to produce a generalized face features template from a given set of templates of the same person face.
detectFacialFeatures ( 152) extract (
extractEnd ( extractNext (
extractStart (
extractUsingDetails ( 153) generalize (
see page 153)
145
8.1 Java Reference
getFaceConfidenceThreshold ( see page 153)
Gets the threshold which is considered when looking for faces in an image. For each face candidate confidence parameter is calculated. With higher threshold value faces are selected more strictly by the face detection method. Must be in range [0..100]. Gets face detection scale count (identifier specifying number of scales in one octave when constructing scale space for face detection. Higher values mean slower face detection but higher recall rate). Gets the threshold which is considered when extracting facial features from the image. With higher threshold better quality of face image is required to successfully extract ( see page 152) facial features.
getFaceDetectionScaleCount ( see page 154) getFaceQualityThreshold ( page 154) getFaceRollAngleBase ( 154) see
see page Gets or sets faces base roll angle in the image to search. That's a base angle which together with MaxRollAngleDeviation defines the interval of angles considered when looking for faces in an image. Must be in range [-180..180]. Gets the gender confidence treshold. Gets the liveness threshold which checks if faces are extracted from a live image stream. Gets maximum distance between eyes in face. Faces which have greater distance between eyes than this parameter, won't be returned by the face detection routines. Must be in range [10..10000]. Gets the maximum number of records an extraction method can return in one NLTemlate. see Gets maximum roll angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Gets identifier specifying maximum number of frames to use for extraction from stream. Gets maximum yaw angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Gets minimum distance between eyes in face. Faces which have smaller distance between eyes than this parameter, won't be returned by the face detection methods. Must be in range [10..10000]. Gets a template size. Gets a value indicating whether all facial feature points should be detected. Gets a value indicating whether base facial feature points should be detected. Checks whether the gender should be detected. Gets a value indicating whether face detection with higher recall should be used. Gets value indicating if the largest face will be used for facial features extraction. Gets a boolean value indicating whether to use liveness check. Retrieves a function that retrieves NType object for the enclosing type. Sets a value indicating whether all facial feature points should be detected. Sets a value indicating whether base facial feature points should be detected. Sets whether the gender should be detected. Sets a value indicating whether face detection with higher recall should be used. Sets the threshold which is considered when looking for faces in an image. For each face candidate confidence parameter is calculated. With higher threshold value faces are selected more strictly by the face detection method. Must be in range [0..100]. see see
getGenderConfidenceThreshold ( see page 154) getLivenessThreshold ( 154) getMaxIod ( see page
see page 155)
getMaxRecordsPerTemplate ( see page 155) getMaxRollAngleDeviation ( page 155)
getMaxStreamDurationInFrames ( see page 155) getMaxYawAngleDeviation ( page 155) getMinIod ( see page 156) see
getTemplateSize (
see page 156)
isDetectAllFeaturePoints ( page 156)
isDetectBaseFeaturePoints ( page 156) isDetectGender ( isDetectMoreFaces ( 156) isFavorLargestFace ( 157) isUseLivenessCheck ( 157) nativeTypeOf (
see page 156) see page see page see page
see page 157) see
setDetectAllFeaturePoints ( page 157)
setDetectBaseFeaturePoints ( see page 157) setDetectGender ( see page 158) see page setDetectMoreFaces ( 158)
setFaceConfidenceThreshold ( see page 158)
146
8.1 Java Reference
setFaceDetectionScaleCount ( see page 158) setFaceQualityThreshold ( page 159) setFaceRollAngleBase ( 159) see
Sets face detection scale count (identifier specifying number of scales in one octave when constructing scale space for face detection. Higher values mean slower face detection but higher recall rate). Sets the threshold which is considered when extracting facial features from the image. With higher threshold better quality of face image is required to successfully extract ( see page 152) facial features.
see page Gets or sets faces base roll angle in the image to search. That's a base angle which together with MaxRollAngleDeviation defines the interval of angles considered when looking for faces in an image. Must be in range [-180..180]. see page Sets value indicating if the largest face will be used for facial features extraction. Sets the gender confidence treshold. Sets the liveness threshold which checks if faces are extracted from a live image stream. Sets maximum distance between eyes in face. Faces which have greater distance between eyes than this parameter, won't be returned by the face detection routines. Must be in range [10..10000]. see Sets the maximum number of records an extraction method can return in one NLTemlate. see Sets maximum roll angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Sets identifier specifying maximum number of frames to use for extraction from stream. Sets maximum yaw angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Sets minimum distance between eyes in face. Faces which have smaller distance between eyes than this parameter, won't be returned by the face detection methods. Must be in range [10..10000]. Sets a template size. Sets a boolean value indicating whether to use liveness check.
setFavorLargestFace ( 159)
setGenderConfidenceThreshold ( see page 159) setLivenessThreshold ( 159) setMaxIod ( see page
see page 160)
setMaxRecordsPerTemplate ( page 160) setMaxRollAngleDeviation ( page 160)
setMaxStreamDurationInFrames ( see page 160) setMaxYawAngleDeviation ( page 161) setMinIod ( see page 161) see
setTemplateSize (
setUseLivenessCheck ( 161)
8.1.1.1.25.1 NLExtractor.NLExtractor Constructor

Initializes a new instance of NLExtractor. Java public NLExtractor();
8.1.1.1.25.2 NLExtractor Classes

8.1.1.1.25.2.1 NLExtractor.ExtractResult Class
Face record extraction result. Java public static final class ExtractResult; File NLExtractor.java ExtractResult Methods Name getBaseIndex ( see page 148) see page getDetectionDetails ( 148) Description Retrieves the base index of the template. Retrieves the detection details.
147
8.1 Java Reference getStatus ( see page 148)
Retrieves the status of the template. Retrieves the NLTemplate ( see page 167).
getTemplate (
see page 148)
8.1.1.1.25.2.1.1 ExtractResult Methods 8.1.1.1.25.2.1.1.1 NLExtractor.ExtractResult.getBaseIndex Method

Retrieves the base index of the template. Java public int getBaseIndex(); Returns The base index of the template.
8.1.1.1.25.2.1.1.2 NLExtractor.ExtractResult.getDetectionDetails Method

Retrieves the detection details. Java public NLEDetectionDetails getDetectionDetails(); Returns The detection details.
8.1.1.1.25.2.1.1.3 NLExtractor.ExtractResult.getStatus Method

Retrieves the status of the template. Java public NLEExtractionStatus getStatus(); Returns The status of the template.
8.1.1.1.25.2.1.1.4 NLExtractor.ExtractResult.getTemplate Method

Retrieves the NLTemplate ( Java public NLTemplate getTemplate(); Returns NLTemplate ( see page 167). see page 167).
8.1.1.1.25.3 NLExtractor Fields

8.1.1.1.25.3.1 NLExtractor.PARAMETER_DETECT_ALL_FEATURE_POINTS Field
Boolean value indicating whether all facial feature points should be detected. If the value is false, only centers of eyes or base facial features are detected, otherwise all supported facial feature points are detected. The default value is false. Java public static final int PARAMETER_DETECT_ALL_FEATURE_POINTS = 10250;
8.1.1.1.25.3.2 NLExtractor.PARAMETER_DETECT_BASE_FEATURE_POINTS Field

Identifier specifying whether base facial feature points should be detected during facial feature detection. Currently, base facial feature points are: center of right eye, center of left eye, nose tip and center of mouth. The default value is false. 148
public static final int PARAMETER_DETECT_BASE_FEATURE_POINTS = 10255;
8.1.1.1.25.3.3 NLExtractor.PARAMETER_DETECT_GENDER Field

Boolean value indicating whether to use gender detection procedure. Java public static final int PARAMETER_DETECT_GENDER = 10451; Remarks By enabling this parameter (setting to true) you can ask to estimate person's gender from the face during facial features template extraction. Gender will be estimated correct with higher confidence if the provided face image passes all face image quality checks and facial features template is created. Additionally, gender estimator works more accurate on near-frontal face images.
8.1.1.1.25.3.4 NLExtractor.PARAMETER_DETECT_MORE_FACES Field

Boolean value indicating whether to use face detection procedure, which has a higher recall rate (but also a lower precision rate - more false detections). Java public static final int PARAMETER_DETECT_MORE_FACES = 10110;
8.1.1.1.25.3.5 NLExtractor.PARAMETER_FACE_CONFIDENCE_THRESHOLD Field

Specifies the threshold which is considered when looking for faces in an image. For each face candidate confidence parameter is calculated. With higher threshold value faces are selected more strictly by the face detection method. Java public static final int PARAMETER_FACE_CONFIDENCE_THRESHOLD = 10103;
8.1.1.1.25.3.6 NLExtractor.PARAMETER_FACE_DETECTION_SCALE_COUNT Field

sets face detection scale count (identifier specifying number of scales in one octave when constructing scale space for face detection. Higher values mean slower face detection but higher recall rate). Values are in range [1..16]. The defaul value is Java public static final int PARAMETER_FACE_DETECTION_SCALE_COUNT = 10111;
8.1.1.1.25.3.7 NLExtractor.PARAMETER_FACE_QUALITY_THRESHOLD Field

Identifier specifying the threshold which is considered when extracting facial features from the image. With higher threshold better quality of face image is required to successfully extract ( see page 152) facial features. The value of this parameter can be in range [0..255]. The default value is 128. Java public static final int PARAMETER_FACE_QUALITY_THRESHOLD = 10350;
8.1.1.1.25.3.8 NLExtractor.PARAMETER_FACE_ROLL_ANGLE_BASE Field

Identifier specifying a base angle for faces roll angle in the image to search. Available values are these: -180; -90; 0; 90; 180. The default value is 0. Identifier is used to set extractor base angle to support mobile devices with orientation sensor. Java public static final int PARAMETER_FACE_ROLL_ANGLE_BASE = 10117;
8.1.1.1.25.3.9 NLExtractor.PARAMETER_FAVOR_LARGEST_FACE Field

If set to true the largest face found in an image will be used for facial feature extraction instead of the one with the highest face confidence score. The default value is true.
149
public static final int PARAMETER_FAVOR_LARGEST_FACE = 10104;
8.1.1.1.25.3.10 NLExtractor.PARAMETER_GENDER_CONFIDENCE_THRESHOLD Field

This threshold checks the gender of the captured face. The higher the value of this parameter, the more strictly the gender of the face is checked. The value of this parameter can be in range [0..100]. Java public static final int PARAMETER_GENDER_CONFIDENCE_THRESHOLD = 10452;
8.1.1.1.25.3.11 NLExtractor.PARAMETER_LIVENESS_THRESHOLD Field

This threshold checks if faces are extracted from a live image stream. The higher the value of this parameter, the more strictly the stream is checked if the face in it is real (for example if it's not forged by showing a photo of a person in front a camera). The value of this parameter can be in range [0..100]. The default value is 50. Java public static final int PARAMETER_LIVENESS_THRESHOLD = 10403;
8.1.1.1.25.3.12 NLExtractor.PARAMETER_MAX_IOD Field

Identifier specifying maximum distance between eyes in face. Faces which have greater distance between eyes than this parameter, won't be returned by the face detection methods. Java public static final int PARAMETER_MAX_IOD = 10102; Remarks If MinIod and/or MaxIod will be set very similar to the real distance between the eyes, it could cause to not so accurate results (of face detection). When the face is set MinIod and MaxIod the face could be found up to ~1.5 times bigger/smaller value it is set.
8.1.1.1.25.3.13 NLExtractor.PARAMETER_MAX_RECORDS_PER_TEMPLATE Field

Sets the maximum number of records an extraction method can return in one NLTemplate ( this parameter can be in range [2..16]. The default value is 5. Java public static final int PARAMETER_MAX_RECORDS_PER_TEMPLATE = 10408; see page 167). The value of
8.1.1.1.25.3.14 NLExtractor.PARAMETER_MAX_ROLL_ANGLE_DEVIATION Field

Identifier specifying the maximum roll angle deviation from frontal face in degrees. The value of this parameter can be in range [0..180]. The default value is 15. Java public static final int PARAMETER_MAX_ROLL_ANGLE_DEVIATION = 10105;
8.1.1.1.25.3.15 NLExtractor.PARAMETER_MAX_STREAM_DURATION_IN_FRAMES Field

Sets the identifier specifying maximum number of frames to use for extraction from stream. Java public static final int PARAMETER_MAX_STREAM_DURATION_IN_FRAMES = 10409;
8.1.1.1.25.3.16 NLExtractor.PARAMETER_MAX_YAW_ANGLE_DEVIATION Field

Short value which represents maximum face yaw angle deviation value. Must be in range [0..180]. Default value is . Java public static final int PARAMETER_MAX_YAW_ANGLE_DEVIATION = 10109; 150
8.1 Java Reference
8.1.1.1.25.3.17 NLExtractor.PARAMETER_MIN_IOD Field

Identifier specifying minimum distance between eyes in face. Faces which have smaller distance between eyes than this parameter, won't be returned by the face detection methods. Java public static final int PARAMETER_MIN_IOD = 10101; Remarks If MinIod and/or MaxIod will be set very similar to the real distance between the eyes, it could cause to not so accurate results (of face detection). When the face is set MinIod and MaxIod the face could be found up to ~1.5 times bigger/smaller value it is set.
8.1.1.1.25.3.18 NLExtractor.PARAMETER_TEMPLATE_SIZE Field

8.1.1.1.25.3.19 NLExtractor.PARAMETER_USE_LIVENESS_CHECK Field

If set to true liveness check is performed while doing facial feature extraction from an image stream. Java public static final int PARAMETER_USE_LIVENESS_CHECK = 10402;
8.1.1.1.25.4 NLExtractor Methods

8.1.1.1.25.4.1 NLExtractor.compress Method
Compresses the extracted template to a format suitable for storing the template. Java public static NLTemplate compress(NLTemplate template, NLETemplateSize compressedTemplateSize); Parameters Parameters NLTemplate template NLETemplateSize compressedTemplateSize Returns Compressed face feature template. Description Face feature template to be compressed. Compressed template size.
8.1.1.1.25.4.2 NLExtractor.detectFace Method

Method to detect a face in an image, that best fits the requirements for the face enrollment requirements. Java public NLEFace detectFace(NGrayscaleImage image); Parameters Parameters NGrayscaleImage image Returns NLEFace ( see page 141) structure with information about the found face. If face was not found in the image, returns null. Description Source image, in which to search for a face.
151
8.1 Java Reference
8.1.1.1.25.4.3 NLExtractor.detectFaces Method

Method to detect all faces in a given image. Java public NLEFace detectFaces(NGrayscaleImage image); Parameters Parameters NGrayscaleImage image Returns Returns an array of NLEFace ( found, returns zero-length array. see page 141) structures with information of faces found in the image. If no faces were Description Source image, in which to search for the faces.
8.1.1.1.25.4.4 NLExtractor.detectFacialFeatures Method

Finds locations of facial feature points. Java public NLEDetectionDetails detectFacialFeatures(NGrayscaleImage image, NLEFace face); Parameters Parameters NGrayscaleImage image NLEFace face Returns Face detection routine results. Description Source image, in which to search for the faces. NLEFace ( see page 141) bean with information about the face in the image.
8.1.1.1.25.4.5 NLExtractor.extract Method

Describes the extract method of the NLExtractor ( images. Java public ExtractResult extract(NGrayscaleImage image); Parameters Parameters NGrayscaleImage image Returns NLExtractorResult. Description Source image, from which the face features should be extracted. see page 143), which is used to extract face feature templates form the
8.1.1.1.25.4.6 NLExtractor.extractEnd Method

Ends extracting face features. Java public ExtractResult extractEnd(); Returns NLExtractorResult object.
152
8.1 Java Reference
8.1.1.1.25.4.7 NLExtractor.extractNext Method

Describes the extract ( see page 152) method of the NLExtractor ( 152) face feature templates form the images. Java public ExtractResult extractNext(NGrayscaleImage image); Parameters Parameters NGrayscaleImage image Returns NLExtractorResult. Description Source image, from which the face features should be extracted. see page 143), which is used to extract ( see page
8.1.1.1.25.4.8 NLExtractor.extractStart Method

Extraction from an image set initialization method. Java public void extractStart();
8.1.1.1.25.4.9 NLExtractor.extractUsingDetails Method

Extracts feature template from the face with given detection details from an image. Java public ExtractResult extractUsingDetails(NGrayscaleImage image, NLEDetectionDetails detectionDetails); Parameters Parameters NGrayscaleImage image NLEDetectionDetails detectionDetails Returns NLExtractorResult. Description Source image. Face detection results.
8.1.1.1.25.4.10 NLExtractor.generalize Method

Method to produce a generalized face features template from a given set of templates of the same person face. Java public ExtractResult generalize(NLTemplate[] templates); Parameters Parameters NLTemplate[] templates Returns NLExtractorResult. Description Array of templates to be generalized.
8.1.1.1.25.4.11 NLExtractor.getFaceConfidenceThreshold Method

Gets the threshold which is considered when looking for faces in an image. For each face candidate confidence parameter is calculated. With higher threshold value faces are selected more strictly by the face detection method. Must be in range [0..100].
153
public double getFaceConfidenceThreshold(); Returns Double value which represents face confidence threshold value.
8.1.1.1.25.4.12 NLExtractor.getFaceDetectionScaleCount Method

Gets face detection scale count (identifier specifying number of scales in one octave when constructing scale space for face detection. Higher values mean slower face detection but higher recall rate). Java public int getFaceDetectionScaleCount(); Returns Int value which represents face detection scale count (values are in range [1..16]).
8.1.1.1.25.4.13 NLExtractor.getFaceQualityThreshold Method

Gets the threshold which is considered when extracting facial features from the image. With higher threshold better quality of face image is required to successfully extract ( see page 152) facial features. Java public int getFaceQualityThreshold(); Returns Byte value which represents face quality threshold.
8.1.1.1.25.4.14 NLExtractor.getFaceRollAngleBase Method

Gets or sets faces base roll angle in the image to search. That's a base angle which together with MaxRollAngleDeviation defines the interval of angles considered when looking for faces in an image. Must be in range [-180..180]. Java public short getFaceRollAngleBase(); Returns Short value which represents face roll angle base.
8.1.1.1.25.4.15 NLExtractor.getGenderConfidenceThreshold Method

Gets the gender confidence treshold. Java public int getGenderConfidenceThreshold(); Returns Gender confidence treshold value.
8.1.1.1.25.4.16 NLExtractor.getLivenessThreshold Method

Gets the liveness threshold which checks if faces are extracted from a live image stream. Java public double getLivenessThreshold(); Returns Liveness threshold value.
154
8.1 Java Reference Remarks
The higher the value of this parameter, the more strictly the stream is checked if the face in it is real (for example if it's not forged by showing a photo of a person in front a camera). Notes The value can be in range [0..100]. The default value is 50.
8.1.1.1.25.4.17 NLExtractor.getMaxIod Method

Gets maximum distance between eyes in face. Faces which have greater distance between eyes than this parameter, won't be returned by the face detection routines. Must be in range [10..10000]. Java public int getMaxIod(); Returns Integer value which represents maximum Iod.
8.1.1.1.25.4.18 NLExtractor.getMaxRecordsPerTemplate Method

Gets the maximum number of records an extraction method can return in one NLTemlate. Java public int getMaxRecordsPerTemplate(); Returns Integer value which represents maximum number of record per template. The value can be in range [2..16]. The default value is 5.
8.1.1.1.25.4.19 NLExtractor.getMaxRollAngleDeviation Method

Gets maximum roll angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Java public short getMaxRollAngleDeviation(); Returns Short value which represents maximum face roll angle deviation value.
8.1.1.1.25.4.20 NLExtractor.getMaxStreamDurationInFrames Method

Gets identifier specifying maximum number of frames to use for extraction from stream. Java public int getMaxStreamDurationInFrames(); Returns Int value representing maximum stream duration in frames.
8.1.1.1.25.4.21 NLExtractor.getMaxYawAngleDeviation Method

Gets maximum yaw angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Java public short getMaxYawAngleDeviation();
155
Short value which represents maximum face yaw angle deviation value.
8.1.1.1.25.4.22 NLExtractor.getMinIod Method

Gets minimum distance between eyes in face. Faces which have smaller distance between eyes than this parameter, won't be returned by the face detection methods. Must be in range [10..10000]. Java public int getMinIod(); Returns Integer value which represents minimum Iod.
8.1.1.1.25.4.23 NLExtractor.getTemplateSize Method

Gets a template size. Java public NLETemplateSize getTemplateSize(); Returns One of the NleTemplateSize value.
8.1.1.1.25.4.24 NLExtractor.isDetectAllFeaturePoints Method

Gets a value indicating whether all facial feature points should be detected. Java public boolean isDetectAllFeaturePoints(); Returns Boolean value indicating whether all facial feature points should be detected. If the value is false, only centers of eyes or base facial features are detected, otherwise all supported facial feature points are detected.
8.1.1.1.25.4.25 NLExtractor.isDetectBaseFeaturePoints Method

Gets a value indicating whether base facial feature points should be detected. Java public boolean isDetectBaseFeaturePoints(); Returns Boolean value indicating whether all facial feature points should be detected. If the value is true, center of right eye, center of left eye, nose tip and center of mouth are detected.
8.1.1.1.25.4.26 NLExtractor.isDetectGender Method

Checks whether the gender should be detected. Java public boolean isDetectGender(); Returns true if the gender should be detected; else false.
8.1.1.1.25.4.27 NLExtractor.isDetectMoreFaces Method

Gets a value indicating whether face detection with higher recall should be used. 156
public boolean isDetectMoreFaces(); Returns Boolean value indicating whether to use face detection procedure, which has a higher recall rate (but also a lower precision rate - more false detections).
8.1.1.1.25.4.28 NLExtractor.isFavorLargestFace Method

Gets value indicating if the largest face will be used for facial features extraction. Java public boolean isFavorLargestFace(); Returns Boolean value indicating if the largest face should be used for facial features extraction. If set to true, the largest face found in an image will be used for facial feature extraction instead of the one with the highest ParameterFaceConfidenceThreshold score.
8.1.1.1.25.4.29 NLExtractor.isUseLivenessCheck Method

Gets a boolean value indicating whether to use liveness check. Java public boolean isUseLivenessCheck(); Returns Boolean value indicating whether to use liveness check. The property value is true if liveness check is performed while doing facial feature extraction from an image stream. Otherwise, the property value is false.
8.1.1.1.25.4.30 NLExtractor.nativeTypeOf Method

8.1.1.1.25.4.31 NLExtractor.setDetectAllFeaturePoints Method

Sets a value indicating whether all facial feature points should be detected. Java public void setDetectAllFeaturePoints(boolean value); Parameters Parameters boolean value Description Boolean value indicating whether all facial feature points should be detected. If the value is false, only centers of eyes or base facial features are detected, otherwise all supported facial feature points are detected.
8.1.1.1.25.4.32 NLExtractor.setDetectBaseFeaturePoints Method

Sets a value indicating whether base facial feature points should be detected.
157
public void setDetectBaseFeaturePoints(boolean value); Parameters Parameters boolean value Description Boolean value indicating whether all facial feature points should be detected. If the value is true, center of right eye, center of left eye, nose tip and center of mouth are detected.
8.1.1.1.25.4.33 NLExtractor.setDetectGender Method

Sets whether the gender should be detected. Java public void setDetectGender(boolean value); Parameters Parameters boolean value Description true if the gender should be detected; else false.
8.1.1.1.25.4.34 NLExtractor.setDetectMoreFaces Method

Sets a value indicating whether face detection with higher recall should be used. Java public void setDetectMoreFaces(boolean value); Parameters Parameters boolean value Description Boolean value indicating whether to use face detection procedure, which has a higher recall rate (but also a lower precision rate - more false detections).
8.1.1.1.25.4.35 NLExtractor.setFaceConfidenceThreshold Method

Sets the threshold which is considered when looking for faces in an image. For each face candidate confidence parameter is calculated. With higher threshold value faces are selected more strictly by the face detection method. Must be in range [0..100]. Java public void setFaceConfidenceThreshold(double value); Parameters Parameters double value Description Double value which represents face confidence threshold value.
8.1.1.1.25.4.36 NLExtractor.setFaceDetectionScaleCount Method

Sets face detection scale count (identifier specifying number of scales in one octave when constructing scale space for face detection. Higher values mean slower face detection but higher recall rate). Java public void setFaceDetectionScaleCount(int value); Parameters Parameters int value Description Int value which represents face detection scale count (values are in range [1..16]). 158
8.1 Java Reference
8.1.1.1.25.4.37 NLExtractor.setFaceQualityThreshold Method

Sets the threshold which is considered when extracting facial features from the image. With higher threshold better quality of face image is required to successfully extract ( see page 152) facial features. Java public void setFaceQualityThreshold(int value); Parameters Parameters int value Description int value which represents face quality threshold.
8.1.1.1.25.4.38 NLExtractor.setFaceRollAngleBase Method

Gets or sets faces base roll angle in the image to search. That's a base angle which together with MaxRollAngleDeviation defines the interval of angles considered when looking for faces in an image. Must be in range [-180..180]. Java public void setFaceRollAngleBase(short value); Parameters Parameters short value Description Short value which represents face roll angle base.
8.1.1.1.25.4.39 NLExtractor.setFavorLargestFace Method

Sets value indicating if the largest face will be used for facial features extraction. Java public void setFavorLargestFace(boolean value); Parameters Parameters boolean value Description Boolean value indicating if the largest face should be used for facial features extraction. If set to true, the largest face found in an image will be used for facial feature extraction instead of the one with the highest ParameterFaceConfidenceThreshold score.
8.1.1.1.25.4.40 NLExtractor.setGenderConfidenceThreshold Method

Sets the gender confidence treshold. Java public void setGenderConfidenceThreshold(int value); Parameters Parameters int value Description Gender confidence treshold.
8.1.1.1.25.4.41 NLExtractor.setLivenessThreshold Method

Sets the liveness threshold which checks if faces are extracted from a live image stream. Java public void setLivenessThreshold(double value);
159
8.1 Java Reference Parameters Parameters double value Remarks
Description Liveness threshold value.
The higher the value of this parameter, the more strictly the stream is checked if the face in it is real (for example if it's not forged by showing a photo of a person in front a camera). Notes The value can be in range [0..100]. The default value is 50.
8.1.1.1.25.4.42 NLExtractor.setMaxIod Method

Sets maximum distance between eyes in face. Faces which have greater distance between eyes than this parameter, won't be returned by the face detection routines. Must be in range [10..10000]. Java public void setMaxIod(int value); Parameters Parameters int value Description Integer value which represents maximum Iod.
8.1.1.1.25.4.43 NLExtractor.setMaxRecordsPerTemplate Method

Sets the maximum number of records an extraction method can return in one NLTemlate. Java public void setMaxRecordsPerTemplate(int value); Parameters Parameters int value Description Integer value which represents maximum number of record per template. The value can be in range [1..16]. The default value is 4.
8.1.1.1.25.4.44 NLExtractor.setMaxRollAngleDeviation Method

Sets maximum roll angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Java public void setMaxRollAngleDeviation(short value); Parameters Parameters short value Description Short value which represents maximum face roll angle deviation value.
8.1.1.1.25.4.45 NLExtractor.setMaxStreamDurationInFrames Method

Sets identifier specifying maximum number of frames to use for extraction from stream. Java public void setMaxStreamDurationInFrames(int value);
160
Description Int value representing maximum stream duration in frames.
8.1.1.1.25.4.46 NLExtractor.setMaxYawAngleDeviation Method

Sets maximum yaw angle deviation from frontal face in degrees which is considered when looking for faces in an image. Must be in range [0..180]. Java public void setMaxYawAngleDeviation(short value); Parameters Parameters short value Description Short value which represents maximum face yaw angle deviation value.
8.1.1.1.25.4.47 NLExtractor.setMinIod Method

Sets minimum distance between eyes in face. Faces which have smaller distance between eyes than this parameter, won't be returned by the face detection methods. Must be in range [10..10000]. Java public void setMinIod(int value); Parameters Parameters int value Description Integer value which represents minimum Iod.
8.1.1.1.25.4.48 NLExtractor.setTemplateSize Method

Sets a template size. Java public void setTemplateSize(NLETemplateSize value); Parameters Parameters NLETemplateSize value Description [in] Defines size of template. Can be used small, compact, medium or large template.
8.1.1.1.25.4.49 NLExtractor.setUseLivenessCheck Method

Sets a boolean value indicating whether to use liveness check. Java public void setUseLivenessCheck(boolean value); Parameters Parameters boolean value Description Boolean value indicating whether to use liveness check. The property value is true if liveness check is performed while doing facial feature extraction from an image stream. Otherwise, the property value is false.
8.1.1.1.26 NLFeaturePoint Class

Provides functionality to retrieve face templates feature points. 161
public final class NLFeaturePoint; File NLFeaturePoint.java Methods Name NLFeaturePoint ( NLFeaturePoint Fields Name code ( x( y( see page 163) see page 163) confidence ( Description Feature point code. Feature point confidence. X-coordinate of the feature point. Y-coordinate of the feature point. see page 162) Description Initializes a new instance of NLFeaturePoint class.
8.1.1.1.26.1 NLFeaturePoint Constructor

8.1.1.1.26.1.1 NLFeaturePoint.NLFeaturePoint Constructor ()
Initializes a new instance of NLFeaturePoint class. Java public NLFeaturePoint();
8.1.1.1.26.1.2 NLFeaturePoint.NLFeaturePoint Constructor (short, short, short)

Initializes a new instance of NLFeaturePoint class. Java public NLFeaturePoint(short code, short x, short y); Parameters Parameters short code short x short y Description Feature point code ( see page 163). X-coordinate of the feature point. Y-coordinate of the feature point.
8.1.1.1.26.1.3 NLFeaturePoint.NLFeaturePoint Constructor (short, short, short, byte)

Initializes a new instance of NLFeaturePoint class. Java public NLFeaturePoint(short code, short x, short y, byte confidence); Parameters Parameters short code short x short y byte confidence Description Feature point code ( see page 163). X-coordinate of the feature point. Y-coordinate of the feature point. Feature point confidence ( see page 163).
8.1.1.1.26.2 NLFeaturePoint Fields
162
8.1 Java Reference
8.1.1.1.26.2.1 NLFeaturePoint.code Field

Feature point code. Java public short code;
8.1.1.1.26.2.2 NLFeaturePoint.confidence Field

Feature point confidence. Java public byte confidence;
8.1.1.1.26.2.3 NLFeaturePoint.x Field

X-coordinate of the feature point. Java public short x;
8.1.1.1.26.2.4 NLFeaturePoint.y Field

Y-coordinate of the feature point. Java public short y;
8.1.1.1.27 NLMatchingDetails Class

Provides functionality to retrieve face templates matching details. Java public final class NLMatchingDetails extends NXMatchingDetails; File NLMatchingDetails.java NLMatchingDetails Methods Name nativeTypeOf ( see page 163) Description Retrieves a function that retrieves NType object for the enclosing type.
8.1.1.1.27.1 NLMatchingDetails Methods

8.1.1.1.27.1.1 NLMatchingDetails.nativeTypeOf Method
8.1.1.1.28 NLRecord Class

Provides functionality for packing, unpacking and editing Neurotechnology Face Records (NLRecords). Java public class NLRecord extends NObject implements Cloneable; 163
8.1 Java Reference File NLRecord.java Methods Name NLRecord ( NLRecord Methods Name check ( see page 165) getCBEFFProductType ( page 165) getQuality ( getSize ( see page 166) see page 164)
Description Initializes a new instance of the NLRecord class.
Description Checks if format of packed NLRecord is correct. see Gets the CBEFF product type of the NLRecord. Gets face quality. Gets the size of packed NLRecord. Retrieves a function that retrieves NType object for the enclosing type. Sets the CBEFF product type of the NLRecord. Sets face quality. see
nativeTypeOf (
setCBEFFProductType ( page 166) setQuality (
see page 167)
8.1.1.1.28.1 NLRecord Constructor

8.1.1.1.28.1.1 NLRecord.NLRecord Constructor ()
Initializes a new instance of the NLRecord class. Java public NLRecord();
8.1.1.1.28.1.2 NLRecord.NLRecord Constructor (ByteBuffer)

Initializes a new instance of the NLRecord class. Java public NLRecord(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer that contains packed NLRecord.
8.1.1.1.28.1.3 NLRecord.NLRecord Constructor (ByteBuffer, int)

Initializes a new instance of the NLRecord class. Java public NLRecord(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer that contains packed NLRecord. Bitwise combination of zero or more flags that controls behavior of the constructor. The following flags are supported: FlagSkipBlockedOrients, FlagSkipCurvatures, FlagSkipGs, FlagSkipQualities, FlagSkipRidgeCounts, FlagSkipSingularPoints.
164
8.1 Java Reference
8.1.1.1.28.1.4 NLRecord.NLRecord Constructor (int)

Initializes a new instance of the NLRecord class. Java public NLRecord(int flags); Parameters Parameters int flags Description Bitwise combination of zero or more flags that controls behavior of the constructor. Exclusive-OR is performed when few flags needed. The following flags are supported: FlagSkipBlockedOrients FlagSkipCurvatures FlagSkipGs FlagSkipQualities FlagSkipRidgeCounts FlagSkipSingularPoints.
8.1.1.1.28.2 NLRecord Methods

8.1.1.1.28.2.1 NLRecord.check Method
Checks if format of packed NLRecord ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing NLRecord ( see page 163) object. see page 163) is correct.
8.1.1.1.28.2.2 getCBEFFProductType Method 8.1.1.1.28.2.2.1 NLRecord.getCBEFFProductType Method ()

Gets the CBEFF product type of the NLRecord ( Java public final short getCBEFFProductType(); Returns The CBEFF product type. see page 163).
8.1.1.1.28.2.2.2 NLRecord.getCBEFFProductType Method (ByteBuffer)

Retrieves Cbeff product type of the NLRecord ( Java public static short getCBEFFProductType(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing NLRecord ( see page 163) object. see page 163).
165
8.1 Java Reference Returns TThe Cbeff product type.
8.1.1.1.28.2.3 getQuality Method 8.1.1.1.28.2.3.1 NLRecord.getQuality Method ()

Gets face quality. Java public final short getQuality(); Returns Face quality.
8.1.1.1.28.2.3.2 NLRecord.getQuality Method (ByteBuffer)

Retrieves face quality from packed NLRecord ( Java public static short getQuality(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The value of face quality. Description ByteBuffer containing NLRecord ( see page 163) object. see page 163).
8.1.1.1.28.2.4 NLRecord.getSize Method

Gets the size of packed NLRecord ( Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of specified memory buffer. Description ByteBuffer containing NLRecord ( see page 163) object. see page 163).
8.1.1.1.28.2.5 NLRecord.nativeTypeOf Method

8.1.1.1.28.2.6 NLRecord.setCBEFFProductType Method

Sets the CBEFF product type of the NLRecord ( see page 163).
166
public final void setCBEFFProductType(short type); Parameters Parameters short type Description CBEFF product type
8.1.1.1.28.2.7 NLRecord.setQuality Method

Sets face quality. Java public final void setQuality(short quality); Parameters Parameters short quality Description A face quality.
8.1.1.1.29 NLTemplate Class

Provides functionality for packing, unpacking and editing Neurotechnology Faces Templates (NLTemplates). Java public final class NLTemplate extends NObject implements Cloneable; File NLTemplate.java Methods Name NLTemplate ( NLTemplate Classes Name RecordCollection ( NLTemplate Fields Name MAX_RECORD_COUNT ( page 169) see Description The maximum number of face records NLTemplate can contain. see page 168) Description Collection of NLRecords. see page 168) Description Initializes a new instance of the NLTemplate class.
PROCESS_FIRST_RECORD_ONLY The flag indicating whether only the first face record should be ( see page 169) unpacked or packed while unpacking or packing NLTemplate. NLTemplate Methods Name calculateSize ( check ( see page 169) see page 169) see page 169) see page 169) see page 170) Description Calculates NLTemplate size. Checks if memory buffer contains a valid NLTemplate object. Retrieves records count. Gets collection of records in the NLTemplate. Retrieves the size of the NLTemplate Retrieves a function that retrieves NType object for the enclosing type.
getRecordCount ( getRecords ( getSize ( nativeTypeOf (
see page 170)
8.1.1.1.29.1 NLTemplate Constructor
167
8.1 Java Reference
8.1.1.1.29.1.1 NLTemplate.NLTemplate Constructor ()

Initializes a new instance of the NLTemplate class. Java public NLTemplate();
8.1.1.1.29.1.2 NLTemplate.NLTemplate Constructor (ByteBuffer)

Initializes a new instance of the NLTemplate class. Java public NLTemplate(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer that contains packed NLTemplate.
8.1.1.1.29.1.3 NLTemplate.NLTemplate Constructor (ByteBuffer, int)

Initializes a new instance of the NLTemplate class. Java public NLTemplate(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer that contains packed NLTemplate. Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero.
8.1.1.1.29.1.4 NLTemplate.NLTemplate Constructor (int)

Initializes a new instance of the NLTemplate class. Java public NLTemplate(int flags); Parameters Parameters int flags Description Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero.
8.1.1.1.29.2 NLTemplate Classes

8.1.1.1.29.2.1 NLTemplate.RecordCollection Class
Collection of NLRecords. Java public final class RecordCollection extends NObjectCollection<NLRecord>; File NLTemplate.java
8 8.1.1.1.29.3 NLTemplate Fields

168
8.1 Java Reference
8.1.1.1.29.3.1 NLTemplate.MAX_RECORD_COUNT Field

The maximum number of face records NLTemplate ( Java public static final int MAX_RECORD_COUNT = 255; see page 167) can contain.
8.1.1.1.29.3.2 NLTemplate.PROCESS_FIRST_RECORD_ONLY Field

The flag indicating whether only the first face record should be unpacked or packed while unpacking or packing NLTemplate ( see page 167). Java public static final int PROCESS_FIRST_RECORD_ONLY = 0x00000100;
8.1.1.1.29.4 NLTemplate Methods

8.1.1.1.29.4.1 NLTemplate.calculateSize Method
Calculates NLTemplate ( Java public static int calculateSize(int[] recordSizes); Parameters Parameters int[] recordSizes Returns A size of records. Description An array that contains NLRecords sizes. see page 167) size.
8.1.1.1.29.4.2 NLTemplate.check Method

Checks if memory buffer contains a valid NLTemplate ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing a NLTemplate ( see page 167). see page 167) object.
8.1.1.1.29.4.3 NLTemplate.getRecordCount Method

Retrieves records count. Java public static int getRecordCount(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Records count. Description ByteBuffer that contains packed NLTemplate ( 167). see page
8
8.1.1.1.29.4.4 NLTemplate.getRecords Method
Gets collection of records in the NLTemplate ( see page 167). 169
public RecordCollection getRecords(); Returns A RecordCollection ( see page 168) collection.
8.1.1.1.29.4.5 NLTemplate.getSize Method

Retrieves the size of the NLTemplate ( Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of NLTemplate ( see page 167). Description ByteBuffer containing a NLTemplate ( see page 167). see page 167)
8.1.1.1.29.4.6 NLTemplate.nativeTypeOf Method

8.1.1.1.30 NMatcher Class

Provides functionality for comparing all Neurotechnology Templates (NTemplates, NFTemplates, NFRecords, NLTemplates, NLRecords, NETemplates, NERecords), encapsulated in Neurotechnology Matcher (NMatcher) object. Java public final class NMatcher extends NObject; File NMatcher.java Methods Name NMatcher ( NMatcher Fields Name FINGERS_MODE_ATMEL_FINGER_CHIP ( FINGERS_MODE_AUTHENTEC_AES2501B ( FINGERS_MODE_AUTHENTEC_AES4000 ( FINGERS_MODE_AUTHENTEC_AFS2 ( see page 175) see page 175) see page 176) Description Represents Atmel Finger Chip scanner. Represents Authentec Aes 2501B scanner. Represents Authentec Aes 4000 scanner. Represents Authentec AFS2 scanner. Represents Biometrika FX2000 scanner. see page 175) Description Initializes a new instance of NMatcher.
FINGERS_MODE_BIOMETRIKA_FX2000 (
170
8.1 Java Reference
com.neurotec.biometrics Package Represents Biometrika FX3000 scanner. Represents Bmf Blp 100 scanner.
FINGERS_MODE_BIOMETRIKA_FX3000 ( FINGERS_MODE_BMF_BLP100 (
see page 176)
FINGERS_MODE_CROSS_MATCH_VERIFIER_300 ( 176) FINGERS_MODE_DIGENT_IZZIX ( see page 176) FINGERS_MODE_DIGITAL_PERSONA_U_ARE_U ( 176) FINGERS_MODE_ETHENTICA ( see page 176) see page 177) see page 177) FINGERS_MODE_FUJITSU_MBF200 ( FINGERS_MODE_FUTRONIC_FS80 ( FINGERS_MODE_GENERAL (
Represents Cross Match Verifier 300 scanner. Represents Digent Izzix scanner. Represents Digital Persona U are U scanner. Represents Ethentica scanner. Represents Fujitsu Mbf200 scanner. Represents Futronic FS80 scanner. Represents general scanner.
see page
see page 177) see
FINGERS_MODE_IDENTICATOR_TECHNOLOGY_DF90 ( page 177) FINGERS_MODE_IDENTIX_DFR2090 ( see page 177) FINGERS_MODE_IDENTIX_TOUCH_VIEW (
Represents Identicator Technology DF90 scanner. Represents Identix Dfr2090 scanner. Represents Identix TouchView scanner. Represents Keytronic Secure Desktop scanner. Represents Light Tuning LttC500 scanner. Represents Nitgen Fingkey Hamster scanner. Represents Precise Biometrics 100CS scanner. Represents Secugen Hamster scanner. Represents Startek FM200 scanner. Represents Tacoma Cmos scanner. Represents Testech Bio I scanner. Represents Upek Touch Chip scanner. Specifies face templates matching speed. Can be Low or High matching speed. Matters only if ParameterFusionType is SelectByFaceThenFuse(NMFusionType) set. Specifies whether full matching details are filled during the fingers matching. Specifies finger templates matching speed. Can be Low, Medium or High matching speed.
see page 177) see
FINGERS_MODE_KEYTRONIC_SECURE_DESKTOP ( page 177) FINGERS_MODE_LIGH_TUNING_LTTC500 (
see page 177) see page see page
FINGERS_MODE_NITGEN_FINGKEY_HAMSTER ( 177) FINGERS_MODE_PRECISE_BIOMETRICS_100CS ( 177) FINGERS_MODE_SECUGEN_HAMSTER ( FINGERS_MODE_STARTEK_FM200 ( FINGERS_MODE_TACOMA_CMOS ( FINGERS_MODE_TESTECH_BIO_I (
see page 178)
see page 178) see page 178) see page 178) see page 178) see page 178) see page
FINGERS_MODE_UPEK_TOUCH_CHIP (
PARAMETER_FACES_MATCHING_SPEED (
PARAMETER_FACES_MATCHING_THRESHOLD ( 178)
PARAMETER_FINGERS_FILL_FULL_MATCHING_DETAILS ( see page 178) PARAMETER_FINGERS_MATCHING_SPEED ( see page 179)
PARAMETER_FINGERS_MAXIMAL_ROTATION (
see page 179) Identifier specifying modulus of maximal rotation allowed between two matched NFRecords parameter of type N_TYPE_BYTE. Parameter value is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees). see page Identifier specifying minimal number of fingerprints from probe template to match parameter of type int. Parameter value is from zero to NFTemplate.MaxRecordCount. 171
PARAMETER_FINGERS_MIN_MATCHED_COUNT ( 179)
8.1 Java Reference
PARAMETER_FINGERS_MIN_MATCHED_COUNT_THRESHOLD Identifier specifying matching threshold ( see page 179) (biggest allowed FAR) when matching is stopped (with respect to Neurotec.Biometrics.NMatcher.Parameter FingersMinMatchedCount parameter value) parameter of type N_TYPE_INT. Parameter value is equal to -12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). PARAMETER_FINGERS_MODE ( see page 179) Parameter specifying fingers mode (parameter value set). Parameter value can be one of the FingersModeXXX. Identifier specifying fingerprints, irises and faces fusion of type int. Parameter value can be one of the NMFusionType enumeration members. Specifies iris templates matching speed. Can be Low, Medium or High matching speed. Matters only if ParameterFusionType is SelectByIrisThenFuse(NMFusionType) set. Defines the maximal rotation allowed between two matched irises. It is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees).
PARAMETER_FUSION_TYPE (
see page 179)
PARAMETER_IRISES_MATCHING_SPEED (
see page 179)
PARAMETER_IRISES_MATCHING_THRESHOLD ( 179) PARAMETER_IRISES_MAXIMAL_ROTATION (
see page
see page 180)
PARAMETER_IRISES_MIN_MATCHED_COUNT (
see page 180) Identifier specifying minimal number of irises from probe template to match parameter of type N_TYPE_INT. Parameter value is from zero to NFT_MAX_RECORD_COUNT. Parameter specifying matching threshold (biggest allowed FAR) when matching is stopped (with respect to PARAMETER_IRISES_MIN_MATCHED_ COUNT ( see page 180) parameter value). Parameter value is equal to -12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Identifier specifying matching threshold (biggest allowed FAR) parameter of type int. Parameter value is equal to - 12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). see Specifies whether full matching details are filled during the palms matching. Specifies plam templates matching speed. Can be Low, Medium or High matching speed. Identifier specifying modulus of maximal rotation allowed between two matched NFRecords parameter of type N_TYPE_BYTE. Parameter value is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees).
PARAMETER_IRISES_MIN_MATCHED_COUNT_THRESHOLD ( see page 180)
PARAMETER_MATCHING_THRESHOLD (
see page 180)
PARAMETER_PALMS_FILL_FULL_MATCHING_DETAILS ( page 180) PARAMETER_PALMS_MATCHING_SPEED (
see page 180)
PARAMETER_PALMS_MAXIMAL_ROTATION (
see page 180)
172
8.1 Java Reference
PARAMETER_PALMS_MIN_MATCHED_COUNT (
see page 181) Identifier specifying minimal number of palmprints from probe template to match parameter of type N_TYPE_INT. Parameter value is from zero to NFT_MAX_RECORD_COUNT. Identifier specifying matching threshold (biggest allowed FAR) when matching is stopped (with respect to Neurotec.Biometrics.NMatcher.Parameter PalmsMinMatchedCount parameter value) parameter of type N_TYPE_INT. Parameter value is equal to -12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Identifier specifying whether each user in the system always uses only his own phrases which are unique throughout the whole database of users. Identifier specifying that retrieving or setting parameter for faces matcher (NlsMatcher) contained in NMatcher. See GetParameter, SetParameter, GetStaticParameter Identifier specifying that retrieving or setting parameter for fingers matcher (NfsMatcher) contained in NMatcher. See GetParameter, SetParameter, GetStaticParameter Identifier specifying that retrieving or setting parameter for irises matcher (NesMatcher) contained in NMatcher. See GetParameter, SetParameter, GetStaticParameter Identifier specifying that retrieving or setting parameter for NMatcher. See GetParameter, SetParameter, GetStaticParameter Identifier specifying that retrieving or setting parameter for palms matcher (NfsMatcher) contained in NMatcher. See GetParameter, SetParameter, GetStaticParameter
PARAMETER_PALMS_MIN_MATCHED_COUNT_THRESHOLD ( see page 181)
PARAMETER_VOICES_UNIQUE_PHRASES_ONLY ( 181)
see page
PART_FACES (
see page 181)
PART_FINGERS (
see page 181)
PART_IRISES (
see page 181)
PART_NONE (
see page 181)
PART_PALMS (
see page 182)
NMatcher Methods Name getFacesMatchingSpeed ( 182) see page see see see see Description Gets faces matching speed. Gets the faces matching threshold. Matters only if ParameterFusionType is selectByFaceThenFuse(NMFusionType) set. Gets fingers matching speed. Gets the maximal rotation. Gets minimal number of fingerprints from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)).
getFacesMatchingThreshold ( page 182) getFingersMatchingSpeed ( page 182) getFingersMaximalRotation ( page 182) getFingersMinMatchedCount ( page 182)
173
8.1 Java Reference
getFingersMinMatchedCountThreshold Gets matching threshold (biggest allowed FAR) when matching is ( see page 183) stopped (with respect to FingersMinMatchedFingerCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). getFingersMode ( getFusionType ( see page 183) see page 183) see page see Gets scanners mode. Gets fingerprints and faces fusion. type. Gets irises matching speed. Gets the irises matching threshold. Matters only if ParameterFusionType is selectByIrisThenFuse(NMFusionType) set. Gets the maximal rotation allowed between two matched irises. It is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees). Gets minimal number of irises from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Gets matching threshold (biggest allowed FAR) when matching is stopped (with respect to IrisesMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Gets the matching threshold. Gets palms matching speed. Gets maximal rotation. Gets minimal number of palmprints from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Gets matching threshold (biggest allowed FAR) when matching is stopped (with respect to PalmsMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Ends identification process. Compares the specified NTemplate ( identification was started with. see page 210) with the one see page see page
getIrisesMatchingSpeed ( 183)
getIrisesMatchingThreshold ( page 183) getIrisesMaximalRotation ( 183) getIrisesMinMatchedCount ( page 184)
see page
see
getIrisesMinMatchedCountThreshold ( see page 184)
getMatchingThreshold ( 184)
see page see page see see
getPalmsMatchingSpeed ( 184) getPalmsMaximalRotation ( page 184)
getPalmsMinMatchedCount ( page 184)
getPalmsMinMatchedCountThreshold ( see page 185)
identifyEnd ( identifyNext ( identifyStart (
see page 185) see page 185) see page 186) see page 186) see
Starts identification with the specified packed NTemplate ( 210) (saved in specified buffer). Starts identification with the specified packed NTemplate ( 210). Checks if unique phrases for voice templates are used.
identifyStartWithMD (
isVoicesUniquePhrasesOnly ( page 186) nativeTypeOf ( see page 186) prepareTemplate (
Retrieves a function that retrieves NType object for the enclosing type. Changes specified template for faster matching. Sets faces matching speed. Sets the faces matching threshold. Matters only if ParameterFusionType is selectByFaceThenFuse(NMFusionType) set. Sets fingers matching speed. Sets the maximal rotation. Sets minimal number of fingerprints from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)).
see page 186) see page see see see see
setFacesMatchingSpeed ( 187)
setFacesMatchingThreshold ( page 187) setFingersMatchingSpeed ( page 187) setFingersMaximalRotation ( page 187) setFingersMinMatchedCount ( page 187)
174
8.1 Java Reference
setFingersMinMatchedCountThreshold Sets matching threshold (biggest allowed FAR) when matching is ( see page 188) stopped (with respect to FingersMinMatchedFingerCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). setFingersMode ( setFusionType ( see page 188) see page 188) see page see Sets scanners mode. Sets fingerprints, irises and faces fusion type. Sets irises matching speed. Sets the irises matching threshold. Matters only if ParameterFusionType is selectByIrisThenFuse(NMFusionType) set. Sets the maximal rotation allowed between two matched irises. It is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees). Sets minimal number of irises from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Sets matching threshold (biggest allowed FAR) when matching is stopped (with respect to IrisesMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Sets the matching threshold. Sets palms matching speed.
setIrisesMatchingSpeed ( 188)
setIrisesMatchingThreshold ( page 188) setIrisesMaximalRotation ( 189) setIrisesMinMatchedCount ( page 189)
see page
see
setIrisesMinMatchedCountThreshold ( see page 189)
setMatchingThreshold ( 189)
see page see page
setPalmsMatchingSpeed ( 189) setPalmsMaximalRotation ( 190)
see page Sets maximal rotation. see Sets minimal number of palmprints from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Sets matching threshold (biggest allowed FAR) when matching is stopped (with respect to PalmsMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Sets the system to use unique user phrases. Compares (verifies) two packed templates. Compares two NTemplate ( see page 210).
setPalmsMinMatchedCount ( page 190)
setPalmsMinMatchedCountThreshold ( see page 190)
setVoicesUniquePhrasesOnly ( page 190) verify ( see page 190) see page 191) verifyWithMD (
see
8.1.1.1.30.1 NMatcher.NMatcher Constructor

Initializes a new instance of NMatcher. Java public NMatcher();
8.1.1.1.30.2 NMatcher Fields

8.1.1.1.30.2.1 NMatcher.FINGERS_MODE_ATMEL_FINGER_CHIP Field
Represents Atmel Finger Chip scanner. Java public static final int FINGERS_MODE_ATMEL_FINGER_CHIP = 900;
8.1.1.1.30.2.2 NMatcher.FINGERS_MODE_AUTHENTEC_AES2501B Field

Represents Authentec Aes 2501B scanner.
175
public static final int FINGERS_MODE_AUTHENTEC_AES2501B = 811;
8.1.1.1.30.2.3 NMatcher.FINGERS_MODE_AUTHENTEC_AES4000 Field

Represents Authentec Aes 4000 scanner. Java public static final int FINGERS_MODE_AUTHENTEC_AES4000 = 810;
8.1.1.1.30.2.4 NMatcher.FINGERS_MODE_AUTHENTEC_AFS2 Field

Represents Authentec AFS2 scanner. Java public static final int FINGERS_MODE_AUTHENTEC_AFS2 = 800;
8.1.1.1.30.2.5 NMatcher.FINGERS_MODE_BIOMETRIKA_FX2000 Field

Represents Biometrika FX2000 scanner. Java public static final int FINGERS_MODE_BIOMETRIKA_FX2000 = 200;
8.1.1.1.30.2.6 NMatcher.FINGERS_MODE_BIOMETRIKA_FX3000 Field

Represents Biometrika FX3000 scanner. Java public static final int FINGERS_MODE_BIOMETRIKA_FX3000 = 201;
8.1.1.1.30.2.7 NMatcher.FINGERS_MODE_BMF_BLP100 Field

Represents Bmf Blp 100 scanner. Java public static final int FINGERS_MODE_BMF_BLP100 = 1000;
8.1.1.1.30.2.8 NMatcher.FINGERS_MODE_CROSS_MATCH_VERIFIER_300 Field

Represents Cross Match Verifier 300 scanner. Java public static final int FINGERS_MODE_CROSS_MATCH_VERIFIER_300 = 1300;
8.1.1.1.30.2.9 NMatcher.FINGERS_MODE_DIGENT_IZZIX Field

Represents Digent Izzix scanner. Java public static final int FINGERS_MODE_DIGENT_IZZIX = 1600;
8.1.1.1.30.2.10 NMatcher.FINGERS_MODE_DIGITAL_PERSONA_U_ARE_U Field

Represents Digital Persona U are U scanner. Java public static final int FINGERS_MODE_DIGITAL_PERSONA_U_ARE_U = 100;
8.1.1.1.30.2.11 NMatcher.FINGERS_MODE_ETHENTICA Field

Represents Ethentica scanner. Java public static final int FINGERS_MODE_ETHENTICA = 1200; 176
8.1 Java Reference
8.1.1.1.30.2.12 NMatcher.FINGERS_MODE_FUJITSU_MBF200 Field

Represents Fujitsu Mbf200 scanner. Java public static final int FINGERS_MODE_FUJITSU_MBF200 = 1800;
8.1.1.1.30.2.13 NMatcher.FINGERS_MODE_FUTRONIC_FS80 Field

Represents Futronic FS80 scanner. Java public static final int FINGERS_MODE_FUTRONIC_FS80 = 1900;
8.1.1.1.30.2.14 NMatcher.FINGERS_MODE_GENERAL Field

Represents general scanner. Java public static final int FINGERS_MODE_GENERAL = 0;
8.1.1.1.30.2.15 NMatcher.FINGERS_MODE_IDENTICATOR_TECHNOLOGY_DF90 Field

Represents Identicator Technology DF90 scanner. Java public static final int FINGERS_MODE_IDENTICATOR_TECHNOLOGY_DF90 = 700;
8.1.1.1.30.2.16 NMatcher.FINGERS_MODE_IDENTIX_DFR2090 Field

Represents Identix Dfr2090 scanner. Java public static final int FINGERS_MODE_IDENTIX_DFR2090 = 401;
8.1.1.1.30.2.17 NMatcher.FINGERS_MODE_IDENTIX_TOUCH_VIEW Field

Represents Identix TouchView scanner. Java public static final int FINGERS_MODE_IDENTIX_TOUCH_VIEW = 400;
8.1.1.1.30.2.18 NMatcher.FINGERS_MODE_KEYTRONIC_SECURE_DESKTOP Field

Represents Keytronic Secure Desktop scanner. Java public static final int FINGERS_MODE_KEYTRONIC_SECURE_DESKTOP = 300;
8.1.1.1.30.2.19 NMatcher.FINGERS_MODE_LIGH_TUNING_LTTC500 Field

Represents Light Tuning LttC500 scanner. Java public static final int FINGERS_MODE_LIGH_TUNING_LTTC500 = 2000;
8.1.1.1.30.2.20 NMatcher.FINGERS_MODE_NITGEN_FINGKEY_HAMSTER Field

Represents Nitgen Fingkey Hamster scanner. Java public static final int FINGERS_MODE_NITGEN_FINGKEY_HAMSTER = 1400;
8.1.1.1.30.2.21 NMatcher.FINGERS_MODE_PRECISE_BIOMETRICS_100CS Field

Represents Precise Biometrics 100CS scanner. 177
public static final int FINGERS_MODE_PRECISE_BIOMETRICS_100CS = 500;
8.1.1.1.30.2.22 NMatcher.FINGERS_MODE_SECUGEN_HAMSTER Field

Represents Secugen Hamster scanner. Java public static final int FINGERS_MODE_SECUGEN_HAMSTER = 1100;
8.1.1.1.30.2.23 NMatcher.FINGERS_MODE_STARTEK_FM200 Field

Represents Startek FM200 scanner. Java public static final int FINGERS_MODE_STARTEK_FM200 = 1700;
8.1.1.1.30.2.24 NMatcher.FINGERS_MODE_TACOMA_CMOS Field

Represents Tacoma Cmos scanner. Java public static final int FINGERS_MODE_TACOMA_CMOS = 2100;
8.1.1.1.30.2.25 NMatcher.FINGERS_MODE_TESTECH_BIO_I Field

Represents Testech Bio I scanner. Java public static final int FINGERS_MODE_TESTECH_BIO_I = 1500;
8.1.1.1.30.2.26 NMatcher.FINGERS_MODE_UPEK_TOUCH_CHIP Field

Represents Upek Touch Chip scanner. Java public static final int FINGERS_MODE_UPEK_TOUCH_CHIP = 600;
8.1.1.1.30.2.27 NMatcher.PARAMETER_FACES_MATCHING_SPEED Field

Specifies face templates matching speed. Can be Low or High matching speed. Java public static final int PARAMETER_FACES_MATCHING_SPEED = PARAMETER_FACES_MATCHER_BASE + 1; Notes High matching speed is equal to Medium.
8.1.1.1.30.2.28 NMatcher.PARAMETER_FACES_MATCHING_THRESHOLD Field

Matters only if ParameterFusionType is SelectByFaceThenFuse(NMFusionType) set. Java public static final int PARAMETER_FACES_MATCHING_THRESHOLD = 215;
8.1.1.1.30.2.29 NMatcher.PARAMETER_FINGERS_FILL_FULL_MATCHING_DETAILS Field

Specifies whether full matching details are filled during the fingers matching. Java public static final int PARAMETER_FINGERS_FILL_FULL_MATCHING_DETAILS = PARAMETER_FINGERS_MATCHER_BASE + 900;
178
8.1 Java Reference
8.1.1.1.30.2.30 NMatcher.PARAMETER_FINGERS_MATCHING_SPEED Field

Specifies finger templates matching speed. Can be Low, Medium or High matching speed. Java public static final int PARAMETER_FINGERS_MATCHING_SPEED = PARAMETER_FINGERS_MATCHER_BASE + 220;
8.1.1.1.30.2.31 NMatcher.PARAMETER_FINGERS_MAXIMAL_ROTATION Field

Identifier specifying modulus of maximal rotation allowed between two matched NFRecords parameter of type N_TYPE_BYTE. Parameter value is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees). Java public static final int PARAMETER_FINGERS_MAXIMAL_ROTATION = PARAMETER_FINGERS_MATCHER_BASE + 201;
8.1.1.1.30.2.32 NMatcher.PARAMETER_FINGERS_MIN_MATCHED_COUNT Field

Identifier specifying minimal number of fingerprints from probe template to match parameter of type int. Parameter value is from zero to NFTemplate.MaxRecordCount. Java public static final int PARAMETER_FINGERS_MIN_MATCHED_COUNT = PARAMETER_FINGERS_MATCHER_BASE + 1201;
8.1.1.1.30.2.33 NMatcher.PARAMETER_FINGERS_MIN_MATCHED_COUNT_THRESHOLD Field

Identifier specifying matching threshold (biggest allowed FAR) when matching is stopped (with respect to Neurotec.Biometrics.NMatcher.ParameterFingersMinMatchedCount parameter value) parameter of type N_TYPE_INT. Parameter value is equal to -12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public static final int PARAMETER_FINGERS_MIN_MATCHED_COUNT_THRESHOLD = PARAMETER_FINGERS_MATCHER_BASE + 1202;
8.1.1.1.30.2.34 NMatcher.PARAMETER_FINGERS_MODE Field

Parameter specifying fingers mode (parameter value set). Parameter value can be one of the FingersModeXXX. Java public static final int PARAMETER_FINGERS_MODE = PARAMETER_FINGERS_MATCHER_BASE + 1000;
8.1.1.1.30.2.35 NMatcher.PARAMETER_FUSION_TYPE Field

Identifier specifying fingerprints, irises and faces fusion of type int. Parameter value can be one of the NMFusionType enumeration members. Java public static final int PARAMETER_FUSION_TYPE = 200;
8.1.1.1.30.2.36 NMatcher.PARAMETER_IRISES_MATCHING_SPEED Field

Specifies iris templates matching speed. Can be Low, Medium or High matching speed. Java public static final int PARAMETER_IRISES_MATCHING_SPEED = PARAMETER_IRISES_MATCHER_BASE + 1; Notes High speed is equal to Medium.
8.1.1.1.30.2.37 NMatcher.PARAMETER_IRISES_MATCHING_THRESHOLD Field

Matters only if ParameterFusionType is SelectByIrisThenFuse(NMFusionType) set. 179
public static final int PARAMETER_IRISES_MATCHING_THRESHOLD = 220;
8.1.1.1.30.2.38 NMatcher.PARAMETER_IRISES_MAXIMAL_ROTATION Field

Defines the maximal rotation allowed between two matched irises. It is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees). Java public static final int PARAMETER_IRISES_MAXIMAL_ROTATION = PARAMETER_IRISES_MATCHER_BASE + 2;
8.1.1.1.30.2.39 NMatcher.PARAMETER_IRISES_MIN_MATCHED_COUNT Field

Identifier specifying minimal number of irises from probe template to match parameter of type N_TYPE_INT. Parameter value is from zero to NFT_MAX_RECORD_COUNT. Java public static final int PARAMETER_IRISES_MIN_MATCHED_COUNT = PARAMETER_IRISES_MATCHER_BASE + 1201;
8.1.1.1.30.2.40 NMatcher.PARAMETER_IRISES_MIN_MATCHED_COUNT_THRESHOLD Field

Parameter specifying matching threshold (biggest allowed FAR) when matching is stopped (with respect to PARAMETER_IRISES_MIN_MATCHED_COUNT ( see page 180) parameter value). Parameter value is equal to -12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public static final int PARAMETER_IRISES_MIN_MATCHED_COUNT_THRESHOLD = PARAMETER_IRISES_MATCHER_BASE + 1202;
8.1.1.1.30.2.41 NMatcher.PARAMETER_MATCHING_THRESHOLD Field

Identifier specifying matching threshold (biggest allowed FAR) parameter of type int. Parameter value is equal to - 12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public static final int PARAMETER_MATCHING_THRESHOLD = 100;
8.1.1.1.30.2.42 NMatcher.PARAMETER_PALMS_FILL_FULL_MATCHING_DETAILS Field

Specifies whether full matching details are filled during the palms matching. Java public static final int PARAMETER_PALMS_FILL_FULL_MATCHING_DETAILS = PARAMETER_PALMS_MATCHER_BASE + 900;
8.1.1.1.30.2.43 NMatcher.PARAMETER_PALMS_MATCHING_SPEED Field

Specifies plam templates matching speed. Can be Low, Medium or High matching speed. Java public static final int PARAMETER_PALMS_MATCHING_SPEED = PARAMETER_PALMS_MATCHER_BASE + 220; Notes High speed is equal to Medium.
8.1.1.1.30.2.44 NMatcher.PARAMETER_PALMS_MAXIMAL_ROTATION Field

Identifier specifying modulus of maximal rotation allowed between two matched NFRecords parameter of type N_TYPE_BYTE. Parameter value is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees).
180
public static final int PARAMETER_PALMS_MAXIMAL_ROTATION = PARAMETER_PALMS_MATCHER_BASE + 201;
8.1.1.1.30.2.45 NMatcher.PARAMETER_PALMS_MIN_MATCHED_COUNT Field

Identifier specifying minimal number of palmprints from probe template to match parameter of type N_TYPE_INT. Parameter value is from zero to NFT_MAX_RECORD_COUNT. Java public static final int PARAMETER_PALMS_MIN_MATCHED_COUNT = PARAMETER_PALMS_MATCHER_BASE + 1201;
8.1.1.1.30.2.46 NMatcher.PARAMETER_PALMS_MIN_MATCHED_COUNT_THRESHOLD Field

Identifier specifying matching threshold (biggest allowed FAR) when matching is stopped (with respect to Neurotec.Biometrics.NMatcher.ParameterPalmsMinMatchedCount parameter value) parameter of type N_TYPE_INT. Parameter value is equal to -12 * log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public static final int PARAMETER_PALMS_MIN_MATCHED_COUNT_THRESHOLD = PARAMETER_PALMS_MATCHER_BASE + 1202;
8.1.1.1.30.2.47 NMatcher.PARAMETER_VOICES_UNIQUE_PHRASES_ONLY Field

Identifier specifying whether each user in the system always uses only his own phrases which are unique throughout the whole database of users. Java public static final int PARAMETER_VOICES_UNIQUE_PHRASES_ONLY = PARAMETER_VOICES_MATCHER_BASE + 2;
8.1.1.1.30.2.48 NMatcher.PART_FACES Field

Identifier specifying that retrieving or setting parameter for faces matcher (NlsMatcher) contained in NMatcher ( 170). See GetParameter, SetParameter, GetStaticParameter Java public static final int PART_FACES = 20; see page
8.1.1.1.30.2.49 NMatcher.PART_FINGERS Field

Identifier specifying that retrieving or setting parameter for fingers matcher (NfsMatcher) contained in NMatcher ( 170). See GetParameter, SetParameter, GetStaticParameter Java public static final int PART_FINGERS = 10; see page
8.1.1.1.30.2.50 NMatcher.PART_IRISES Field

Identifier specifying that retrieving or setting parameter for irises matcher (NesMatcher) contained in NMatcher ( 170). See GetParameter, SetParameter, GetStaticParameter Java public static final int PART_IRISES = 30; see page
8.1.1.1.30.2.51 NMatcher.PART_NONE Field

Identifier specifying that retrieving or setting parameter for NMatcher ( GetStaticParameter Java public static final int PART_NONE = 0; see page 170). See GetParameter, SetParameter,
181
8.1 Java Reference
8.1.1.1.30.2.52 NMatcher.PART_PALMS Field

Identifier specifying that retrieving or setting parameter for palms matcher (NfsMatcher) contained in NMatcher ( 170). See GetParameter, SetParameter, GetStaticParameter Java public static final int PART_PALMS = 40; see page
8.1.1.1.30.3 NMatcher Methods

8.1.1.1.30.3.1 NMatcher.getFacesMatchingSpeed Method
Gets faces matching speed. Java public NMatchingSpeed getFacesMatchingSpeed(); Returns One of the NMatchingSpeed values.
8.1.1.1.30.3.2 NMatcher.getFacesMatchingThreshold Method

Gets the faces matching threshold. Matters only if ParameterFusionType is selectByFaceThenFuse(NMFusionType) set. Java public int getFacesMatchingThreshold(); Returns The faces matching threshold.
8.1.1.1.30.3.3 NMatcher.getFingersMatchingSpeed Method

Gets fingers matching speed. Java public NMatchingSpeed getFingersMatchingSpeed(); Returns One of the NMatchingSpeed values.
8.1.1.1.30.3.4 NMatcher.getFingersMaximalRotation Method

Gets the maximal rotation. Java public int getFingersMaximalRotation(); Returns The finger maximal rotation.
8.1.1.1.30.3.5 NMatcher.getFingersMinMatchedCount Method

Gets minimal number of fingerprints from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Java public int getFingersMinMatchedCount(); Returns Minimal number of fingerprints from probe template to match parameter. 182
8.1 Java Reference
8.1.1.1.30.3.6 NMatcher.getFingersMinMatchedCountThreshold Method

Gets matching threshold (biggest allowed FAR) when matching is stopped (with respect to FingersMinMatchedFingerCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public int getFingersMinMatchedCountThreshold(); Returns Matching threshold.
8.1.1.1.30.3.7 NMatcher.getFingersMode Method

Gets scanners mode. Java public int getFingersMode(); Returns One of the scanner types.
8.1.1.1.30.3.8 NMatcher.getFusionType Method

Gets fingerprints and faces fusion. type. Java public NMFusionType getFusionType(); Returns One of the NMFusionType values.
8.1.1.1.30.3.9 NMatcher.getIrisesMatchingSpeed Method

Gets irises matching speed. Java public NMatchingSpeed getIrisesMatchingSpeed(); Returns One of the NMatchingSpeed values.
8.1.1.1.30.3.10 NMatcher.getIrisesMatchingThreshold Method

Gets the irises matching threshold. Matters only if ParameterFusionType is selectByIrisThenFuse(NMFusionType) set. Java public int getIrisesMatchingThreshold(); Returns The irises matching threshold.
8.1.1.1.30.3.11 NMatcher.getIrisesMaximalRotation Method

Gets the maximal rotation allowed between two matched irises. It is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees). Java public int getIrisesMaximalRotation();
183
The maximal rotation allowed between two matched irises.
8.1.1.1.30.3.12 NMatcher.getIrisesMinMatchedCount Method

Gets minimal number of irises from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Java public int getIrisesMinMatchedCount(); Returns Minimal number of irises from probe template to match parameter.
8.1.1.1.30.3.13 NMatcher.getIrisesMinMatchedCountThreshold Method

Gets matching threshold (biggest allowed FAR) when matching is stopped (with respect to IrisesMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public int getIrisesMinMatchedCountThreshold(); Returns Matching threshold.
8.1.1.1.30.3.14 NMatcher.getMatchingThreshold Method

Gets the matching threshold. Java public int getMatchingThreshold(); Returns The the matching speed.
8.1.1.1.30.3.15 NMatcher.getPalmsMatchingSpeed Method

Gets palms matching speed. Java public NMatchingSpeed getPalmsMatchingSpeed(); Returns One of the NMatchingSpeed values.
8.1.1.1.30.3.16 NMatcher.getPalmsMaximalRotation Method

Gets maximal rotation. Java public int getPalmsMaximalRotation(); Returns The palm maximal rotation.
8.1.1.1.30.3.17 NMatcher.getPalmsMinMatchedCount Method

Gets minimal number of palmprints from probe template to match parameter. The value is from zero to MaxRecordCount 184
8.1 Java Reference (NFTemplate ( Java see page 130)).
public int getPalmsMinMatchedCount(); Returns Minimal number of irises from probe template to match parameter.
8.1.1.1.30.3.18 NMatcher.getPalmsMinMatchedCountThreshold Method

Gets matching threshold (biggest allowed FAR) when matching is stopped (with respect to PalmsMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public int getPalmsMinMatchedCountThreshold(); Returns Matching threshold.
8.1.1.1.30.3.19 NMatcher.identifyEnd Method

Ends identification process. Java public void identifyEnd();
8.1.1.1.30.3.20 identifyNext Method 8.1.1.1.30.3.20.1 NMatcher.identifyNext Method (ByteBuffer)

Compares the specified NTemplate ( Java public int identifyNext(ByteBuffer template); Parameters Parameters ByteBuffer template Returns The score of matched NFTemplates. Method returns zero if similarity is less than matching threshold, i.e. two NTemplates do not match,and is greater than or equal to matching threshold otherwise. Description ByteBuffer that contains packed NTemplate ( 210). see page see page 210) with the one identification was started with.
8.1.1.1.30.3.20.2 NMatcher.identifyNext Method (ByteBuffer, NMatchingDetails)

Compares the specified NTemplate ( Java public int identifyNext(ByteBuffer template, NMatchingDetails matchingDetails); Parameters Parameters ByteBuffer template NMatchingDetails matchingDetails Returns The score of matched NFTemplates. Method returns zero if similarity is less than matching threshold, i.e. two NTemplates 185 Description ByteBuffer that contains packed NTemplate ( 210). The NMatchingDetails ( see page see page 210) with the one identification was started with.
see page 191) object.
8.1 Java Reference
do not match,and is greater than or equal to matching threshold otherwise.
8.1.1.1.30.3.21 NMatcher.identifyStart Method

Starts identification with the specified packed NTemplate ( Java public void identifyStart(ByteBuffer template); Parameters Parameters ByteBuffer template Description Buffer that contains packed NTemplate ( see page 210). see page 210) (saved in specified buffer).
8.1.1.1.30.3.22 NMatcher.identifyStartWithMD Method

Starts identification with the specified packed NTemplate ( Java public NMatchingDetails identifyStartWithMD(ByteBuffer template); Parameters Parameters ByteBuffer template Returns NMMatchingDetails object. Description ByteBuffer that contains packed NTemplate ( 210). see page see page 210).
8.1.1.1.30.3.23 NMatcher.isVoicesUniquePhrasesOnly Method

Checks if unique phrases for voice templates are used. Java public boolean isVoicesUniquePhrasesOnly(); Returns Identifier specifying whether each user in the system use his own unique phrases.
8.1.1.1.30.3.24 NMatcher.nativeTypeOf Method

8.1.1.1.30.3.25 NMatcher.prepareTemplate Method

Changes specified template for faster matching. Java public void prepareTemplate(NTemplate template); Parameters Parameters NTemplate template Description Template to change for faster matching.
186
8.1 Java Reference Remarks
This method is primarily used by cluster. It is not recommended to use it directly because template size can increase. When cluster is not used, this method can be used directly to prepare template for faster matching.
8.1.1.1.30.3.26 NMatcher.setFacesMatchingSpeed Method

Sets faces matching speed. Java public void setFacesMatchingSpeed(NMatchingSpeed value); Parameters Parameters NMatchingSpeed value Description One of the NMatchingSpeed values.
8.1.1.1.30.3.27 NMatcher.setFacesMatchingThreshold Method

Sets the faces matching threshold. Matters only if ParameterFusionType is selectByFaceThenFuse(NMFusionType) set. Java public void setFacesMatchingThreshold(int value); Parameters Parameters int value Description The faces matching threshold.
8.1.1.1.30.3.28 NMatcher.setFingersMatchingSpeed Method

Sets fingers matching speed. Java public void setFingersMatchingSpeed(NMatchingSpeed value); Parameters Parameters NMatchingSpeed value Description One of the NMatchingSpeed values.
8.1.1.1.30.3.29 NMatcher.setFingersMaximalRotation Method

Sets the maximal rotation. Java public void setFingersMaximalRotation(int value); Parameters Parameters int value Description The finger maximal rotation.
8.1.1.1.30.3.30 NMatcher.setFingersMinMatchedCount Method

Sets minimal number of fingerprints from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Java public void setFingersMinMatchedCount(int value);
187
Description Minimal number of fingerprints from probe template to match parameter.
8.1.1.1.30.3.31 NMatcher.setFingersMinMatchedCountThreshold Method

Sets matching threshold (biggest allowed FAR) when matching is stopped (with respect to FingersMinMatchedFingerCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public void setFingersMinMatchedCountThreshold(int value); Parameters Parameters int value Description Matching threshold.
8.1.1.1.30.3.32 NMatcher.setFingersMode Method

Sets scanners mode. Java public void setFingersMode(int value); Parameters Parameters int value Description One of the scanner types.
8.1.1.1.30.3.33 NMatcher.setFusionType Method

Sets fingerprints, irises and faces fusion type. Java public void setFusionType(NMFusionType value); Parameters Parameters NMFusionType value Description One of the NMFusionType values.
8.1.1.1.30.3.34 NMatcher.setIrisesMatchingSpeed Method

Sets irises matching speed. Java public void setIrisesMatchingSpeed(NMatchingSpeed value); Parameters Parameters NMatchingSpeed value Description One of the NMatchingSpeed values.
8.1.1.1.30.3.35 NMatcher.setIrisesMatchingThreshold Method

Sets the irises matching threshold. Matters only if ParameterFusionType is selectByIrisThenFuse(NMFusionType) set. Java public void setIrisesMatchingThreshold(int value);
188
Description The irises matching threshold.
8.1.1.1.30.3.36 NMatcher.setIrisesMaximalRotation Method

Sets the maximal rotation allowed between two matched irises. It is specified in 180/128 degrees units and cannot be greater than 128 (180 degrees). Java public void setIrisesMaximalRotation(int value); Parameters Parameters int value Description The maximal rotation allowed between two matched irises.
8.1.1.1.30.3.37 NMatcher.setIrisesMinMatchedCount Method

Sets minimal number of irises from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Java public void setIrisesMinMatchedCount(int value); Parameters Parameters int value Description Minimal number of irises from probe template to match parameter.
8.1.1.1.30.3.38 NMatcher.setIrisesMinMatchedCountThreshold Method

Sets matching threshold (biggest allowed FAR) when matching is stopped (with respect to IrisesMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public void setIrisesMinMatchedCountThreshold(int value); Parameters Parameters int value Description Matching threshold.
8.1.1.1.30.3.39 NMatcher.setMatchingThreshold Method

Sets the matching threshold. Java public void setMatchingThreshold(int value); Parameters Parameters int value Description the matching threshold.
8.1.1.1.30.3.40 NMatcher.setPalmsMatchingSpeed Method

Sets palms matching speed. Java public void setPalmsMatchingSpeed(NMatchingSpeed value); 189
8.1 Java Reference Parameters Parameters NMatchingSpeed value
Description One of the NMatchingSpeed values.
8.1.1.1.30.3.41 NMatcher.setPalmsMaximalRotation Method

Sets maximal rotation. Java public void setPalmsMaximalRotation(int value); Parameters Parameters int value Description The palm maximal rotation.
8.1.1.1.30.3.42 NMatcher.setPalmsMinMatchedCount Method

Sets minimal number of palmprints from probe template to match parameter. The value is from zero to MaxRecordCount (NFTemplate ( see page 130)). Java public void setPalmsMinMatchedCount(int value); Parameters Parameters int value Description Minimal number of irises from probe template to match parameter.
8.1.1.1.30.3.43 NMatcher.setPalmsMinMatchedCountThreshold Method

Sets matching threshold (biggest allowed FAR) when matching is stopped (with respect to PalmsMinMatchedCount parameter value) parameter. Parameter value is equal to -12 log10(FAR) and must be not less than zero (for example, 48 for FAR = 0.01%). Java public void setPalmsMinMatchedCountThreshold(int value); Parameters Parameters int value Description Matching threshold.
8.1.1.1.30.3.44 NMatcher.setVoicesUniquePhrasesOnly Method

Sets the system to use unique user phrases. Java public void setVoicesUniquePhrasesOnly(boolean value); Parameters Parameters boolean value Description true, if unique phrases should be used; false, otherwise.
8.1.1.1.30.3.45 NMatcher.verify Method

Compares (verifies) two packed templates. Java public int verify(ByteBuffer template1, ByteBuffer template2);
190
8.1 Java Reference Parameters Parameters ByteBuffer template1 ByteBuffer template2 Returns Verification score. Remarks
Description Buffer containing first packed template. Buffer containing second packed template.
Method returns zero if similarity is less than matching threshold, i.e. two templates do not match (see PARAMETER_MATCHING_THRESHOLD ( see page 180) and SetParameter method), and is greater than or equal to matching threshold otherwise.
8.1.1.1.30.3.46 NMatcher.verifyWithMD Method

Compares two NTemplate ( Java public NMatchingDetails verifyWithMD(ByteBuffer template1, ByteBuffer template2); Parameters Parameters ByteBuffer template1 ByteBuffer template2 returnMatchingDetails Returns NMatcherResult object. Description ByteBuffer that contains packed NTemplate ( 210). ByteBuffer that contains packed NTemplate ( 210). if set to true, match details will be available. see page see page see page 210).
8.1.1.1.31 NMatchingDetails Class

Provides functionality for retrieving Neurotechnology templates matching details. Java public final class NMatchingDetails extends NMatchingDetailsBase; File NMatchingDetails.java Methods NMatchingDetails Class Name NMatchingDetails ( NMatchingDetails Classes NMatchingDetails Class Name FaceCollection ( FingerCollection ( IrisCollection ( PalmCollection ( VoiceCollection ( see page 193) see page 194) see page 194) see page 194) see page 194) Description Face templates matching details collection. Finger templates matching details collection. Iris templates matching details collection. Palm templates matching details collection. Voice templates matching details collection. 191 Description see page 192) Creates new instance of NMatchingDetails class.
8.1 Java Reference NMatchingDetailsBase Methods Name getBiometricType ( getScore ( nativeTypeOf ( NMatchingDetails Class Name getFaces ( see page 194) getFacesMatchedIndex ( page 194) getFacesScore ( getFingers ( see page 197)
Description see page 197) Gets type of biometric modality saved in specified matching details. Gets similarity score of two matched templates. Retrieves a function that retrieves NType object for the enclosing type.
see page 197)
Description Gets collection of faces matching details. Gets index of matched face in the second matched NLTemplate ( page 167) (or NTemplate ( see page 210)). Gets similarity score of two matched face templates (NLTemplate ( page 167)). Gets collection of finger matching details. Gets similarity score of two matched finger templates (NFTemplate ( see page 130)). Gets collection of irises matching details. Gets similarity score of two matched iris templates (NETemplate ( page 80)). Gets collection of palms matching details. Gets similarity score of two matched palm templates (NFTemplate ( page 130)). Gets collection of voices matching details. Gets similarity score of two matched voice templates (NSTemplate ( see page 207)). Retrieves a function that retrieves NType object for the enclosing type. see see see see see
see page 195)
getFingersScore ( getIrises (
getIrisesScore ( getPalms (
getPalmsScore ( getVoices (
getVoicesScore ( nativeTypeOf (
see page 196)
8.1.1.1.31.1 NMatchingDetails Constructor

8.1.1.1.31.1.1 NMatchingDetails.NMatchingDetails Constructor (ByteBuffer)
Creates new instance of NMatchingDetails class. Java public NMatchingDetails(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description Memory buffer which contains templates matching details.
8.1.1.1.31.1.2 NMatchingDetails.NMatchingDetails Constructor (ByteBuffer, int)

Creates new instance of NMatchingDetails class. Java public NMatchingDetails(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description Memory buffer which contains templates matching details. Bitwise combination of zero or more flags that controls behavior of the constructor. Should be zero.
192
8.1 Java Reference
8.1.1.1.31.1.3 NMatchingDetails.NMatchingDetails Constructor (InputStream)

Creates new instance of NMatchingDetails class. Java public NMatchingDetails(InputStream in) throws IOException; Parameters Parameters InputStream in Description Stream containing matching details.
8.1.1.1.31.1.4 NMatchingDetails.NMatchingDetails Constructor (InputStream, int)

Creates new instance of NMatchingDetails class. Java public NMatchingDetails(InputStream in, int flags) throws IOException; Parameters Parameters InputStream in int flags Description Stream containing matching details. Bitwise combination of zero or more flags that controls behavior of the constructor. Should be zero.
8.1.1.1.31.1.5 NMatchingDetails.NMatchingDetails Constructor (ReadableByteChannel)

Creates new instance of NMatchingDetails class from ReadableByteChannel. Java public NMatchingDetails(ReadableByteChannel ch) throws IOException; Parameters Parameters ReadableByteChannel ch Description ReadableByteChannel containing matching details.
8.1.1.1.31.1.6 NMatchingDetails.NMatchingDetails Constructor (ReadableByteChannel, int)

Creates new instance of NMatchingDetails class from ReadableByteChannel. Java public NMatchingDetails(ReadableByteChannel ch, int flags) throws IOException; Parameters Parameters ReadableByteChannel ch int flags Description ReadableByteChannel containing matching details. Bitwise combination of zero or more flags that controls behavior of the constructor. Should be zero.
8.1.1.1.31.2 NMatchingDetails Classes

8.1.1.1.31.2.1 NMatchingDetails.FaceCollection Class
Face templates matching details collection. Java public final class FaceCollection extends NObjectReadOnlyCollection<NLMatchingDetails>; File NMatchingDetails.java 193
8.1 Java Reference
8.1.1.1.31.2.2 NMatchingDetails.FingerCollection Class

Finger templates matching details collection. Java public final class FingerCollection extends NObjectReadOnlyCollection<NFMatchingDetails>; File NMatchingDetails.java
8.1.1.1.31.2.3 NMatchingDetails.IrisCollection Class

Iris templates matching details collection. Java public final class IrisCollection extends NObjectReadOnlyCollection<NEMatchingDetails>; File NMatchingDetails.java
8.1.1.1.31.2.4 NMatchingDetails.PalmCollection Class

Palm templates matching details collection. Java public final class PalmCollection extends NObjectReadOnlyCollection<NFMatchingDetails>; File NMatchingDetails.java
8.1.1.1.31.2.5 NMatchingDetails.VoiceCollection Class

Voice templates matching details collection. Java public final class VoiceCollection extends NObjectReadOnlyCollection<NSMatchingDetails>; File NMatchingDetails.java
8.1.1.1.31.3 NMatchingDetails Methods

8.1.1.1.31.3.1 NMatchingDetails.getFaces Method
Gets collection of faces matching details. Java public FaceCollection getFaces(); Returns Faces matching details collection (FaceCollection ( see page 193)).
8.1.1.1.31.3.2 NMatchingDetails.getFacesMatchedIndex Method

Gets index of matched face in the second matched NLTemplate ( Java public int getFacesMatchedIndex(); see page 167) (or NTemplate ( see page 210)).
194
Index of matched face in the second template.
8.1.1.1.31.3.3 NMatchingDetails.getFacesScore Method

Gets similarity score of two matched face templates (NLTemplate ( Java public int getFacesScore(); Returns Similarity (matching) score. see page 167)).
8.1.1.1.31.3.4 NMatchingDetails.getFingers Method

Gets collection of finger matching details. Java public FingerCollection getFingers(); Returns Fingers matching details collection (FingerCollection ( see page 194)).
8.1.1.1.31.3.5 NMatchingDetails.getFingersScore Method

Gets similarity score of two matched finger templates (NFTemplate ( Java public int getFingersScore(); Returns Similarity (matching) score. of two fingerprint templates. see page 130)).
8.1.1.1.31.3.6 NMatchingDetails.getIrises Method

Gets collection of irises matching details. Java public IrisCollection getIrises(); Returns Irises matching details collection (IrisCollection ( see page 194)).
8.1.1.1.31.3.7 NMatchingDetails.getIrisesScore Method

Gets similarity score of two matched iris templates (NETemplate ( Java public int getIrisesScore(); Returns Similarity (matching) score. of two iris templates. see page 80)).
8.1.1.1.31.3.8 NMatchingDetails.getPalms Method

Gets collection of palms matching details. Java public PalmCollection getPalms();
195
Palmprints matching details collection (PalmCollection (
see page 194)).
8.1.1.1.31.3.9 NMatchingDetails.getPalmsScore Method

Gets similarity score of two matched palm templates (NFTemplate ( Java public int getPalmsScore(); Returns Similarity (matching) score. of two palm templates. see page 130)).
8.1.1.1.31.3.10 NMatchingDetails.getVoices Method

Gets collection of voices matching details. Java public VoiceCollection getVoices(); Returns Voices matching details collection (VoiceCollection ( see page 194)).
8.1.1.1.31.3.11 NMatchingDetails.getVoicesScore Method

Gets similarity score of two matched voice templates (NSTemplate ( Java public int getVoicesScore(); Returns Similarity (matching) score. of two voice templates. see page 207)).
8.1.1.1.31.3.12 NMatchingDetails.nativeTypeOf Method

8.1.1.1.32 NMatchingDetailsBase Class

Base class for NMatchingDetails ( Java public class NMatchingDetailsBase extends NObject; File NMatchingDetailsBase.java NMatchingDetailsBase Methods Name getBiometricType ( getScore ( nativeTypeOf ( see page 197) see page 197) Description see page 197) Gets type of biometric modality saved in specified matching details. Gets similarity score of two matched templates. Retrieves a function that retrieves NType object for the enclosing type. 196 see page 191).
8.1 Java Reference
8.1.1.1.32.1 NMatchingDetailsBase Methods

8.1.1.1.32.1.1 NMatchingDetailsBase.getBiometricType Method
Gets type of biometric modality saved in specified matching details. Java public final EnumSet<NBiometricType> getBiometricType(); Returns NBiometricType object containing information about template biometric type.
8.1.1.1.32.1.2 NMatchingDetailsBase.getScore Method

Gets similarity score of two matched templates. Java public final int getScore(); Returns Similarity score of two matched templates.
8.1.1.1.32.1.3 NMatchingDetailsBase.nativeTypeOf Method

8.1.1.1.33 NSAttributes Class

Provides methods to retrieve sound template attributes. Java public class NSAttributes extends NBiometricAttributes; File NSAttributes.java Methods NSAttributes Class Name NSAttributes ( see page 198) Description Creates new instance of NSAttributes.
NBiometricAttributes Methods Name getBiometricType ( getQuality ( getStatus ( setQuality ( setStatus ( see page 61) see page 62) see page 62) see page 62) see page 62) see page 62) Description Gets the biometric type enumeration for the current object. Gets quality of the current object. Gets the biometric status of the current object. Retrieves a function that retrieves NType object for the enclosing type. Sets quality of the current object. Sets the biometric status of the current object.
nativeTypeOf (
197
8.1 Java Reference NSAttributes Class Name getPhraseId ( nativeTypeOf (
Description see page 198) see page 198) Gets sound phrase Id. Retrieves a function that retrieves NType object for the enclosing type.
8.1.1.1.33.1 NSAttributes.NSAttributes Constructor

Creates new instance of NSAttributes. Java public NSAttributes(int phraseId);
8.1.1.1.33.2 NSAttributes Methods

8.1.1.1.33.2.1 NSAttributes.getPhraseId Method
Gets sound phrase Id. Java public final int getPhraseId(); Returns Sound phrase Id.
8.1.1.1.33.2.2 NSAttributes.nativeTypeOf Method

8.1.1.1.34 NSExtractor Class

Provides functions for speaker features extraction into Neurotechnology Speaker Record (NSRecord ( Java public final class NSExtractor extends NObject; File NSExtractor.java Methods Name NSExtractor ( NSExtractor Classes Name ExtractResult ( NSExtractor Fields Name PARAMETER_MAX_PAUSE_DURATION ( see page 200) Description Parameter controlling the duration of pause used to detect end of voice activity. see page 199) Description Speaker record extraction result. see page 199) Description Initializes a new instance of NSExtractor. see page 203)).
198
8.1 Java Reference
PARAMETER_MAX_PHRASE_DURATION ( see page 200) PARAMETER_MIN_PHRASE_DURATION ( see page 200)
Parameter controlling the max duration of extracted phrase. Parameter controlling the min duration of extracted phrase.
PARAMETER_USE_SPEAKER_DETECTION Parameter controlling whether end of voice activity is detected ( see page 200) automatically. NSExtractor Methods Name extract ( see page 200) see page 201) see page 201) see page 201) see see see see Description Extracts sound attributes from specified sound buffer and creates NSRecord ( see page 203) using the specified NSExtractor. Ends extracting sound (voice) features from sound stream. Extracts one sound feature from sound stream. Initializes sound features extraction routines that use sound stream to extract ( see page 200) features. Controls duration of pause used to detect end of voice activity. Controls max duration of extracted phrase. Controls min duration of extracted phrase. Shows whether end of voice activity is detected automatically. Retrieves a handle to the function that retrieves NType object for the specified type name. Controls duration of pause used to detect end of voice activity. Controls max duration of extracted phrase. Controls min duration of extracted phrase. Shows whether end of voice activity is detected automatically.
extractEnd ( extractNext ( extractStart (
getMaxPauseDurationRaw ( page 201) getMaxPhraseDurationRaw ( page 201) getMinPhraseDurationRaw ( page 202) getUseSpeakerDetection ( page 202) nativeTypeOf (
see page 202) see see see see
setMaxPauseDurationRaw ( page 202) setMaxPhraseDurationRaw ( page 202) setMinPhraseDurationRaw ( page 203) setUseSpeakerDetection ( page 203)
8.1.1.1.34.1 NSExtractor.NSExtractor Constructor

Initializes a new instance of NSExtractor. Java public NSExtractor();
8.1.1.1.34.2 NSExtractor Classes

8.1.1.1.34.2.1 NSExtractor.ExtractResult Class
Speaker record extraction result. Java public static final class ExtractResult; File NSExtractor.java ExtractResult Methods Name getRecord ( getStatus ( see page 200) see page 200) Description Retrieves the NSRecord ( see page 203). Retrieves the status of the template. 199
8.1 Java Reference
8.1.1.1.34.2.1.1 ExtractResult Methods 8.1.1.1.34.2.1.1.1 NSExtractor.ExtractResult.getRecord Method

Retrieves the NSRecord ( Java public NSRecord getRecord(); Returns NSRecord ( see page 203). see page 203).
8.1.1.1.34.2.1.1.2 NSExtractor.ExtractResult.getStatus Method

Retrieves the status of the template. Java public NSEExtractionStatus getStatus(); Returns The status of the template.
8.1.1.1.34.3 NSExtractor Fields

8.1.1.1.34.3.1 NSExtractor.PARAMETER_MAX_PAUSE_DURATION Field
Parameter controlling the duration of pause used to detect end of voice activity. Java public static final int PARAMETER_MAX_PAUSE_DURATION = 35012;
8.1.1.1.34.3.2 NSExtractor.PARAMETER_MAX_PHRASE_DURATION Field

Parameter controlling the max duration of extracted phrase. Java public static final int PARAMETER_MAX_PHRASE_DURATION = 34037;
8.1.1.1.34.3.3 NSExtractor.PARAMETER_MIN_PHRASE_DURATION Field

Parameter controlling the min duration of extracted phrase. Java public static final int PARAMETER_MIN_PHRASE_DURATION = 34036;
8.1.1.1.34.3.4 NSExtractor.PARAMETER_USE_SPEAKER_DETECTION Field

Parameter controlling whether end of voice activity is detected automatically. Java public static final int PARAMETER_USE_SPEAKER_DETECTION = 35020;
8.1.1.1.34.4 NSExtractor Methods

8.1.1.1.34.4.1 NSExtractor.extract Method
Extracts sound attributes from specified sound buffer and creates NSRecord ( NSExtractor ( see page 198). Java public ExtractResult extract(int phraseId, NSoundBuffer soundBuffer); 200 see page 203) using the specified
8.1 Java Reference Parameters Parameters int phraseId NSoundBuffer soundBuffer Returns Extracted sound record.
Description User specified phrase Id. NSoundBuffer used to extract sound (voice) attributes and record.
8.1.1.1.34.4.2 NSExtractor.extractEnd Method

Ends extracting sound (voice) features from sound stream. Java public ExtractResult extractEnd(); Returns Extracted sound record.
8.1.1.1.34.4.3 NSExtractor.extractNext Method

Extracts one sound feature from sound stream. Java public ExtractResult extractNext(NSoundBuffer soundBuffer); Parameters Parameters NSoundBuffer soundBuffer Returns Sound record attributes. Description NSoundBuffer used to extract ( (voice) features. see page 200) sound
8.1.1.1.34.4.4 NSExtractor.extractStart Method

Initializes sound features extraction routines that use sound stream to extract ( Java public void extractStart(int phraseId); Parameters Parameters int phraseId Description Sound prase Id which will be used for extracted features. Phrase Id should be specified by user and should be >=0. see page 200) features.
8.1.1.1.34.4.5 NSExtractor.getMaxPauseDurationRaw Method

Controls duration of pause used to detect end of voice activity. Java public int getMaxPauseDurationRaw(); Returns Pause duration in milliseconds.
8
8.1.1.1.34.4.6 NSExtractor.getMaxPhraseDurationRaw Method
Controls max duration of extracted phrase. 201
public int getMaxPhraseDurationRaw(); Returns Max phrase duration in milliseconds.
8.1.1.1.34.4.7 NSExtractor.getMinPhraseDurationRaw Method

Controls min duration of extracted phrase. Java public int getMinPhraseDurationRaw(); Returns Min phrase duration in milliseconds.
8.1.1.1.34.4.8 NSExtractor.getUseSpeakerDetection Method

Shows whether end of voice activity is detected automatically. Java public boolean getUseSpeakerDetection(); Returns Controls end of voice activity detection.
8.1.1.1.34.4.9 NSExtractor.nativeTypeOf Method

Retrieves a handle to the function that retrieves NType object for the specified type name. Java public static NType nativeTypeOf(); Returns a handle to the function that retrieves NType object for the specified type name.
8.1.1.1.34.4.10 NSExtractor.setMaxPauseDurationRaw Method

Controls duration of pause used to detect end of voice activity. Java public void setMaxPauseDurationRaw(int value); Parameters Parameters int value Description Integer value which represents pause duration in milliseconds.
8.1.1.1.34.4.11 NSExtractor.setMaxPhraseDurationRaw Method

Controls max duration of extracted phrase. Java public void setMaxPhraseDurationRaw(int value); Parameters Parameters int value Description Integer value which represents max phrase duration in milliseconds.. 202
8.1 Java Reference
8.1.1.1.34.4.12 NSExtractor.setMinPhraseDurationRaw Method

Controls min duration of extracted phrase. Java public void setMinPhraseDurationRaw(int value); Parameters Parameters int value Description Integer value which represents min phrase duration in milliseconds..
8.1.1.1.34.4.13 NSExtractor.setUseSpeakerDetection Method

Shows whether end of voice activity is detected automatically. Java public void setUseSpeakerDetection(boolean value); Parameters Parameters boolean value Description Controls end of voice activity detection.
8.1.1.1.35 NSMatchingDetails Class

Provides functionality to retrieve speaker matching details. Java public final class NSMatchingDetails extends NXMatchingDetails; File NSMatchingDetails.java NSMatchingDetails Methods Name nativeTypeOf ( see page 203) Description Retrieves a function that retrieves NType object for the enclosing type.
8.1.1.1.35.1 NSMatchingDetails Methods

8.1.1.1.35.1.1 NSMatchingDetails.nativeTypeOf Method
8.1.1.1.36 NSRecord Class

Provides functionality for packing, unpacking and editing Neurotechnology Speaker Records (NSRecords). Java public class NSRecord extends NObject implements Cloneable; File NSRecord.java 203
8.1 Java Reference Methods Name NSRecord ( NSRecord Methods Name check ( see page 205) getCBEFFProductType ( page 205) getPhraseId ( getSize ( nativeTypeOf ( see page 206) see page 204)
Description Initializes a new instance of the NSRecord class.
Description Checks if memory buffer contains a valid NSRecord object. see Gets the CBEFF product type of the NSRecord. Gets phrase id. Retrieves size of the phrase. Retrieves a function that retrieves NType object for the enclosing type. Sets the CBEFF product type of the NSRecord. Sets phrase id. see
setCBEFFProductType ( page 206) setPhraseId (
see page 206)
8.1.1.1.36.1 NSRecord Constructor

8.1.1.1.36.1.1 NSRecord.NSRecord Constructor ()
Initializes a new instance of the NSRecord class. Java public NSRecord();
8.1.1.1.36.1.2 NSRecord.NSRecord Constructor (ByteBuffer)

Initializes a new instance of the NSRecord class. Java public NSRecord(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing packed NSRecord.
8.1.1.1.36.1.3 NSRecord.NSRecord Constructor (ByteBuffer, int)

Initializes a new instance of the NSRecord class. Java public NSRecord(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer containing packed NSRecord. Bitwise combination of zero or more flags that controls behavior of the constructor. Should be zero.
8.1.1.1.36.1.4 NSRecord.NSRecord Constructor (int)

Initializes a new instance of the NSRecord class. Java public NSRecord(int flags);
204
8.1 Java Reference Parameters Parameters int flags
Description Bitwise combination of zero or more flags that controls behavior of the constructor. Should be zero.
8.1.1.1.36.2 NSRecord Methods

8.1.1.1.36.2.1 NSRecord.check Method
Checks if memory buffer contains a valid NSRecord ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing NSRecord ( see page 203) object. see page 203) object.
8.1.1.1.36.2.2 getCBEFFProductType Method 8.1.1.1.36.2.2.1 NSRecord.getCBEFFProductType Method ()

Gets the CBEFF product type of the NSRecord ( Java public final short getCBEFFProductType(); Returns The CBEFF product type. see page 203).
8.1.1.1.36.2.2.2 NSRecord.getCBEFFProductType Method (ByteBuffer)

Retrieves the CBEFF product type of the NSRecord ( Java public static short getCBEFFProductType(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The CBEFF product type. Description ByteBuffer containing NSRecord ( see page 203) object. see page 203).
8.1.1.1.36.2.3 getPhraseId Method 8.1.1.1.36.2.3.1 NSRecord.getPhraseId Method ()

Gets phrase id. Java public final int getPhraseId(); Returns Phrase id.
205
8.1 Java Reference
8.1.1.1.36.2.3.2 NSRecord.getPhraseId Method (ByteBuffer)

Retrieves phrase id. Java public static int getPhraseId(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Phrase id. Description ByteBuffer containing NSRecord ( see page 203) object.
8.1.1.1.36.2.4 NSRecord.getSize Method

Retrieves size of the phrase. Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Size of the phrase. Description ByteBuffer containing NSRecord ( see page 203) object.
8.1.1.1.36.2.5 NSRecord.nativeTypeOf Method

8.1.1.1.36.2.6 NSRecord.setCBEFFProductType Method

Sets the CBEFF product type of the NSRecord ( Java public final void setCBEFFProductType(short type); Parameters Parameters short type Description CBEFF product type see page 203).
8.1.1.1.36.2.7 NSRecord.setPhraseId Method

Sets phrase id. Java public final void setPhraseId(int value); Parameters Parameters int value Description Phrase id. 206
8.1 Java Reference
8.1.1.1.37 NSTemplate Class

Provides functionality for packing, unpacking and editing Neurotechnology Speaker Templates (NSTemplates). Java public final class NSTemplate extends NObject implements Cloneable; File NSTemplate.java Methods Name NSTemplate ( NSTemplate Classes Name RecordCollection ( NSTemplate Fields Name MAX_RECORD_COUNT ( page 208) see Description The maximum number of records NSTemplate can contain. see page 208) Description Collection of NSRecords. see page 207) Description Initializes a new instance of the NTemplate ( see page 210) class.
PROCESS_FIRST_RECORD_ONLY The flag indicating whether only the first iris record should be unpacked ( see page 208) or packed while unpacking or packing NSTemplate. NSTemplate Methods Name calculateSize ( check ( see page 209) see page 209) see page 209) see page 209) see page 210) Description Calculates size of NSTemplate object containing particular NSRecords. Checks if memory buffer contains a valid NSTemplate object. Gets record count in NSTemplate. Gets collection of records in the NSTemplate. Retrieves the size of the NSTemplate Retrieves a function that retrieves NType object for the enclosing type.
getRecordCount ( getRecords ( getSize ( nativeTypeOf (
see page 209)
8.1.1.1.37.1 NSTemplate Constructor

8.1.1.1.37.1.1 NSTemplate.NSTemplate Constructor ()
Initializes a new instance of the NTemplate ( Java public NSTemplate(); see page 210) class.
8.1.1.1.37.1.2 NSTemplate.NSTemplate Constructor (ByteBuffer)

Initializes a new instance of the NSTemplate class. Java public NSTemplate(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer that contains packed NETemlate.
207
8.1 Java Reference
8.1.1.1.37.1.3 NSTemplate.NSTemplate Constructor (ByteBuffer, int)

Initializes a new instance of the NSTemplate class. Java public NSTemplate(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer that contains packed NETemlate. Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero.
8.1.1.1.37.1.4 NSTemplate.NSTemplate Constructor (int)

Initializes a new instance of the NTemplate ( Java public NSTemplate(int flags); Parameters Parameters int flags Description Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero. see page 210) class.
8.1.1.1.37.2 NSTemplate Classes

8.1.1.1.37.2.1 NSTemplate.RecordCollection Class
Collection of NSRecords. Java public final class RecordCollection extends NObjectCollection<NSRecord>; File NSTemplate.java
8.1.1.1.37.3 NSTemplate Fields

8.1.1.1.37.3.1 NSTemplate.MAX_RECORD_COUNT Field
The maximum number of records NSTemplate ( Java public static final int MAX_RECORD_COUNT = 255; see page 207) can contain.
8.1.1.1.37.3.2 NSTemplate.PROCESS_FIRST_RECORD_ONLY Field

The flag indicating whether only the first iris record should be unpacked or packed while unpacking or packing NSTemplate ( see page 207). Java public static final int PROCESS_FIRST_RECORD_ONLY = 0x00000100;
8.1.1.1.37.4 NSTemplate Methods
208
8.1 Java Reference
8.1.1.1.37.4.1 NSTemplate.calculateSize Method

Calculates size of NSTemplate ( Java public static int calculateSize(int[] recordSizes); Parameters Parameters int[] recordSizes Returns Calculated size in bytes. Description Array of separate NSRecord ( see page 203) sizes. see page 207) object containing particular NSRecords.
8.1.1.1.37.4.2 NSTemplate.check Method

Checks if memory buffer contains a valid NSTemplate ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing a NSTemplate ( see page 207). see page 207) object.
8.1.1.1.37.4.3 NSTemplate.getRecordCount Method

Gets record count in NSTemplate ( Java public static int getRecordCount(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns Number of records in the NSTemplate ( see page 207). Description ByteBuffer containing a NSTemplate ( see page 207). see page 207).
8.1.1.1.37.4.4 NSTemplate.getRecords Method

Gets collection of records in the NSTemplate ( Java public RecordCollection getRecords(); Returns A RecordCollection ( see page 208) collection. see page 207).
8.1.1.1.37.4.5 NSTemplate.getSize Method

Retrieves the size of the NSTemplate ( Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing a NSTemplate ( see page 207). 209 see page 207)
8.1 Java Reference Returns The size of NSTemplate (
see page 207).
8.1.1.1.37.4.6 NSTemplate.nativeTypeOf Method

8.1.1.1.38 NTemplate Class

Provides functionality for packing, unpacking and editing Neurotechnology Templates (NTemplates). Java public class NTemplate extends NObject implements Cloneable; File NTemplate.java Methods Name NTemplate ( NTemplate Methods Name calculateSize ( check ( clear ( see page 211) Description Calculates the size of a packed NTemplate containing fingers, faces. irises and palms templates of the specified size. Checks if memory buffer contains a valid NTemplate object. Removes all NTemplate objects. Gets NLTemplate ( Gets NFTemplate ( Gets NETemplate ( Gets NFTemplate ( Gets NSTemplate ( Sets NLTemplate ( Sets NFTemplate ( Sets NETemplate ( Sets NFTemplate ( Sets NSTemplate ( see page 167) object. see page 130) object. see page 80) object. see page 130) object. see page 207) object. see page 167) object. see page 130) object. see page 80) objects. see page 130) object. see page 207) object. see page 210) Description Initializes a new instance of the NTemplate class.
see page 212) see page 212) see page 212) see page 212) see page 212) see page 212) see page 213) see page 213) see page 213) see page 213) see page 213) see page 213) see page 214) see page 214)
getFaces ( getFingers ( getIrises ( getPalms ( getSize ( getVoices ( setFaces ( setFingers ( setIrises ( setPalms ( setVoices (
Retrieves the size of the NTemplate Retrieves a function that retrieves NType object for the enclosing type.
nativeTypeOf (
8.1.1.1.38.1 NTemplate Constructor

8.1.1.1.38.1.1 NTemplate.NTemplate Constructor ()
Initializes a new instance of the NTemplate class. Java public NTemplate(); 210
8.1 Java Reference
8.1.1.1.38.1.2 NTemplate.NTemplate Constructor (ByteBuffer)

Initializes a new instance of the NTemplate class from byte array. Java public NTemplate(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description Byte array that contains packed NTemplate.
8.1.1.1.38.1.3 NTemplate.NTemplate Constructor (ByteBuffer, int)

Initializes a new instance of the NTemplate class from byte array. Java public NTemplate(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Description Byte array that contains packed NTemplate. Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero.
8.1.1.1.38.1.4 NTemplate.NTemplate Constructor (int)

Initializes a new instance of the NTemplate class. Java public NTemplate(int flags); Parameters Parameters int flags Description Bitwise combination of zero or more flags that controls behavior of the constructor. This parameter is reserved, must be zero.
8.1.1.1.38.2 NTemplate Methods

8.1.1.1.38.2.1 NTemplate.calculateSize Method
Calculates the size of a packed NTemplate ( specified size. Java public static int calculateSize(int fingersTemplateSize, int facesTemplateSize, int irisesTemplateSize, int palmsTemplateSize, int voicesTemplateSize); Parameters Parameters int fingersTemplateSize int facesTemplateSize int irisesTemplateSize int palmsTemplateSize int voicesTemplateSize Description Size of packed NFTemplate ( Size of packed NLTemplate ( Size of packed NETemplate ( Size of packed NFTemplate ( Size of packed NSTemplate ( see page 130). see page 167). see page 80). see page 130). see page 207). see page 210) containing fingers, faces. irises and palms templates of the
211
8.1 Java Reference Returns The value of NTemplate (
see page 210) size.
8.1.1.1.38.2.2 NTemplate.check Method

Checks if memory buffer contains a valid NTemplate ( Java public static void check(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing a NTemplate ( see page 210). see page 210) object.
8.1.1.1.38.2.3 NTemplate.clear Method

Removes all NTemplate ( Java public final void clear(); see page 210) objects.
8.1.1.1.38.2.4 NTemplate.getFaces Method

Gets NLTemplate ( Java public final NLTemplate getFaces(); Returns A NLTemplate ( see page 167) object. see page 167) object.
8.1.1.1.38.2.5 NTemplate.getFingers Method

Gets NFTemplate ( Java public final NFTemplate getFingers(); Returns A NFTemplate ( see page 130) object. see page 130) object.
8.1.1.1.38.2.6 NTemplate.getIrises Method

Gets NETemplate ( Java public final NETemplate getIrises(); Returns A NETemplate ( see page 80) object. see page 80) object.
8.1.1.1.38.2.7 NTemplate.getPalms Method

Gets NFTemplate ( Java public final NFTemplate getPalms(); Returns A NFTemplate ( see page 130) object. 212 see page 130) object.
8.1 Java Reference
8.1.1.1.38.2.8 NTemplate.getSize Method

Retrieves the size of the NTemplate ( Java public static int getSize(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of NTemplate ( see page 210). Description ByteBuffer containing a NTemplate ( see page 210). see page 210)
8.1.1.1.38.2.9 NTemplate.getVoices Method

Gets NSTemplate ( Java public final NSTemplate getVoices(); Returns A NSTemplate ( see page 207) object. see page 207) object.
8.1.1.1.38.2.10 NTemplate.nativeTypeOf Method

8.1.1.1.38.2.11 NTemplate.setFaces Method

Sets NLTemplate ( Java public final void setFaces(NLTemplate value); Parameters Parameters NLTemplate value Description NLTemplate ( see page 167) object. see page 167) object.
8.1.1.1.38.2.12 NTemplate.setFingers Method

Sets NFTemplate ( Java public final void setFingers(NFTemplate value); Parameters Parameters NFTemplate value Description NFTemplate ( see page 130) object. see page 130) object.
8.1.1.1.38.2.13 NTemplate.setIrises Method

Sets NETemplate ( see page 80) objects.
213
com.neurotec.biometrics.standards
public final void setIrises(NETemplate value); Parameters Parameters NETemplate value Description NETemplate ( see page 80) object.
8.1.1.1.38.2.14 NTemplate.setPalms Method

Sets NFTemplate ( Java public final void setPalms(NFTemplate value); Parameters Parameters NFTemplate value Description NFTemplate ( see page 130) object. see page 130) object.
8.1.1.1.38.2.15 NTemplate.setVoices Method

Sets NSTemplate ( Java public final void setVoices(NSTemplate value); Parameters Parameters NSTemplate value Description NSTemplate ( see page 207) object. see page 207) object.
8.1.2 com.neurotec.biometrics.standards Package

This package contains classes of supported biometrical standards. Module Java Reference ( Classes Name ANASCIIBinaryRecord ( 217) ANASCIIRecord ( Description see page Contains functionality for work with ASCII-binary ANSI/NIST file records. Provides basic functionality for ANType1Record ( see page 385), ANType2Record ( see page 400) and ANType9Record ( see page 425) logical records. Provides basic functionality for ANImageBinaryRecord ( and ANType8Record ( see page 414) logical records. Represents characters sets. see page 261) see page 59)
see page 220)
ANBinaryRecord ( ANCharset (
see page 222)
see page 223)
ANFAlternateSegment ( 224) ANFAmputation ( ANFCore (
see page Defines alternate approach to describing the locations for each of the image segments of the individual fingers. Defines injured finger position. Core position (CRP) value. Contains the X and Y coordinate position of the core of a fingerprint. The X and Y values shall be coded as a single 8-digit integer number comprised of the 4-digit X-coordinate concatenated with the 4-digit Y-coordinate using a format of XXXXYYYY.
see page 224)
see page 225)
214
8.1 Java Reference ANFDelta ( see page 226)
Delta(s) position (DLT) value. Contain the X and Y positional coordinates of each delta that is present on the fingerprint. The X and Y values shall be recorded in the same manner as was done for the core position coordinates. Provides functionality for managing fields. see Provides basic functionality for ANType3Record ( see page 401), ANType4Record ( see page 404), ANType5Record ( see page 407) and ANType6Record ( see page 410) logical records. Provides basic functionality for ANType13Record ( see page 342), ANType14Record ( see page 349) and ANType15Record ( see page 360) logical records. Represents fingerprint minutia values. see page 246) descriptors.
ANField (
see page 227)
ANFImageBinaryRecord ( page 229) ANFPatternClass (
see page 233) Defines fingerprint pattern classification.
ANFPImageASCIIBinaryRecord ( see page 234) ANFPMinutia ( see page 240)
ANFPositionDescriptor ( 245) ANFPQualityMetric ( 246) ANFPrintPosition ( ANFSegment (
see page Describes search position (
see page see page 247)
Describes NIST Fingerprint Image Quality (NFIQ) scores. Describes print position coordinates. Defines image segments containing individual fingers. Provides basic functionality for ANType10Record ( see page 320), ANType16Record ( see page 366), ANType17Record ( see page 372) and ANFPImageAsciiBinaryRecord logical records. Provides basic functionality for ANFImageBinaryRecord ( see page 229) and ANType8Record ( see page 414) logical records.
see page 249)
ANImageASCIIBinaryRecord ( see page 250) ANImageBinaryRecord ( page 261) ANIrisImageProperties ( 265) ANNISTQualityMetric ( 266) ANPenVector ( see
see page Defines iris image image properties. Properties consists of horizontal orientation, vertical orientation and scan type. see page Represents NIST Fingerprint Image Quality (NFIQ) scores. Specifies a list of vectors describing the pen position and pen pressure ( see page 268) of line segments within the signature. This structure defines quality score ( see page 270) metric. Provides functionality for working with logical records of the ANTemplate ( see page 286). Provides functionality for retrieving types and values from logical records. Describes a general location of the captured scar, mark, tattoo, or other characteristic (including piercings) in the image. Provides functionality for managing subfields. Provides functionality for working with Neurotec.Biometrics.Standards.ANRecord ( see page 270) and Neurotec.Biometrics.Standards.ANTemplate as it is described in ANSI/NIST-ITL 1-2007 standard.
ANQualityMetric ( ANRecord (
ANRecordType ( ANSMT (
ANSubField ( ANTemplate (
ANType10Record ( ANType13Record ( ANType14Record ( ANType15Record ( ANType16Record ( ANType17Record (
see page 320) Provides functions for working with Type-10 Facial & SMT image record. see page 342) Provides functions for working with Variable-resolution latent image record. see page 349) Provides functions for working with Variable-resolution fingerprint image record. see page 360) Provides functionality for working with variable-resolution palmprint image record. see page 366) Provdes functionality for User-defined variable-resolution testing image record. see page 372) Provides functionality for managing iris image record.
215
8.1 Java Reference ANType1Record (
see page 385)
Provides functions for managing Type-1 Transaction information record. A Type-1 logical record is mandatory and is required for each transaction. The Type-1 record provides information describing type and use or purpose for the transaction involved, a listing of each logical record included in the file, the originator or source of the physical record, and other useful and required information items. Contain user-defined textual fields providing identification and descriptive information associated with the subject of the transaction. Data contained in this record conforms in format and content to the specifications of the domain name as listed in Domain Name field found in the Type-1 record. Provides functions and fields for managing low-resolution grayscale fingerprint image. Provides functions and methods for managing High-resolution grayscale fingerprint images. Provides functions and methods for managing Low-resolution binary fingerprint images. Provides functions and methods for managing High-resolution binary fingerprint image. Provides functionality for managing User-defined image record. Provides functions for working with signature image record.
ANType2Record (
see page 400)
ANType3Record ( ANType4Record ( ANType5Record ( ANType6Record ( ANType7Record ( ANType8Record ( ANType99Record (
see page 401) see page 404) see page 407) see page 410) see page 412) see page 414)
see page 420) Contain user-defined textual fields providing identification and descriptive information associated with the subject of the transaction. Data contained in this record conforms in format and content to the specifications of the domain name as listed in Domain Name field found in the Type-1 record. see page 425) see see Provides functions for working with Minutiae data record. Provides properties for getting and setting face feature point. Provides properties for getting and setting fingerprint minutia neighbor. Specifies CBEFF Biometric Data Block (BDB) Format identifiers registered with International Biometric Industry Association (IBIA). Specifies CBEFF biometric organizations identifiers registered with International Biometric Industry Association (IBIA). Contains functionality for managing face records by ANSI INCITS 385-2004, ISO/IEC 19794-5:2005 standards. Face image by ANSI INCITS 385-2004, ISO/IEC 19794-5:2005 standards. Provides functionality for managing FIRecord objects. Provides functionality for working with the FIRFinger objects. Class for working with the FIRFingerView objects. Provides functionality for converting ISO/IEC 19794-2:2005 card format standard templates to and from Neurotechnology Finger Records (NFRecords). Provides constants for ISO/IEC 7816-11:2004 Biometric data template. Provides constants for ISO/IEC 7816-11:2004 Biometric algorithm parameters template in Biometric header template in Biometric information template. Core structure of ANSI/INCIST 378 2004 standard template. Delta structure of ANSI/INCIST 378 2004 standard template. Provides functionality for loading, editing, saving and converting ANSI INCITS 378-2004 and ISO/IEC 19794-2:2005 record format standard templates (FMRecords) to and/or from Neurotechnology Fingers Templates (NFTemplates) and Neurotechnology Templates (NTemplates). Library for working with FMRFinger class object. see
ANType9Record (
BDIFFaceFeaturePoint ( page 435) BDIFFPMinutiaNeighbor ( page 437)
CBEFFBDBFormatIdentifiers ( see page 438) CBEFFBiometricOrganizations ( see page 449) FCRecord ( see page 461) see page 467)
FCRFaceImage ( FIRecord ( FIRFinger ( FMCard (
FIRFingerView (
FMCBDTTags (
see page 502)
FMCBITBHTBAPTTags ( page 503) FMRCore ( FMRDelta ( FMRecord (
FMRFinger (
see page 521)
216
8.1 Java Reference FMRFingerView (
see page 524)
Provides functionality for editing and converting ANSI INCITS 378-2004 and ISO/ IEC 19794-2:2005 record format standard templates finger views (FmrFingerViews) to Neurotechnology Finger Records (NFRecords). Minutiae structure of ANSI/INCIST 378 2004 standard template. Contains functions for managing iris records. Contains functions for managing irises images. Provides methods and properties for managing iris images. Provides methods for retrieving library information.
FMRMinutia ( IIRecord ( IIRIris (
see page 532)
see page 547)
IIRIrisImage (
NBiometricStandards ( 555)
8.1.2.1 Classes
8.1.2.1.1 ANASCIIBinaryRecord Class
Contains functionality for work with ASCII-binary ANSI/NIST file records. Java public class ANASCIIBinaryRecord extends ANRecord; File ANAsciiBinaryRecord.java ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
FLAG_MERGE_DUBLICATE_FIELDS ( see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. see page 273)
ANASCIIBinaryRecord Class Name FIELD_DAT ( FIELD_SRC ( see page 218) see page 218) Description Defines DAT field number. Field referenced by this number contains the date that the transaction was initiated. Defines SRC field number. Field referenced by this number contains the administration or organization that originally captured the latent image contained in the record. Normally, the Originating Agency Identifier, ORI, of the agency that captured the image. Specifies starting number from which user defined field starts.
FIELD_UDF_FROM (
see page 219)
217
8.1 Java Reference FIELD_UDF_TO (
see page 219)
Defines end number of user defined field starts. see page Defines maximal quality score value for record data. see Defines maximal value length of field referenced by FieldSrc field number. see Defines maximal value length of field referenced by FieldSrc field number in current implementation of ANSI-NIST standard in ANTemplate ( see page 286). Defines minimal value length of field referenced by FieldSrc field number. Defines code when quality assessment algorithm failed to asses record data quality.
MAX_QUALITY_METRIC_SCORE ( 219) MAX_SOURCE_AGENCY_LENGTH ( page 219)
MAX_SOURCE_AGENCY_LENGTH_V4 ( page 219) MIN_SOURCE_AGENCY_LENGTH ( page 219) QUALITY_METRIC_SCORE_FAILED ( page 219) see
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
getRecordType ( isValidated ( setData ( setIdc ( size ( nativeTypeOf (
see page 275)
ANASCIIBinaryRecord Class Name getDate ( see page 219) see page 220) getSourceAgency ( nativeTypeOf ( setDate ( Description Gets field referenced by FieldDat field number. Retrieves a function that retrieves NType object for the enclosing type. Sets field referenced by FieldDat field number. see page 220) Gets source agency identification.
see page 220)
setSourceAgency (
see page 220) Sets source agency identification.
8.1.2.1.1.1 ANASCIIBinaryRecord Fields

8.1.2.1.1.1.1 ANASCIIBinaryRecord.FIELD_DAT Field
Defines DAT field number. Field referenced by this number contains the date that the transaction was initiated. Java public static final int FIELD_DAT = 5;
8.1.2.1.1.1.2 ANASCIIBinaryRecord.FIELD_SRC Field

Defines SRC field number. Field referenced by this number contains the administration or organization that originally captured the latent image contained in the record. Normally, the Originating Agency Identifier, ORI, of the agency that captured the image. Java public static final int FIELD_SRC = 4;
218
8.1 Java Reference
8.1.2.1.1.1.3 ANASCIIBinaryRecord.FIELD_UDF_FROM Field

Specifies starting number from which user defined field starts. Java public static final int FIELD_UDF_FROM = 200;
8.1.2.1.1.1.4 ANASCIIBinaryRecord.FIELD_UDF_TO Field

Defines end number of user defined field starts. Java public static final int FIELD_UDF_TO = 998;
8.1.2.1.1.1.5 ANASCIIBinaryRecord.MAX_QUALITY_METRIC_SCORE Field

Defines maximal quality score value for record data. Java public static final byte MAX_QUALITY_METRIC_SCORE = 100;
8.1.2.1.1.1.6 ANASCIIBinaryRecord.MAX_SOURCE_AGENCY_LENGTH Field

Defines maximal value length of field referenced by FieldSrc field number. Java public static final int MAX_SOURCE_AGENCY_LENGTH = 20;
8.1.2.1.1.1.7 ANASCIIBinaryRecord.MAX_SOURCE_AGENCY_LENGTH_V4 Field

Defines maximal value length of field referenced by FieldSrc field number in current implementation of ANSI-NIST standard in ANTemplate ( see page 286). Java public static final int MAX_SOURCE_AGENCY_LENGTH_V4 = 35;
8.1.2.1.1.1.8 ANASCIIBinaryRecord.MIN_SOURCE_AGENCY_LENGTH Field

Defines minimal value length of field referenced by FieldSrc field number. Java public static final int MIN_SOURCE_AGENCY_LENGTH = 9;
8.1.2.1.1.1.9 ANASCIIBinaryRecord.QUALITY_METRIC_SCORE_FAILED Field

Defines code when quality assessment algorithm failed to asses record data quality. Java public static final byte QUALITY_METRIC_SCORE_FAILED = (byte) 255;
8.1.2.1.1.1.10 ANASCIIBinaryRecord.QUALITY_METRIC_SCORE_NOT_AVAILABLE Field

Defines code when quality score has not been calculated or provided for data contained in record object. Java public static final byte QUALITY_METRIC_SCORE_NOT_AVAILABLE = (byte) 254;
8.1.2.1.1.2 ANASCIIBinaryRecord Methods

8.1.2.1.1.2.1 ANASCIIBinaryRecord.getDate Method
Gets field referenced by FieldDat field number.
219
8.1 Java Reference Java public final Date getDate(); Returns
Date object that contains transaction initiation date.
8.1.2.1.1.2.2 ANASCIIBinaryRecord.getSourceAgency Method

Gets source agency identification. Java public final String getSourceAgency(); Returns String containing source agency identification string.
8.1.2.1.1.2.3 ANASCIIBinaryRecord.nativeTypeOf Method

8.1.2.1.1.2.4 ANASCIIBinaryRecord.setDate Method

Sets field referenced by FieldDat field number. Java public final void setDate(Date value); Parameters Parameters Date value Description Date object that contains transaction initiation date.
8.1.2.1.1.2.5 ANASCIIBinaryRecord.setSourceAgency Method

Sets source agency identification. Java public final void setSourceAgency(String value); Parameters Parameters String value Description String containing source agency identification string.
8.1.2.1.2 ANASCIIRecord Class

Provides basic functionality for ANType1Record ( ( see page 425) logical records. Java public class ANASCIIRecord extends ANRecord; File ANAsciiRecord.java see page 385), ANType2Record ( see page 400) and ANType9Record
220
8.1 Java Reference ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC (
Description see page 271) Represent collection of subfields in field.
Description see page 272) see page 272) Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged.
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( ANASCIIRecord Class Name MAX_FIELD_NUMBER ( page 221) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270). see Description Defines maximum quantity of fields in record of Type-1, Type-2 and Type-9. see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. see page 273)
see page 275)
ANASCIIRecord Class Name nativeTypeOf ( see page 222) Description Retrieves a function that retrieves NType object for the enclosing type.
8.1.2.1.2.1 ANASCIIRecord Fields

8.1.2.1.2.1.1 ANASCIIRecord.MAX_FIELD_NUMBER Field
Defines maximum quantity of fields in record of Type-1, Type-2 and Type-9. Java public static final int MAX_FIELD_NUMBER = 999999999;
8.1.2.1.2.2 ANASCIIRecord Methods

221
8.1 Java Reference
8.1.2.1.2.2.1 ANASCIIRecord.nativeTypeOf Method

8.1.2.1.3 ANBinaryRecord Class

Provides basic functionality for ANImageBinaryRecord ( records. Java public class ANBinaryRecord extends ANRecord; File ANBinaryRecord.java ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. see page 271) Description Represent collection of subfields in field. see page 261) and ANType8Record ( see page 414) logical
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270). see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. see page 273)
see page 275)
222
8.1 Java Reference ANBinaryRecord Class Name nativeTypeOf (
Description see page 223) Retrieves a function that retrieves NType object for the enclosing type.
8.1.2.1.3.1 ANBinaryRecord Methods

8.1.2.1.3.1.1 ANBinaryRecord.nativeTypeOf Method
8.1.2.1.4 ANCharset Class

Represents characters sets. Java public final class ANCharset; File ANCharset.java Methods Name ANCharset ( ANCharset Fields Name name ( version ( see page 223) see page 224) Description String containing character set name. String containing character set version. see page 223) Description Initializes new instance of ANCharset structure.
8.1.2.1.4.1 ANCharset.ANCharset Constructor

Initializes new instance of ANCharset structure. Java public ANCharset(int index, String name, String version); Parameters Parameters int index String name String version Description Character set index. Character set name ( Character set version ( see page 223). see page 224).
8.1.2.1.4.2 ANCharset Fields

8.1.2.1.4.2.1 ANCharset.name Field
String containing character set name. Java public String name; 223
8.1 Java Reference
8.1.2.1.4.2.2 ANCharset.version Field

String containing character set version. Java public String version;
8.1.2.1.5 ANFAlternateSegment Class

Defines alternate approach to describing the locations for each of the image segments of the individual fingers. Java public final class ANFAlternateSegment; File ANFAlternateSegment.java Methods Name ANFAlternateSegment ( 224) Description see page Initializes new instance of ANFAlternateSegment structure.
8.1.2.1.5.1 ANFAlternateSegment.ANFAlternateSegment Constructor

Initializes new instance of ANFAlternateSegment structure. Java public ANFAlternateSegment(BDIFFPPosition position); Parameters Parameters BDIFFPPosition position Description One of BDIFFPPosition values representing fingerprint position code.
8.1.2.1.6 ANFAmputation Class

Defines injured finger position. Java public final class ANFAmputation; File ANFAmputation.java Remarks Structure contains two information items. The first item is the finger number between one and ten. The second item is the amputated or bandaged code (AMPCD). Allowable indicators for the AMPCD are listed bellow: Amputation - XX Unable to print (e.g., bandaged) - UP. Methods Name ANFAmputation ( ANFAmputation Fields Name type ( see page 225) Description ANFAmputationType object representing injury type. 224 see page 225) Description Initializes new instance of ANFAmputation structure.
8.1 Java Reference
8.1.2.1.6.1 ANFAmputation.ANFAmputation Constructor

Initializes new instance of ANFAmputation structure. Java public ANFAmputation(BDIFFPPosition position, ANFAmputationType type); Parameters Parameters BDIFFPPosition position ANFAmputationType type Description One of BDIFFPPosition values defining fingerprint position. One of ANFAmputationType values defining injury type ( see page 225).
8.1.2.1.6.2 ANFAmputation Fields

8.1.2.1.6.2.1 ANFAmputation.type Field
ANFAmputationType object representing injury type. Java public ANFAmputationType type;
8.1.2.1.7 ANFCore Class

Core position (CRP) value. Contains the X and Y coordinate position of the core of a fingerprint. The X and Y values shall be coded as a single 8-digit integer number comprised of the 4-digit X-coordinate concatenated with the 4-digit Y-coordinate using a format of XXXXYYYY. Java public final class ANFCore; File ANFCore.java Methods Name ANFCore ( ANFCore Fields Name y( see page 226) Description Number representing y position of the core. see page 225) Description Initializes new instance of ANFCore structure.
8.1.2.1.7.1 ANFCore.ANFCore Constructor

Initializes new instance of ANFCore structure. Java public ANFCore(short x, short y); Parameters Parameters short x short y Description The x - coordinate of the core. The y ( see page 226) - coordinate of the core.
8.1.2.1.7.2 ANFCore Fields
225
8.1 Java Reference
8.1.2.1.7.2.1 ANFCore.y Field

Number representing y position of the core. Java public short y;
8.1.2.1.8 ANFDelta Class

Delta(s) position (DLT) value. Contain the X and Y positional coordinates of each delta that is present on the fingerprint. The X and Y values shall be recorded in the same manner as was done for the core position coordinates. Java public final class ANFDelta; File ANFDelta.java Methods Name ANFDelta ( ANFDelta Fields Name x( y( see page 226) see page 227) Description Number representing x position of the delta. Number representing y position of the delta. see page 226) Description Initializes new instance of ANFDelta structure.
8.1.2.1.8.1 ANFDelta Constructor

8.1.2.1.8.1.1 ANFDelta.ANFDelta Constructor ()
Initializes new instance of ANFDelta structure. Java public ANFDelta();
8.1.2.1.8.1.2 ANFDelta.ANFDelta Constructor (short, short)

Initializes new instance of ANFDelta structure. Java public ANFDelta(short x, short y); Parameters Parameters short x short y Description The x ( The y ( see page 226) - coordinate of the delta. see page 227) - coordinate of the delta.
8.1.2.1.8.2 ANFDelta Fields

8.1.2.1.8.2.1 ANFDelta.x Field
Number representing x position of the delta. Java public short x;
226
8.1 Java Reference
8.1.2.1.8.2.2 ANFDelta.y Field

Number representing y position of the delta. Java public short y;
8.1.2.1.9 ANField Class

Provides functionality for managing fields. Java public final class ANField extends NObject; File ANField.java ANField Classes Name ItemCollection ( see page 227) see page SubFieldCollection ( 227) ANField Methods Name getItems ( see page 228) see page 228) see page 228) see page 229) see page 229) see page 229) getNumber ( getSubFields ( getValue ( setValue ( nativeTypeOf ( Description Gets particular item from the ANField. Gets item value as number. Gets particular subfield from the ANField. Gets field value. Retrieves a function that retrieves NType object for the enclosing type. Sets field value. Description Represent collection of items in field. Represent collection of subfields in field.
8.1.2.1.9.1 ANField Classes

8.1.2.1.9.1.1 ANField.ItemCollection Class
Represent collection of items in field. Java public final class ItemCollection extends StringCollection; File ANField.java
8.1.2.1.9.1.2 ANField.SubFieldCollection Class

Represent collection of subfields in field. Java public final class SubFieldCollection extends NObjectCollection<ANSubField>; File ANField.java SubFieldCollection Methods Name add ( see page 228) Description Adds subfield to SubFieldCollection with initial count of items in it. 227
8.1 Java Reference
8.1.2.1.9.1.2.1 SubFieldCollection Methods 8.1.2.1.9.1.2.1.1 add Method 8.1.2.1.9.1.2.1.1.1 ANField.SubFieldCollection.add Method (String)
Adds subfield to SubFieldCollection ( Java public ANSubField add(String value); Parameters Parameters String value Returns ANSubField ( see page 285) object representing newly added subfield. Description String containing subfield value. see page 227) with initial count of items in it.
8.1.2.1.9.1.2.1.1.2 ANField.SubFieldCollection.add Method (int, String)

Inserts subfield to SubFieldCollection ( Java public ANSubField add(int index, String value); Parameters Parameters int index String value Returns ANSubField ( see page 285) object representing newly inserted subfield. Description Index to insert to. String containing subfield value. see page 227) at specified index with initial count of items in it.
8.1.2.1.9.2 ANField Methods

8.1.2.1.9.2.1 ANField.getItems Method
Gets particular item from the ANField ( Java public ItemCollection getItems(); Returns A ItemCollection ( see page 227) representing items from ANSubField ( see page 285). see page 227).
8.1.2.1.9.2.2 ANField.getNumber Method

Gets item value as number. Java public int getNumber(); Returns Number containing item value.
8
8.1.2.1.9.2.3 ANField.getSubFields Method
Gets particular subfield from the ANField ( see page 227). 228
public SubFieldCollection getSubFields(); Returns A SubFieldCollection ( see page 227) representing subfield from ANField ( see page 227).
8.1.2.1.9.2.4 ANField.getValue Method

Gets field value. Java public String getValue(); Returns String containing field value.
8.1.2.1.9.2.5 ANField.nativeTypeOf Method

8.1.2.1.9.2.6 ANField.setValue Method

Sets field value. Java public void setValue(String value); Parameters Parameters String value Description String containing field value.
8.1.2.1.10 ANFImageBinaryRecord Class

Provides basic functionality for ANType3Record ( see page 401), ANType4Record ( see page 407) and ANType6Record ( see page 410) logical records. Java public class ANFImageBinaryRecord extends ANImageBinaryRecord; File ANFImageBinaryRecord.java ANRecord Classes Name FieldCollection ( ANFImageBinaryRecord Class Name PositionCollection ( Description see page 231) Represent collection of fingerprint positions. see page 271) Description Represent collection of subfields in field. see page 404), ANType5Record (
229
8.1 Java Reference ANRecord Fields Name FIELD_DATA ( FIELD_IDC (
FIELD_LEN (
see page 273)
ANImageBinaryRecord Class Name Description
AN_IMAGE_BINARY_RECORD_FIELD_HLL Defines HLL field number. Field referenced by this number ( see page 263) contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). AN_IMAGE_BINARY_RECORD_FIELD_ISR Defines ISE field number. Field referenced by this number ( see page 263) contains flag of image scanning resolution. AN_IMAGE_BINARY_RECORD_FIELD_VLL Defines VLL field number. Field referenced by this number ( see page 263) contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. ANFImageBinaryRecord Class Name FIELD_CA ( FIELD_FGP ( FIELD_IMP ( see page 231) see page 231) see page 232) see Description Defines CA field number. Field referenced by this number specify the type of compression algorithm used(if any). Defines FGP field number. Field represented by this number contains possible finger positions. Defined IMP field number. Field referenced by this number describes the manner by which the fingerprint image information has been obtained. Defines maximum count of positions in fingerprint record.
MAX_POSITION_COUNT ( page 232) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc (
Description see page 273) see page 273) see page 274) see page 274) see page 274) Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
230
8.1 Java Reference ANBinaryRecord Class Name nativeTypeOf ( ANImageBinaryRecord Class Name getHorzLineLength ( 263) getImageResolution ( 263)
Description see page see page Gets or horizontal line length value. Gets image resolution value. Gets value of image scanning resolution.
getImageScanResolutionValue ( see page 264) getVertLineLength ( isImageScanResolution ( page 264) nativeTypeOf ( toNImage ( see
see page 264) Gets or vertical line length value. Gets flag which defines what type of image scan resolution was used. Retrieves a function that retrieves NType object for the enclosing type. Converts image contained in logical record to NImage format.
see page 264)
see page 264)
ANFImageBinaryRecord Class Name getImpressionType ( 232) getPositions ( nativeTypeOf ( see page Description Gets the fingerprint impression type. Gets fingerprint positions contained in record. Retrieves a function that retrieves NType object for the enclosing type. Sets the fingerprint impression type.
setImpressionType ( 232)
8.1.2.1.10.1 ANFImageBinaryRecord Classes

8.1.2.1.10.1.1 ANFImageBinaryRecord.PositionCollection Class
Represent collection of fingerprint positions. Java public final class PositionCollection extends NEnumCollection<BDIFFPPosition>; File ANFImageBinaryRecord.java
8.1.2.1.10.2 ANFImageBinaryRecord Fields

8.1.2.1.10.2.1 ANFImageBinaryRecord.FIELD_CA Field
Defines CA field number. Field referenced by this number specify the type of compression algorithm used(if any). Java public static final int FIELD_CA = 8;
8.1.2.1.10.2.2 ANFImageBinaryRecord.FIELD_FGP Field

Defines FGP field number. Field represented by this number contains possible finger positions. Java public static final int FIELD_FGP = 4;
231
8.1 Java Reference
8.1.2.1.10.2.3 ANFImageBinaryRecord.FIELD_IMP Field

Defined IMP field number. Field referenced by this number describes the manner by which the fingerprint image information has been obtained. Java public static final int FIELD_IMP = 3;
8.1.2.1.10.2.4 ANFImageBinaryRecord.MAX_POSITION_COUNT Field

Defines maximum count of positions in fingerprint record. Java public static final int MAX_POSITION_COUNT = 6;
8.1.2.1.10.3 ANFImageBinaryRecord Methods

8.1.2.1.10.3.1 ANFImageBinaryRecord.getImpressionType Method
Gets the fingerprint impression type. Java public final BDIFFPImpressionType getImpressionType(); Returns Return one of BDIFFPImpressionType values.
8.1.2.1.10.3.2 ANFImageBinaryRecord.getPositions Method

Gets fingerprint positions contained in record. Java public final PositionCollection getPositions(); Returns PositionCollection ( see page 231) representing fingerprint positions.
8.1.2.1.10.3.3 ANFImageBinaryRecord.nativeTypeOf Method

8.1.2.1.10.3.4 ANFImageBinaryRecord.setImpressionType Method

Sets the fingerprint impression type. Java public final void setImpressionType(BDIFFPImpressionType value); Parameters Parameters BDIFFPImpressionType value Description Return one of BDIFFPImpressionType values.
232
8.1 Java Reference
8.1.2.1.11 ANFPatternClass Class

Defines fingerprint pattern classification. Java public final class ANFPatternClass; File ANFPatternClass.java Methods Name ANFPatternClass ( ANFPatternClass Fields Name value ( see page 233) see page 233) vendorValue ( Description BdifFPatternClass object representing standard pattern class. String containing vendor pattern class description. Description see page 233) Initializes new instance of ANFPatternClass structure.
8.1.2.1.11.1 ANFPatternClass Constructor

8.1.2.1.11.1.1 ANFPatternClass.ANFPatternClass Constructor ()
Initializes new instance of ANFPatternClass structure. Java public ANFPatternClass();
8.1.2.1.11.1.2 ANFPatternClass.ANFPatternClass Constructor (BDIFFPatternClass, String)

Initializes new instance of ANFPatternClass structure. Java public ANFPatternClass(BDIFFPatternClass value, String vendorValue); Parameters Parameters String vendorValue standardValue Description String containing vendor pattern class description. One of BDIFFPatternClass values representing standard pattern classes.
8.1.2.1.11.2 ANFPatternClass Fields

8.1.2.1.11.2.1 ANFPatternClass.value Field
BdifFPatternClass object representing standard pattern class. Java public BDIFFPatternClass value;
8.1.2.1.11.2.2 ANFPatternClass.vendorValue Field

String containing vendor pattern class description. Java public String vendorValue;
233
8.1 Java Reference
8.1.2.1.12 ANFPImageASCIIBinaryRecord Class

Provides basic functionality for ANType13Record ( ANType15Record ( see page 360) logical records. Java public class ANFPImageASCIIBinaryRecord extends ANImageASCIIBinaryRecord; File ANFPImageAsciiBinaryRecord.java ANRecord Classes Name FieldCollection ( see page 271) Description Represent collection of subfields in field. see page 342), ANType14Record ( see page 349) and
ANFPImageASCIIBinaryRecord Class Name PositionCollection ( PrintPositionCollection ( 238) QualityMetricCollection ( page 238) ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. Description see page 238) Represent collection of fingerprint positions. see page Represent collection of print positions. see Represent collection of fingerprint quality metrics.
FIELD_LEN (
see page 273)
ANASCIIBinaryRecord Class Name FIELD_DAT ( FIELD_SRC ( see page 218) see page 218) Description Defines DAT field number. Field referenced by this number contains the date that the transaction was initiated. Defines SRC field number. Field referenced by this number contains the administration or organization that originally captured the latent image contained in the record. Normally, the Originating Agency Identifier, ORI, of the agency that captured the image. Specifies starting number from which user defined field starts. Defines end number of user defined field starts. see page Defines maximal quality score value for record data.
FIELD_UDF_FROM ( FIELD_UDF_TO (
see page 219)
see page 219)
8
see Defines maximal value length of field referenced by FieldSrc field number.
234
8.1 Java Reference
see Defines maximal value length of field referenced by FieldSrc field number in current implementation of ANSI-NIST standard in ANTemplate ( see page 286). Defines minimal value length of field referenced by FieldSrc field number. Defines code when quality assessment algorithm failed to asses record data quality.
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANImageASCIIBinaryRecord Class Name FIELD_BPX ( see page 254) Description Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data. Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image.
FIELD_CGA (
see page 254)
FIELD_COM (
see page 254)
FIELD_CSP (
see page 255)
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
235
8.1 Java Reference FIELD_VPS (
see page 256)
Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
MAX_COMMENT_LENGTH ( MAX_LINE_LENGTH ( MAX_PIXEL_SCALE (
MAX_VENDOR_COMPRESSION_ALGORITHM_LENGTH Defines maximal length of vendor compression ( see page 256) algorithm description. MIN_LATENT_PIXEL_SCALE_PPCM ( see page 256) Defines minimal pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286).
MIN_LATENT_PIXEL_SCALE_PPI (
see page 256)
MIN_LATENT_PIXEL_SCALE_V4_PPCM ( 257)
see page
MIN_LATENT_PIXEL_SCALE_V4_PPI (
see page 257)
MIN_LATENT_SCAN_PIXEL_SCALE_PPCM ( 257)
see page Defines minimal scanned pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal scanned pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal scanned pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Defines minimal scanned pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per centimeter. Defines minimal pixel scale value per inch. Defines minimal scanned pixel scale value per centimeter. Defines minimal scanned pixel scale value per inch. Defines minimal length of vendor compression algorithm description.
MIN_LATENT_SCAN_PIXEL_SCALE_PPI ( 257)
see page
MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPCM ( page 257)
see
MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPI ( page 257)
see
MIN_PIXEL_SCALE_PPCM ( MIN_PIXEL_SCALE_PPI (
see page 257)
MIN_SCAN_PIXEL_SCALE_PPCM ( MIN_SCAN_PIXEL_SCALE_PPI (
see page 258)
MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH ( see page 258) ANFPImageASCIIBinaryRecord Class Name FIELD_FGP ( see page 239) Description
Defines FGP field number. Field referenced by this number contains one or more possible finger or palm positions that may match the latent image.
236
8.1 Java Reference FIELD_IMP ( FIELD_PD ( FIELD_PPC (
Defines IMP field number. Field referenced by this number indicates the manner by which the latent image information was obtained. Defines PD field number. Field referenced by this number is used to narrow the search of the latent image in this record against a database. Defined PPC field number. Field referenced by this number contains offsets to the locations for the bounding box of the EJI, each of the full finger views, or segments within the EJI. Defines maximum number of finger or palm position (FGP) in one record. Defines maximum number of Print Position Coordinates (PPC).
MAX_POSITION_COUNT ( page 239)
see
MAX_PRINT_POSITION_COUNT ( see page 239) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274)
Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
see page 220)
setSourceAgency (
ANImageASCIIBinaryRecord Class Name getBitsPerPixel ( getColorSpace ( getComment ( see page 258) see page 258) see page 258) see see Description Gets number of bits used to represent a pixel (BPP). Gets color space used to exchange the image data. Gets or sets textual information associated with image located in ANRecord ( see page 270) object. Gets compression algorithm used to compress image data. Gets device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Gets or horizontal line length value.
getCompressionAlgorithm ( page 258) getDeviceMonitoringMode ( page 259) getHorzLineLength ( 259) getHorzPixelScale ( getScaleUnits (
see page
see page 259) Gets horizontal pixel scale of image. Gets scale units value. Gets scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. see
see page 259)
getScanHorzPixelScale ( page 259) getScanVertPixelScale ( 259)
see page Gets scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression.
237
8.1 Java Reference
getVendorCompressionAlgorithm ( see page 260) getVertLineLength ( getVertPixelScale ( nativeTypeOf ( setComment (
Gets description of vendor compression algorithm, that has been used to compress the transmitted images.
see page 260) Gets or vertical line length value. see page 260) Gets vertical pixel scale of image. Retrieves a function that retrieves NType object for the enclosing type. Gets or sets textual information associated with image located in ANRecord ( see page 270) object. Sets device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Sets scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression.
setDeviceMonitoringMode ( page 260) setScanHorzPixelScale ( page 261) setScanVertPixelScale ( 261) toNImage (
see
see page Sets scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression. Converts image contained in logical record to NImage format.
see page 261)
ANFPImageASCIIBinaryRecord Class Name getImpressionType ( 239) getPositions ( getPrintPositions ( getQualityMetrics ( nativeTypeOf ( setImpressionType ( 240) see page Description Gets the fingerprint impression type. Gets fingerprint positions contained in record. Gets fingerprint print positions contained in record. Retrieves a function that retrieves NType object for the enclosing type. Sets the fingerprint impression type.
see page 240) Gets fingerprint quality metrics contained in record. see page
see page 240)
8.1.2.1.12.1 ANFPImageASCIIBinaryRecord Classes

8.1.2.1.12.1.1 ANFPImageASCIIBinaryRecord.PositionCollection Class
Represent collection of fingerprint positions. Java public final class PositionCollection extends NEnumCollection<BDIFFPPosition>; File ANFPImageAsciiBinaryRecord.java
8.1.2.1.12.1.2 ANFPImageASCIIBinaryRecord.PrintPositionCollection Class

Represent collection of print positions. Java public final class PrintPositionCollection extends NStructureCollection<ANFPrintPosition, ANFPrintPositionData>; File ANFPImageAsciiBinaryRecord.java
8.1.2.1.12.1.3 ANFPImageASCIIBinaryRecord.QualityMetricCollection Class

Represent collection of fingerprint quality metrics. Java public final class QualityMetricCollection extends NStructureCollection<ANFPQualityMetric, ANFPQualityMetricData>;
238
8.1 Java Reference File ANFPImageAsciiBinaryRecord.java
8.1.2.1.12.2 ANFPImageASCIIBinaryRecord Fields

8.1.2.1.12.2.1 ANFPImageASCIIBinaryRecord.FIELD_FGP Field
Defines FGP field number. Field referenced by this number contains one or more possible finger or palm positions that may match the latent image. Java public static final int FIELD_FGP = 13;
8.1.2.1.12.2.2 ANFPImageASCIIBinaryRecord.FIELD_IMP Field

Defines IMP field number. Field referenced by this number indicates the manner by which the latent image information was obtained. Java public static final int FIELD_IMP = 3;
8.1.2.1.12.2.3 ANFPImageASCIIBinaryRecord.FIELD_PD Field

Defines PD field number. Field referenced by this number is used to narrow the search of the latent image in this record against a database. Java public static final int FIELD_PD = 14;
8.1.2.1.12.2.4 ANFPImageASCIIBinaryRecord.FIELD_PPC Field

Defined PPC field number. Field referenced by this number contains offsets to the locations for the bounding box of the EJI, each of the full finger views, or segments within the EJI. Java public static final int FIELD_PPC = 15;
8.1.2.1.12.2.5 ANFPImageASCIIBinaryRecord.MAX_POSITION_COUNT Field

Defines maximum number of finger or palm position (FGP) in one record. Java public static final int MAX_POSITION_COUNT = 6;
8.1.2.1.12.2.6 ANFPImageASCIIBinaryRecord.MAX_PRINT_POSITION_COUNT Field

Defines maximum number of Print Position Coordinates (PPC). Java public static final int MAX_PRINT_POSITION_COUNT = 12;
8.1.2.1.12.3 ANFPImageASCIIBinaryRecord Methods

8.1.2.1.12.3.1 ANFPImageASCIIBinaryRecord.getImpressionType Method
Gets the fingerprint impression type. Java public final BDIFFPImpressionType getImpressionType(); Returns Return one of BDIFFPImpressionType values. 239
8.1 Java Reference
8.1.2.1.12.3.2 ANFPImageASCIIBinaryRecord.getPositions Method

Gets fingerprint positions contained in record. Java public final PositionCollection getPositions(); Returns PositionCollection ( see page 238) representing fingerprint positions.
8.1.2.1.12.3.3 ANFPImageASCIIBinaryRecord.getPrintPositions Method

Gets fingerprint print positions contained in record. Java public final PrintPositionCollection getPrintPositions(); Returns PrintPositionCollection ( see page 238) representing fingerprint print positions.
8.1.2.1.12.3.4 ANFPImageASCIIBinaryRecord.getQualityMetrics Method

Gets fingerprint quality metrics contained in record. Java public final QualityMetricCollection getQualityMetrics(); Returns QualityMetricCollection ( see page 238) representing fingerprint quality metrics.
8.1.2.1.12.3.5 ANFPImageASCIIBinaryRecord.nativeTypeOf Method

8.1.2.1.12.3.6 ANFPImageASCIIBinaryRecord.setImpressionType Method

Sets the fingerprint impression type. Java public final void setImpressionType(BDIFFPImpressionType value); Parameters Parameters BDIFFPImpressionType value Description Return one of BDIFFPImpressionType values.
8.1.2.1.13 ANFPMinutia Class

Represents fingerprint minutia values. Java public final class ANFPMinutia;
240
8.1 Java Reference File ANFPMinutia.java Methods Name ANFPMinutia ( ANFPMinutia Fields Name quality ( theta ( type ( x( y( see page 244) see page 244) see page 244)
Description see page 241) Initializes new instance of ANFPMinutia structure.
Description Number representing confidence in minutiae quality. Number representing angle in radians. BdifFPMinutiaType object representing minutiae type. Number representing x position of the minutiae. Number representing y position of the minutiae.
ANFPMinutia Methods Name getTheta ( setTheta ( see page 244) see page 244) Description Gets angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Sets angle between the horizontal axis of the coordinate system and the direction that a ridge ending points.
8.1.2.1.13.1 ANFPMinutia Constructor

8.1.2.1.13.1.1 ANFPMinutia.ANFPMinutia Constructor ()
Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia();
8.1.2.1.13.1.2 ANFPMinutia.ANFPMinutia Constructor (int, int, double)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, double theta); Parameters Parameters int x int y double theta Description The x ( The y ( see page 244) coordinate of the minutia. see page 244) coordinate of the minutia.
Angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Angle is in degrees.
8.1.2.1.13.1.3 ANFPMinutia.ANFPMinutia Constructor (int, int, double, BDIFFPMinutiaType)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, double theta, BDIFFPMinutiaType type); Parameters Parameters int x Description The x ( see page 244) coordinate of the minutia.
241
8.1 Java Reference int y double theta
The y (
see page 244) coordinate of the minutia.
Angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Angle is in degrees. One of BDIFFPMinutiaType values.
BDIFFPMinutiaType type
8.1.2.1.13.1.4 ANFPMinutia.ANFPMinutia Constructor (int, int, double, byte)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, double theta, byte quality); Parameters Parameters int x int y double theta Description The x ( The y ( see page 244) coordinate of the minutia. see page 244) coordinate of the minutia.
Angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Angle is in degrees. Minutiae quality ( see page 244) measure value. Values shall range from "0" to "63". The value "0" shall indicate a manually encoded minutia. The value "1" shall indicate that no method of indicating a confidence level is available. Values between "2" and "63" shall indicate decreasing levels of confidence, with "2" meaning the greatest confidence.
byte quality
8.1.2.1.13.1.5 ANFPMinutia.ANFPMinutia Constructor (int, int, double, byte, BDIFFPMinutiaType)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, double theta, byte quality, BDIFFPMinutiaType type); Parameters Parameters int x int y double theta Description The x ( The y ( see page 244) coordinate of the minutia. see page 244) coordinate of the minutia.
Angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Angle is in degrees. Minutiae quality ( see page 244) measure value. Values shall range from "0" to "63". The value "0" shall indicate a manually encoded minutia. The value "1" shall indicate that no method of indicating a confidence level is available. Values between "2" and "63" shall indicate decreasing levels of confidence, with "2" meaning the greatest confidence. One of BDIFFPMinutiaType values.
byte quality
8.1.2.1.13.1.6 ANFPMinutia.ANFPMinutia Constructor (int, int, short)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, short theta); Parameters Parameters int x Description The x ( see page 244) coordinate of the minutia. 242
8.1 Java Reference int y short theta
The y (
see page 244) coordinate of the minutia.
8.1.2.1.13.1.7 ANFPMinutia.ANFPMinutia Constructor (int, int, short, BDIFFPMinutiaType)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, short theta, BDIFFPMinutiaType type); Parameters Parameters int x int y short theta Description The x ( The y ( see page 244) coordinate of the minutia. see page 244) coordinate of the minutia.
Angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Angle is in degrees. One of BDIFFPMinutiaType values.
8.1.2.1.13.1.8 ANFPMinutia.ANFPMinutia Constructor (int, int, short, byte)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, short theta, byte quality); Parameters Parameters int x int y short theta Description The x ( The y ( see page 244) coordinate of the minutia. see page 244) coordinate of the minutia.
Angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Angle is in degrees. Minutiae quality ( see page 244) measure value. Values shall range from "0" to "63". The value "0" shall indicate a manually encoded minutia. The value "1" shall indicate that no method of indicating a confidence level is available. Values between "2" and "63" shall indicate decreasing levels of confidence, with "2" meaning the greatest confidence.
byte quality
8.1.2.1.13.1.9 ANFPMinutia.ANFPMinutia Constructor (int, int, short, byte, BDIFFPMinutiaType)

Initializes new instance of ANFPMinutia structure. Java public ANFPMinutia(int x, int y, short theta, byte quality, BDIFFPMinutiaType type); Parameters Parameters int x int y short theta Description The x ( The y ( see page 244) coordinate of the minutia. see page 244) coordinate of the minutia.
243
8.1 Java Reference byte quality
Minutiae quality ( see page 244) measure value. Values shall range from "0" to "63". The value "0" shall indicate a manually encoded minutia. The value "1" shall indicate that no method of indicating a confidence level is available. Values between "2" and "63" shall indicate decreasing levels of confidence, with "2" meaning the greatest confidence. One of BDIFFPMinutiaType values.
8.1.2.1.13.2 ANFPMinutia Fields

8.1.2.1.13.2.1 ANFPMinutia.quality Field
Number representing confidence in minutiae quality. Java public byte quality;
8.1.2.1.13.2.2 ANFPMinutia.theta Field

Number representing angle in radians. Java public short theta;
8.1.2.1.13.2.3 ANFPMinutia.type Field

BdifFPMinutiaType object representing minutiae type. Java public BDIFFPMinutiaType type;
8.1.2.1.13.2.4 ANFPMinutia.x Field

Number representing x position of the minutiae. Java public int x;
8.1.2.1.13.2.5 ANFPMinutia.y Field

Number representing y position of the minutiae. Java public int y;
8.1.2.1.13.3 ANFPMinutia Methods

8.1.2.1.13.3.1 ANFPMinutia.getTheta Method
Gets angle between the horizontal axis of the coordinate system and the direction that a ridge ending points. Java public double getTheta(); Returns Number representing angle in radians.
8.1.2.1.13.3.2 ANFPMinutia.setTheta Method

Sets angle between the horizontal axis of the coordinate system and the direction that a ridge ending points.
244
public void setTheta(double value); Parameters Parameters double value Description Number representing angle in radians.
8.1.2.1.14 ANFPositionDescriptor Class

Describes search position ( Java public final class ANFPositionDescriptor; File ANFPositionDescriptor.java Methods Name ANFPositionDescriptor ( 245) ANFPositionDescriptor Fields Name portion ( position ( see page 245) see page 246) Description ANFMajorCase object representing fingerprint position ( code. ANFMajorCase object representing the portion ( image. see page 246) Description see page Initializes new instance of ANFPositionDescriptor structure. see page 246) descriptors.
see page 245) of the
8.1.2.1.14.1 ANFPositionDescriptor Constructor

8.1.2.1.14.1.1 ANFPositionDescriptor.ANFPositionDescriptor Constructor ()
Initializes new instance of ANFPositionDescriptor structure. Java public ANFPositionDescriptor();
8.1.2.1.14.1.2 ANFPositionDescriptor.ANFPositionDescriptor Constructor (BDIFFPPosition, ANFMajorCase)

Initializes new instance of ANFPositionDescriptor structure. Java public ANFPositionDescriptor(BDIFFPPosition position, ANFMajorCase portion); Parameters Parameters BDIFFPPosition position ANFMajorCase portion Description Decimal finger position ( see page 246) code. The portion ( see page 245) of the EJI or tip image in the database to search.
8.1.2.1.14.2 ANFPositionDescriptor Fields

8.1.2.1.14.2.1 ANFPositionDescriptor.portion Field
ANFMajorCase object representing fingerprint position ( see page 246) code. 245
8.1 Java Reference Java public ANFMajorCase portion;
8.1.2.1.14.2.2 ANFPositionDescriptor.position Field

ANFMajorCase object representing the portion ( Java public BDIFFPPosition position; see page 245) of the image.
8.1.2.1.15 ANFPQualityMetric Class

Describes NIST Fingerprint Image Quality (NFIQ) scores. Java public final class ANFPQualityMetric; File ANFPQualityMetric.java Remarks Position field represents fingerprint/palmprint position ( see page 247). Score field represent quality assessment which has been calculated using scoring algorithm. AlgorithmVendorId field represents ID of the vendor of the quality algorithm used to calculate the quality score ( see page 247). AlgorithmProductId field represents numeric product code assigned by the vendor of the quality algorithm. Methods Name ANFPQualityMetric ( 246) ANFPQualityMetric Fields Name algorithmProductId ( 247) algorithmVendorId ( position ( score ( see page Description Number containing numeric product code. see page Description Initializes new instance of ANFPQualityMetric structure.
see page 247) Number containing vendor ID. BdifFPPosition object representing fingerprint/palmprint position value. Number representing fingerprint/palmprint quality score.
see page 247)
see page 247)
8.1.2.1.15.1 ANFPQualityMetric Constructor

8.1.2.1.15.1.1 ANFPQualityMetric.ANFPQualityMetric Constructor ()
Initializes new instance of ANFPQualityMetric structure. Java public ANFPQualityMetric();
8.1.2.1.15.1.2 ANFPQualityMetric.ANFPQualityMetric Constructor (BDIFFPPosition, byte, short, short)

Initializes new instance of ANFPQualityMetric structure. Java public ANFPQualityMetric(BDIFFPPosition position, byte score, short algorithmVendorId, short algorithmProductId);
246
8.1 Java Reference Parameters Parameters BDIFFPPosition position byte score short algorithmVendorId short algorithmProductId
Description Fingerprint/palmprint position ( see page 247) value. Quality assessment which has been calculated using scoring algorithm. The ID of the vendor of the quality algorithm used to calculate the quality score ( see page 247). A numeric product code assigned by the vendor of the quality algorithm.
8.1.2.1.15.2 ANFPQualityMetric Fields

8.1.2.1.15.2.1 ANFPQualityMetric.algorithmProductId Field
Number containing numeric product code. Java public short algorithmProductId;
8.1.2.1.15.2.2 ANFPQualityMetric.algorithmVendorId Field

Number containing vendor ID. Java public short algorithmVendorId;
8.1.2.1.15.2.3 ANFPQualityMetric.position Field

BdifFPPosition object representing fingerprint/palmprint position value. Java public BDIFFPPosition position;
8.1.2.1.15.2.4 ANFPQualityMetric.score Field

Number representing fingerprint/palmprint quality score. Java public byte score;
8.1.2.1.16 ANFPrintPosition Class

Describes print position coordinates. Java public final class ANFPrintPosition; File ANFPrintPosition.java Remarks Structure consist of six (6) mandatory information items to describe the type or portion of the latent image contained in this record and its location within an entire joint image. The first information item is the number of the full finger view with values of "FV1" through "FV4". Values of FV1 to FV4 specify the bounding coordinates for each full finger view. The second information item is used to identify the location of a segment ( see page 249) within a full finger view. It contain the not applicable code NA if the image portion refers to a full finger view or to the entire joint image locations. It contains PRX, DST, MED for a proximal, distal, or medial segment ( see page 249). 247
8.1 Java Reference
The next four information items are the horizontal and vertical offsets relative to the origin positioned in the upper left ( see page 249) corner of the image. The horizontal offsets (X) are the pixel counts to the right ( see page 249), and the vertical offsets (Y) are the pixel counts down. The location of the image portion is defined by the sequence of X coordinates (LEFT, RIGHT) and the Y coordinates (TOP, BOTTOM), of its bounding box. For the case of a fingertip, the first information item shall be TIP, and the second information item shall be NA. The next four information items are the horizontal and vertical offsets as defined above. Methods Name ANFPrintPosition ( ANFPrintPosition Fields Name bottom ( left ( right ( top ( see page 248) see page 248) fingerView ( Description Number representing bottom Y coordinate of bounding box. ANFMajorCase object representing number of the full finger view. Number representing left X coordinate of bounding box. Number representing right X coordinate of bounding box. ANFMajorCase object representing segment with full fingers view. Number representing top Y coordinate of bounding box. see page 248) Description Initializes new instance of ANFPrintPosition structure.
segment (
8.1.2.1.16.1 ANFPrintPosition.ANFPrintPosition Constructor

Initializes new instance of ANFPrintPosition structure. Java public ANFPrintPosition(ANFMajorCase fingerView, ANFMajorCase segment, int left, int right, int top, int bottom); Parameters Parameters ANFMajorCase fingerView ANFMajorCase segment int left int right int top int bottom Description One of ANFMajorCase values. One of ANFMajorCase values. Left X coordinate of bounding box. Right X coordinate of bounding box. Top Y coordinate of bounding box. Bottom Y coordinate of bounding box.
8.1.2.1.16.2 ANFPrintPosition Fields

8.1.2.1.16.2.1 ANFPrintPosition.bottom Field
Number representing bottom Y coordinate of bounding box. Java public int bottom;
8.1.2.1.16.2.2 ANFPrintPosition.fingerView Field

ANFMajorCase object representing number of the full finger view. Java public ANFMajorCase fingerView;
248
8.1 Java Reference
8.1.2.1.16.2.3 ANFPrintPosition.left Field

Number representing left X coordinate of bounding box. Java public int left;
8.1.2.1.16.2.4 ANFPrintPosition.right Field

Number representing right X coordinate of bounding box. Java public int right;
8.1.2.1.16.2.5 ANFPrintPosition.segment Field

ANFMajorCase object representing segment with full fingers view. Java public ANFMajorCase segment;
8.1.2.1.16.2.6 ANFPrintPosition.top Field

Number representing top Y coordinate of bounding box. Java public int top;
8.1.2.1.17 ANFSegment Class

Defines image segments containing individual fingers. Java public final class ANFSegment; File ANFSegment.java Remarks This structure contains offsets to the locations of image segments containing the individual fingers within the flat images of the four simultaneous fingers from each hand or the two simultaneous thumbs. The offsets are relative to the origin positioned in the upper left ( see page 250) corner of the image. The horizontal offsets (X) are the pixel counts to the right ( see page 250), and the vertical offsets (Y) are the pixel counts down. A finger segment is defined by the finger number, which is between one and ten, the X coordinates (LEFT, RIGHT) and the Y coordinates (TOP, BOTTOM), of its bounding box. Methods Name ANFSegment ( ANFSegment Fields Name bottom ( left ( right ( top ( position ( see page 250) see page 250) see page 250) see page 250) see page 250) Description Number containing bottom Y coordinate of bounding box. Number containing left X coordinate of bounding box. BdifFPPosition object representing fingerprint position code. Number containing right X coordinate of bounding box. Number containing top Y coordinate of bounding box. see page 250) Description Initializes new instance of ANFSegment structure.
249
8.1 Java Reference
8.1.2.1.17.1 ANFSegment.ANFSegment Constructor

Initializes new instance of ANFSegment structure. Java public ANFSegment(BDIFFPPosition position, int left, int right, int top, int bottom); Parameters Parameters BDIFFPPosition position int left int right int top int bottom Description One of BDIFFPPosition values representing fingerprint position ( see page 250) code. Left X coordinate of bounding box. Right X coordinate of bounding box. Top Y coordinate of bounding box. Bottom Y coordinate of bounding box.
8.1.2.1.17.2 ANFSegment Fields

8.1.2.1.17.2.1 ANFSegment.bottom Field
Number containing bottom Y coordinate of bounding box. Java public int bottom;
8.1.2.1.17.2.2 ANFSegment.left Field

Number containing left X coordinate of bounding box. Java public int left;
8.1.2.1.17.2.3 ANFSegment.position Field

BdifFPPosition object representing fingerprint position code. Java public BDIFFPPosition position;
8.1.2.1.17.2.4 ANFSegment.right Field

Number containing right X coordinate of bounding box. Java public int right;
8.1.2.1.17.2.5 ANFSegment.top Field

Number containing top Y coordinate of bounding box. Java public int top;
8.1.2.1.18 ANImageASCIIBinaryRecord Class

Provides basic functionality for ANType10Record ( see page 320), ANType16Record ( ( see page 372) and ANFPImageAsciiBinaryRecord logical records. Java public class ANImageASCIIBinaryRecord extends ANASCIIBinaryRecord; 250 see page 366), ANType17Record
8.1 Java Reference File ANImageAsciiBinaryRecord.java ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC (
FIELD_LEN (
see page 273)
ANASCIIBinaryRecord Class Name FIELD_DAT ( FIELD_SRC ( see page 218) see page 218) Description Defines DAT field number. Field referenced by this number contains the date that the transaction was initiated. Defines SRC field number. Field referenced by this number contains the administration or organization that originally captured the latent image contained in the record. Normally, the Originating Agency Identifier, ORI, of the agency that captured the image. Specifies starting number from which user defined field starts. Defines end number of user defined field starts. see page Defines maximal quality score value for record data. see Defines maximal value length of field referenced by FieldSrc field number. see Defines maximal value length of field referenced by FieldSrc field number in current implementation of ANSI-NIST standard in ANTemplate ( see page 286). Defines minimal value length of field referenced by FieldSrc field number. Defines code when quality assessment algorithm failed to asses record data quality.
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANImageASCIIBinaryRecord Class Name FIELD_BPX ( see page 254) Description Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel.
251
8.1 Java Reference FIELD_CGA (
see page 254)
Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data. Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
FIELD_COM (
see page 254)
FIELD_CSP (
see page 255)
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
MAX_VENDOR_COMPRESSION_ALGORITHM_LENGTH Defines maximal length of vendor compression ( see page 256) algorithm description. MIN_LATENT_PIXEL_SCALE_PPCM ( see page 256) Defines minimal pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286).
252
8.1 Java Reference
see page 256)
Defines minimal pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286).
see page
see page 257)
see page
see
see
see page 257)
see page 258)
MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH ( see page 258) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description
Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
ANASCIIBinaryRecord Class Name getDate ( see page 219) see page 220) getSourceAgency ( nativeTypeOf ( Description Gets field referenced by FieldDat field number. Retrieves a function that retrieves NType object for the enclosing type. 253
see page 220) Gets source agency identification.
8.1 Java Reference setDate ( see page 220)
Sets field referenced by FieldDat field number.
setSourceAgency (
see page
see page 259)
see page Gets scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression. Gets description of vendor compression algorithm, that has been used to compress the transmitted images.
see
see page 261)
8.1.2.1.18.1 ANImageASCIIBinaryRecord Fields

8.1.2.1.18.1.1 ANImageASCIIBinaryRecord.FIELD_BPX Field
Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Java public static final int FIELD_BPX = 12;
8.1.2.1.18.1.2 ANImageASCIIBinaryRecord.FIELD_CGA Field

Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Java public static final int FIELD_CGA = 11;
8.1.2.1.18.1.3 ANImageASCIIBinaryRecord.FIELD_COM Field

Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the 254
8.1 Java Reference image data. Java
public static final int FIELD_COM = 20;
8.1.2.1.18.1.4 ANImageASCIIBinaryRecord.FIELD_CSP Field

Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Java public static final int FIELD_CSP = 13;
8.1.2.1.18.1.5 ANImageASCIIBinaryRecord.FIELD_DMM Field

Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Java public static final int FIELD_DMM = 30;
8.1.2.1.18.1.6 ANImageASCIIBinaryRecord.FIELD_HLL Field

Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Java public static final int FIELD_HLL = 6;
8.1.2.1.18.1.7 ANImageASCIIBinaryRecord.FIELD_HPS Field

Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Java public static final int FIELD_HPS = 9;
8.1.2.1.18.1.8 ANImageASCIIBinaryRecord.FIELD_IQM Field

Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Java public static final int FIELD_IQM = 24;
8.1.2.1.18.1.9 ANImageASCIIBinaryRecord.FIELD_SHPS Field

Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Java public static final int FIELD_SHPS = 16;
8.1.2.1.18.1.10 ANImageASCIIBinaryRecord.FIELD_SLC Field

Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Java public static final int FIELD_SLC = 8;
8.1.2.1.18.1.11 ANImageASCIIBinaryRecord.FIELD_SVPS Field

Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression.
255
public static final int FIELD_SVPS = 17;
8.1.2.1.18.1.12 ANImageASCIIBinaryRecord.FIELD_VLL Field

Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Java public static final int FIELD_VLL = 7;
8.1.2.1.18.1.13 ANImageASCIIBinaryRecord.FIELD_VPS Field

Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. Java public static final int FIELD_VPS = 10;
8.1.2.1.18.1.14 ANImageASCIIBinaryRecord.MAX_COMMENT_LENGTH Field

Defines maximal length of textual information associated with image contained in record. Java public static final int MAX_COMMENT_LENGTH = 127;
8.1.2.1.18.1.15 ANImageASCIIBinaryRecord.MAX_LINE_LENGTH Field

Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Java public static final int MAX_LINE_LENGTH = 9999;
8.1.2.1.18.1.16 ANImageASCIIBinaryRecord.MAX_PIXEL_SCALE Field

Defines maximal pixel scale value. Java public static final int MAX_PIXEL_SCALE = 9999;
8.1.2.1.18.1.17 ANImageASCIIBinaryRecord.MAX_VENDOR_COMPRESSION_ALGORITHM_LENGTH Field

Defines maximal length of vendor compression algorithm description. Java public static final int MAX_VENDOR_COMPRESSION_ALGORITHM_LENGTH = 6;
8.1.2.1.18.1.18 ANImageASCIIBinaryRecord.MIN_LATENT_PIXEL_SCALE_PPCM Field

Defines minimal pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_PIXEL_SCALE_PPCM = 195;
8.1.2.1.18.1.19 ANImageASCIIBinaryRecord.MIN_LATENT_PIXEL_SCALE_PPI Field

Defines minimal pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_PIXEL_SCALE_PPI = 495;
256
8.1 Java Reference
8.1.2.1.18.1.20 ANImageASCIIBinaryRecord.MIN_LATENT_PIXEL_SCALE_V4_PPCM Field

Defines minimal pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_PIXEL_SCALE_V4_PPCM = 390;
8.1.2.1.18.1.21 ANImageASCIIBinaryRecord.MIN_LATENT_PIXEL_SCALE_V4_PPI Field

Defines minimal pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_PIXEL_SCALE_V4_PPI = 990;
8.1.2.1.18.1.22 ANImageASCIIBinaryRecord.MIN_LATENT_SCAN_PIXEL_SCALE_PPCM Field

Defines minimal scanned pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_SCAN_PIXEL_SCALE_PPCM = 195;
8.1.2.1.18.1.23 ANImageASCIIBinaryRecord.MIN_LATENT_SCAN_PIXEL_SCALE_PPI Field

Defines minimal scanned pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_SCAN_PIXEL_SCALE_PPI = 495;
8.1.2.1.18.1.24 ANImageASCIIBinaryRecord.MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPCM Field

Defines minimal scanned pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPCM = 390;
8.1.2.1.18.1.25 ANImageASCIIBinaryRecord.MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPI Field

Defines minimal scanned pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Java public static final int MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPI = 990;
8.1.2.1.18.1.26 ANImageASCIIBinaryRecord.MIN_PIXEL_SCALE_PPCM Field

Defines minimal pixel scale value per centimeter. Java public static final int MIN_PIXEL_SCALE_PPCM = 195;
8.1.2.1.18.1.27 ANImageASCIIBinaryRecord.MIN_PIXEL_SCALE_PPI Field

Defines minimal pixel scale value per inch. Java public static final int MIN_PIXEL_SCALE_PPI = 495;
257
8.1 Java Reference
8.1.2.1.18.1.28 ANImageASCIIBinaryRecord.MIN_SCAN_PIXEL_SCALE_PPCM Field

Defines minimal scanned pixel scale value per centimeter. Java public static final int MIN_SCAN_PIXEL_SCALE_PPCM = 195;
8.1.2.1.18.1.29 ANImageASCIIBinaryRecord.MIN_SCAN_PIXEL_SCALE_PPI Field

Defines minimal scanned pixel scale value per inch. Java public static final int MIN_SCAN_PIXEL_SCALE_PPI = 495;
8.1.2.1.18.1.30 ANImageASCIIBinaryRecord.MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH Field

Defines minimal length of vendor compression algorithm description. Java public static final int MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH = 3;
8.1.2.1.18.2 ANImageASCIIBinaryRecord Methods

8.1.2.1.18.2.1 ANImageASCIIBinaryRecord.getBitsPerPixel Method
Gets number of bits used to represent a pixel (BPP). Java public final byte getBitsPerPixel(); Returns Number containing bits per pixel.
8.1.2.1.18.2.2 ANImageASCIIBinaryRecord.getColorSpace Method

Gets color space used to exchange the image data. Java public final ANImageColorSpace getColorSpace(); Returns One of ANImageColorSpace values.
8.1.2.1.18.2.3 ANImageASCIIBinaryRecord.getComment Method

Gets or sets textual information associated with image located in ANRecord ( Java public final String getComment(); Returns String containing textual information. see page 270) object.
8.1.2.1.18.2.4 ANImageASCIIBinaryRecord.getCompressionAlgorithm Method

Gets compression algorithm used to compress image data. Java public final ANImageCompressionAlgorithm getCompressionAlgorithm();
258
One of ANImageCompressionAlgorithm values.
8.1.2.1.18.2.5 ANImageASCIIBinaryRecord.getDeviceMonitoringMode Method

Gets device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Java public final ANDeviceMonitoringMode getDeviceMonitoringMode(); Returns One of ANDeviceMonitoringMode values.
8.1.2.1.18.2.6 ANImageASCIIBinaryRecord.getHorzLineLength Method

Gets or horizontal line length value. Java public final short getHorzLineLength(); Returns Horizontal line length of image.
8.1.2.1.18.2.7 ANImageASCIIBinaryRecord.getHorzPixelScale Method

Gets horizontal pixel scale of image. Java public final short getHorzPixelScale(); Returns Horizontal pixel scale of image.
8.1.2.1.18.2.8 ANImageASCIIBinaryRecord.getScaleUnits Method

Gets scale units value. Java public final BDIFScaleUnits getScaleUnits(); Returns One of BDIFScaleUnits values.
8.1.2.1.18.2.9 ANImageASCIIBinaryRecord.getScanHorzPixelScale Method

Gets scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Java public final int getScanHorzPixelScale(); Returns Number representing horizontal pixel scale.
8.1.2.1.18.2.10 ANImageASCIIBinaryRecord.getScanVertPixelScale Method

Gets scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression. Java public final int getScanVertPixelScale(); 259
8.1 Java Reference Returns Number representing vertical pixel scale.
8.1.2.1.18.2.11 ANImageASCIIBinaryRecord.getVendorCompressionAlgorithm Method

Gets description of vendor compression algorithm, that has been used to compress the transmitted images. Java public final String getVendorCompressionAlgorithm(); Returns String containing vendor compression algorithm description.
8.1.2.1.18.2.12 ANImageASCIIBinaryRecord.getVertLineLength Method

Gets or vertical line length value. Java public final short getVertLineLength(); Returns Vertical line length of image.
8.1.2.1.18.2.13 ANImageASCIIBinaryRecord.getVertPixelScale Method

Gets vertical pixel scale of image. Java public final short getVertPixelScale(); Returns Vertical pixel scale of image.
8.1.2.1.18.2.14 ANImageASCIIBinaryRecord.nativeTypeOf Method

8.1.2.1.18.2.15 ANImageASCIIBinaryRecord.setComment Method

Gets or sets textual information associated with image located in ANRecord ( Java public final void setComment(String value); Parameters Parameters String value Description String containing textual information. see page 270) object.
8.1.2.1.18.2.16 ANImageASCIIBinaryRecord.setDeviceMonitoringMode Method

Sets device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device.
260
public final void setDeviceMonitoringMode(ANDeviceMonitoringMode value); Parameters Parameters ANDeviceMonitoringMode value Description One of ANDeviceMonitoringMode values.
8.1.2.1.18.2.17 ANImageASCIIBinaryRecord.setScanHorzPixelScale Method

Sets scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Java public final void setScanHorzPixelScale(int value); Parameters Parameters int value Description Number representing horizontal pixel scale.
8.1.2.1.18.2.18 ANImageASCIIBinaryRecord.setScanVertPixelScale Method

Sets scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression. Java public final void setScanVertPixelScale(int value); Parameters Parameters int value Description Number representing vertical pixel scale.
8.1.2.1.18.2.19 toNImage Method 8.1.2.1.18.2.19.1 ANImageASCIIBinaryRecord.toNImage Method ()

Converts image contained in logical record to NImage format. Java public final NImage toNImage(); Returns NImage object.
8.1.2.1.18.2.19.2 ANImageASCIIBinaryRecord.toNImage Method (int)

Converts image contained in logical record to NImage format. Java public final NImage toNImage(int flags); Parameters Parameters int flags Returns NImage object. Description Must be zero.
8.1.2.1.19 ANImageBinaryRecord Class

Provides basic functionality for ANFImageBinaryRecord ( see page 229) and ANType8Record ( see page 414) logical 261
8.1 Java Reference records. Java
public class ANImageBinaryRecord extends ANBinaryRecord; File ANImageBinaryRecord.java ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
AN_IMAGE_BINARY_RECORD_FIELD_HLL Defines HLL field number. Field referenced by this number ( see page 263) contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). AN_IMAGE_BINARY_RECORD_FIELD_ISR Defines ISE field number. Field referenced by this number ( see page 263) contains flag of image scanning resolution. AN_IMAGE_BINARY_RECORD_FIELD_VLL Defines VLL field number. Field referenced by this number ( see page 263) contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
262
8.1 Java Reference ANBinaryRecord Class Name nativeTypeOf ( ANImageBinaryRecord Class Name getHorzLineLength ( 263) getImageResolution ( 263)
Description see page see page Gets or horizontal line length value. Gets image resolution value. Gets value of image scanning resolution.
see page 264)
see page 264)
8.1.2.1.19.1 ANImageBinaryRecord Fields

8.1.2.1.19.1.1 ANImageBinaryRecord.AN_IMAGE_BINARY_RECORD_FIELD_HLL Field
Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Java public static final int AN_IMAGE_BINARY_RECORD_FIELD_HLL = 6;
8.1.2.1.19.1.2 ANImageBinaryRecord.AN_IMAGE_BINARY_RECORD_FIELD_ISR Field

Defines ISE field number. Field referenced by this number contains flag of image scanning resolution. Java public static final int AN_IMAGE_BINARY_RECORD_FIELD_ISR = 5;
8.1.2.1.19.1.3 ANImageBinaryRecord.AN_IMAGE_BINARY_RECORD_FIELD_VLL Field

Defines VLL field number. Field referenced by this number contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Java public static final int AN_IMAGE_BINARY_RECORD_FIELD_VLL = 7;
8.1.2.1.19.2 ANImageBinaryRecord Methods

8.1.2.1.19.2.1 ANImageBinaryRecord.getHorzLineLength Method
Gets or horizontal line length value. Java public final short getHorzLineLength(); Returns Horizontal line length of image.
8.1.2.1.19.2.2 ANImageBinaryRecord.getImageResolution Method

Gets image resolution value. 263
public final int getImageResolution(); Returns Number containing image resolution value.
8.1.2.1.19.2.3 ANImageBinaryRecord.getImageScanResolutionValue Method

Gets value of image scanning resolution. Java public final int getImageScanResolutionValue(); Returns Number containing image scanning resolution.
8.1.2.1.19.2.4 ANImageBinaryRecord.getVertLineLength Method

Gets or vertical line length value. Java public final short getVertLineLength(); Returns Vertical line length of image.
8.1.2.1.19.2.5 ANImageBinaryRecord.isImageScanResolution Method

Gets flag which defines what type of image scan resolution was used. Java public final boolean isImageScanResolution(); Returns true if native scanning resolution has been used and false if minimum scanning resolution has been used.
8.1.2.1.19.2.6 ANImageBinaryRecord.nativeTypeOf Method

8.1.2.1.19.2.7 toNImage Method 8.1.2.1.19.2.7.1 ANImageBinaryRecord.toNImage Method ()

Converts image contained in logical record to NImage format. Java public final NImage toNImage(); Returns NImage object.
264
8.1 Java Reference
8.1.2.1.19.2.7.2 ANImageBinaryRecord.toNImage Method (int)

Converts image contained in logical record to NImage format. Java public final NImage toNImage(int flags); Parameters Parameters int flags Returns NImage object. Description Must be zero.
8.1.2.1.20 ANIrisImageProperties Class

Defines iris image image properties. Properties consists of horizontal orientation, vertical orientation and scan type. Java public final class ANIrisImageProperties; File ANIrisImageProperties.java Methods Name ANIrisImageProperties ( 265) ANIrisImageProperties Fields Name horzOrientation ( scanType ( vertOrientation ( see page 266) see page 266) see page 266) Description BdifIrisOrientation object representing iris horizontal orientation. BdifIrisOrientation object representing iris vertical orientation. BdifIrisOrientation object representing iris vertical orientation. Description see page Initializes new instance of ANIrisImageProperties structure.
8.1.2.1.20.1 ANIrisImageProperties Constructor

8.1.2.1.20.1.1 ANIrisImageProperties.ANIrisImageProperties Constructor ()
Initializes new instance of ANIrisImageProperties structure. Java public ANIrisImageProperties();
8.1.2.1.20.1.2 ANIrisImageProperties.ANIrisImageProperties Constructor (BDIFIrisOrientation, BDIFIrisOrientation, BDIFIrisScanType)

Initializes new instance of ANIrisImageProperties structure. Java public ANIrisImageProperties(BDIFIrisOrientation horzOrientation, BDIFIrisOrientation vertOrientation, BDIFIrisScanType scanType); Parameters Parameters BDIFIrisOrientation horzOrientation BDIFIrisOrientation vertOrientation Description Horizontal orientation of the iris. Vertical orientation of the iris. 265
8.1 Java Reference BDIFIrisScanType scanType
One of BDIFIrisScanType values.
8.1.2.1.20.2 ANIrisImageProperties Fields

8.1.2.1.20.2.1 ANIrisImageProperties.horzOrientation Field
BdifIrisOrientation object representing iris horizontal orientation. Java public BDIFIrisOrientation horzOrientation;
8.1.2.1.20.2.2 ANIrisImageProperties.scanType Field

BdifIrisOrientation object representing iris vertical orientation. Java public BDIFIrisScanType scanType;
8.1.2.1.20.2.3 ANIrisImageProperties.vertOrientation Field

BdifIrisOrientation object representing iris vertical orientation. Java public BDIFIrisOrientation vertOrientation;
8.1.2.1.21 ANNISTQualityMetric Class

Represents NIST Fingerprint Image Quality (NFIQ) scores. Java public final class ANNISTQualityMetric; File ANNistQualityMetric.java Remarks Structure contains two information items . The first item is the finger number between one and ten. The second item is the quality score ( see page 267) which is a quantitative expression of the predicted AFIS matcher accuracy performance of the fingerprint image. The scores range from "1" for the best quality image, to "5" for the worst quality image. A "254" indicates that no score ( see page 267) was ever computed while an entry of "255" shall indicate a failed attempt to calculate the image quality metric. Methods Name ANNISTQualityMetric ( 266) ANNISTQualityMetric Fields Name position ( score ( see page 267) see page 267) Description BdifFPPosition object representing fingerprint position code. Number containing quality score assessment. see page Description Initializes new instance of ANNistQualityMetric structure.
8.1.2.1.21.1 ANNISTQualityMetric Constructor

8.1.2.1.21.1.1 ANNISTQualityMetric.ANNISTQualityMetric Constructor ()
Initializes new instance of ANNistQualityMetric structure.
266
8.1 Java Reference Java public ANNISTQualityMetric();
8.1.2.1.21.1.2 ANNISTQualityMetric.ANNISTQualityMetric Constructor (BDIFFPPosition, byte)

Initializes new instance of ANNistQualityMetric structure. Java public ANNISTQualityMetric(BDIFFPPosition position, byte score); Parameters Parameters BDIFFPPosition position byte score Description One of BDIFFPPosition values representing fingerprint position ( see page 267) code. Quality score ( see page 267) which is a quantitative expression of the predicted AFIS matcher accuracy performance of the fingerprint image.
8.1.2.1.21.2 ANNISTQualityMetric Fields

8.1.2.1.21.2.1 ANNISTQualityMetric.position Field
BdifFPPosition object representing fingerprint position code. Java public BDIFFPPosition position;
8.1.2.1.21.2.2 ANNISTQualityMetric.score Field

Number containing quality score assessment. Java public byte score;
8.1.2.1.22 ANPenVector Class

Specifies a list of vectors describing the pen position and pen pressure ( signature. Java public final class ANPenVector; File ANPenVector.java Remarks Both the X and Y coordinates shall be expressed in units of .0254 mm (.001 inches) referenced from the bottom leftmost corner of the signature. Positive values of X shall increase from left-to-right and positive values of Y shall increase from bottom-to-top. An unsigned binary number between "0" and "255" represents the pen pressure ( see page 268). This shall be a constant pressure ( see page 268) until the next vector becomes active. A binary value or pressure ( see page 268) of "0" shall represent a "pen-up" (or no pressure ( see page 268)) condition. The binary value of "1" shall represent the least recordable pressure ( see page 268) for a particular device, while the binary equivalent of "254" shall represent the maximum recordable pressure ( see page 268) for that device. To denote the end of the vector list the binary equivalent of "255" shall be inserted in this entry. see page 268) of line segments within the
267
8.1 Java Reference Methods Name ANPenVector ( ANPenVector Fields Name pressure ( x( y( see page 268) see page 268) see page 268)
Description see page 268) Initializes new instance of ANPenVector structure.
Description Number representing pen pressure value. Number representing X coordinate of the pen position. Number representing Y coordinate of the pen position.
8.1.2.1.22.1 ANPenVector Constructor

8.1.2.1.22.1.1 ANPenVector.ANPenVector Constructor ()
Initializes new instance of ANPenVector structure. Java public ANPenVector();
8.1.2.1.22.1.2 ANPenVector.ANPenVector Constructor (int, int, short)

Initializes new instance of ANPenVector structure. Java public ANPenVector(int x, int y, short pressure); Parameters Parameters int x int y short pressure Description The x ( The y ( see page 268) - coordinate of the core. see page 268) - coordinate of the core. see page 268) value.
Pen pressure (
8.1.2.1.22.2 ANPenVector Fields

8.1.2.1.22.2.1 ANPenVector.pressure Field
Number representing pen pressure value. Java public short pressure;
8.1.2.1.22.2.2 ANPenVector.x Field

Number representing X coordinate of the pen position. Java public int x;
8.1.2.1.22.2.3 ANPenVector.y Field

Number representing Y coordinate of the pen position. Java public int y;
8.1.2.1.23 ANQualityMetric Class

This structure defines quality score ( see page 270) metric. 268
public final class ANQualityMetric; File ANQualityMetric.java Methods Name ANQualityMetric ( ANQualityMetric Fields Name algorithmProductId ( 269) algorithmVendorId ( score ( see page Description Number representing a numeric product code assigned by the vendor of the quality algorithm. see page 269) Description Initializes new instance of ANQualityMetric structure.
see page 269) Number representing the ID of the vendor of the quality algorithm used to calculate the quality score ( see page 270). Number representing quality score defined by quality assessment algorithm.
see page 270)
8.1.2.1.23.1 ANQualityMetric Constructor

8.1.2.1.23.1.1 ANQualityMetric.ANQualityMetric Constructor ()
Initializes new instance of ANQualityMetric structure. Java public ANQualityMetric();
8.1.2.1.23.1.2 ANQualityMetric.ANQualityMetric Constructor (byte, short, short)

Initializes new instance of ANQualityMetric structure. Java public ANQualityMetric(byte score, short algorithmVendorId, short algorithmProductId); Parameters Parameters byte score short algorithmVendorId short algorithmProductId Description The quality score ( see page 270) defined by quality assessment algorithm. The ID of the vendor of the quality algorithm used to calculate the quality score ( see page 270). A numeric product code assigned by the vendor of the quality algorithm.
8.1.2.1.23.2 ANQualityMetric Fields

8.1.2.1.23.2.1 ANQualityMetric.algorithmProductId Field
Number representing a numeric product code assigned by the vendor of the quality algorithm. Java public short algorithmProductId;
8.1.2.1.23.2.2 ANQualityMetric.algorithmVendorId Field

Number representing the ID of the vendor of the quality algorithm used to calculate the quality score ( see page 270).
269
8.1 Java Reference Java public short algorithmVendorId;
8.1.2.1.23.2.3 ANQualityMetric.score Field

Number representing quality score defined by quality assessment algorithm. Java public byte score;
8.1.2.1.24 ANRecord Class

Provides functionality for working with logical records of the ANTemplate ( Java public class ANRecord extends NObject; File ANRecord.java ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. see page 271) Description Represent collection of subfields in field. see page 286).
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord. Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord. Sets idc of record. Gets record size. see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. see page 273)
see page 275)
8.1.2.1.24.1 ANRecord Classes

270
8.1 Java Reference
8.1.2.1.24.1.1 ANRecord.FieldCollection Class

Represent collection of subfields in field. Java public final class FieldCollection extends NObjectCollection<ANField>; File ANRecord.java FieldCollection Methods Name add ( see page 271) Description Adds field to ANRecord ( see page 270) object specified by field number and with specified initial count of elements in it. Also gets added field index. Check if field specified by field number is in record. Gets field with specified number from records. Returns field index in record.
contains ( indexOf (
getByNumber (
8.1.2.1.24.1.1.1 FieldCollection Methods 8.1.2.1.24.1.1.1.1 add Method 8.1.2.1.24.1.1.1.1.1 ANRecord.FieldCollection.add Method (int, String)
Adds field to ANRecord ( see page 270) object specified by field number and with specified initial count of elements in it. Also gets added field index. Java public ANField add(int fieldNumber, String value); Parameters Parameters int fieldNumber String value Returns ANField ( see page 227) object. Description Number representing field. String containing field value.
8.1.2.1.24.1.1.1.1.2 ANRecord.FieldCollection.add Method (int, int, String)

Adds field to ANRecord ( see page 270) object specified by field number and with specified initial count of elements in it. Also gets added field index. Java public ANField add(int index, int fieldNumber, String value); Parameters Parameters int index int fieldNumber String value Returns ANField ( see page 227) object. Description Newly added field index. Number representing field. String containing field value.
271
8.1 Java Reference
8.1.2.1.24.1.1.1.2 ANRecord.FieldCollection.contains Method

Check if field specified by field number is in record. Java public boolean contains(int fieldNumber); Parameters Parameters int fieldNumber Returns true if field is in record and false otherwise. Description Number representing field in record.
8.1.2.1.24.1.1.1.3 ANRecord.FieldCollection.getByNumber Method

Gets field with specified number from records. Java public final ANField getByNumber(int fieldNumber); Parameters Parameters int fieldNumber Returns ANField ( see page 227) object. Description Number of the field to return.
8.1.2.1.24.1.1.1.4 ANRecord.FieldCollection.indexOf Method

Returns field index in record. Java public int indexOf(int fieldNumber); Parameters Parameters int fieldNumber Returns Field index. Description Number representing field.
8.1.2.1.24.2 ANRecord Fields

8.1.2.1.24.2.1 ANRecord.FIELD_DATA Field
Defines Image data (DATA) contained in logical record. Java public static final int FIELD_DATA = 999;
8.1.2.1.24.2.2 ANRecord.FIELD_IDC Field

This field is identifies the user-defined text information contained in the record. The IDC (image designation character) 272
8.1 Java Reference
contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Java public static final int FIELD_IDC = 2;
8.1.2.1.24.2.3 ANRecord.FIELD_LEN Field

Describes total count of the number of bytes in logical record. Java public static final int FIELD_LEN = 1;
8.1.2.1.24.2.4 ANRecord.FLAG_MERGE_DUBLICATE_FIELDS Field

Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. Java public static final int FLAG_MERGE_DUBLICATE_FIELDS = 0x00000100;
8.1.2.1.24.2.5 ANRecord.FLAG_RECOVER_FROM_BINARY_DATA Field

Flag used to recover from binary data in some buggy files during read. Java public static final int FLAG_RECOVER_FROM_BINARY_DATA = 0x00000200;
8.1.2.1.24.2.6 ANRecord.MAX_FIELD_NUMBER Field

Defines maximal number of fields in logical record. Java public static final int MAX_FIELD_NUMBER = 999;
8.1.2.1.24.2.7 ANRecord.MAX_IDC Field

Defines maximum value that image designation character (IDC) can obtain. Java public static final int MAX_IDC = 255;
8.1.2.1.24.3 ANRecord Methods

8.1.2.1.24.3.1 ANRecord.beginUpdate Method
Begins updating the record. Java public void beginUpdate();
8.1.2.1.24.3.2 ANRecord.endUpdate Method

Finishes updating the record. Java public void endUpdate();
8.1.2.1.24.3.3 ANRecord.getData Method

Gets ByteBuffer that contains data field of record. Java public final ByteBuffer getData(); Returns ByteBuffer that contains data field of record. 273
8.1 Java Reference
8.1.2.1.24.3.4 ANRecord.getFields Method

Gets particular fields from the ANRecord ( Java public final FieldCollection getFields(); Returns A RecordCollection representing fields in ANRecord ( see page 270). see page 270).
8.1.2.1.24.3.5 ANRecord.getIdc Method

Gets idc of record. Java public final int getIdc(); Returns Value of record idc.
8.1.2.1.24.3.6 ANRecord.getRecordType Method

Gets record type. Java public final ANRecordType getRecordType(); Returns ANRecordType ( see page 275) object representing record type.
8.1.2.1.24.3.7 ANRecord.isValidated Method

Checks if record is validated. Java public final boolean isValidated(); Returns Value is true if validated false otherwise
8.1.2.1.24.3.8 ANRecord.nativeTypeOf Method

8.1.2.1.24.3.9 setData Method
274
8.1 Java Reference
8.1.2.1.24.3.9.1 ANRecord.setData Method (ByteBuffer)

Sets data of the current ANRecord ( Java public void setData(ByteBuffer value); Parameters Parameters ByteBuffer value Description Byte buffer containing new data. see page 270).
8.1.2.1.24.3.9.2 ANRecord.setData Method (ByteBuffer, boolean)

Sets data of the current ANRecord ( Java public void setData(ByteBuffer value, boolean copy); Parameters Parameters ByteBuffer value boolean copy Description Byte buffer containing new data. true if copy is required; else false. see page 270).
8.1.2.1.24.3.10 ANRecord.setIdc Method

Sets idc of record. Java public final void setIdc(int value); Parameters Parameters int value Description Value of record idc.
8.1.2.1.24.3.11 ANRecord.size Method

Gets record size. Java public final int size(); Returns Value record size.
8.1.2.1.25 ANRecordType Class

Provides functionality for retrieving types and values from logical records. Java public final class ANRecordType extends NObject; File ANRecordType.java ANRecordType Classes Name RecordTypeCollection ( 276) see page Description Represent collection of record types.
275
8.1 Java Reference ANRecordType Fields Name MAX_NUMBER ( ANRecordType Methods Name getDataType ( getFieldId ( getFieldName (
Description see page 277) Defines maximal allowed type number value.
Description see page 277) see page 277) see page see page Gets ANRecordDataType object. Gets identification of field by field number. Gets field name by number representing field. Gets field number by id representing field. Get maximal field number value. Gets record name. Gets number representing record. see Gets all standard field numbers. Defines Type1 record record type object. Defines Type10 record record type object. Defines Type13 record record type object. Defines Type14 record record type object. Defines Type15 record record type object. Defines Type16 record record type object. Defines Type17 record record type object. Defines Type2 record record type object. Defines Type3 record record type object. Defines Type4 record record type object. Defines Type5 record record type object. Defines Type6 record record type object. Defines Type7 record record type object. Defines Type8 record record type object. Defines Type9 record record type object. Defines Type99 record record type object. Gets record type object by providing record number. Defines collection containing all record type objects. Gets user defined field numbers available in record. Gets NVersion object representing standard version. Checks if field information in record is available. Checks if field contained in record is mandatory. Checks if field contained in record is standard. Retrieves a function that retrieves NType object for the enclosing type. see page 277)
getFieldNumberById ( 278) getMaxFieldNumber ( 278) getName ( getNumber (
getStandardFieldNumbers ( page 278) getType1 ( getType10 ( getType13 ( getType14 ( getType15 ( getType16 ( getType17 ( getType2 ( getType3 ( getType4 ( getType5 ( getType6 ( getType7 ( getType8 ( getType9 ( getType99 ( see page 279) see page 279) see page 279) see page 279) see page 279) see page 279) see page 280) see page 280) see page 280) see page 280) see page 280) see page 280) see page 281) see page 281) see page 281) see page 281)
getTypeByNumber ( 281) getTypes (
see page
see page 282)
getUserDefinedFieldNumbers ( see page 282) getVersion ( see page 282) see page 282) see page 282) see page 283) see page 283) isFieldKnown (
isFieldMandatory ( isFieldStandard ( nativeTypeOf (
8.1.2.1.25.1 ANRecordType Classes

8.1.2.1.25.1.1 ANRecordType.RecordTypeCollection Class
Represent collection of record types.
276
public static final class RecordTypeCollection extends NObjectReadOnlyCollection<ANRecordType>; File ANRecordType.java
8.1.2.1.25.2 ANRecordType Fields

8.1.2.1.25.2.1 ANRecordType.MAX_NUMBER Field
Defines maximal allowed type number value. Java public static final int MAX_NUMBER = 99;
8.1.2.1.25.3 ANRecordType Methods

8.1.2.1.25.3.1 ANRecordType.getDataType Method
Gets ANRecordDataType object. Java public ANRecordDataType getDataType(); Returns ANRecordDataType object.
8.1.2.1.25.3.2 ANRecordType.getFieldId Method

Gets identification of field by field number. Java public String getFieldId(NVersion version, int fieldNumber); Parameters Parameters NVersion version int fieldNumber Returns String containing field identification. Description One of NVersion values. Number representing field.
8.1.2.1.25.3.3 ANRecordType.getFieldName Method

Gets field name by number representing field. Java public String getFieldName(NVersion version, int fieldNumber); Parameters Parameters NVersion version int fieldNumber Returns String containing name of the field. Description One of NVersion values. Number representing field.
277
8.1 Java Reference
8.1.2.1.25.3.4 ANRecordType.getFieldNumberById Method

Gets field number by id representing field. Java public int getFieldNumberById(NVersion version, String id); Parameters Parameters NVersion version String id Returns Number representing field. Description One of NVersion values. Field identification string.
8.1.2.1.25.3.5 ANRecordType.getMaxFieldNumber Method

Get maximal field number value. Java public int getMaxFieldNumber(NVersion version); Parameters Parameters NVersion version Returns Number representing maximal field number value. Description One of NVersion values.
8.1.2.1.25.3.6 ANRecordType.getName Method

Gets record name. Java public String getName(); Returns String containing record name.
8.1.2.1.25.3.7 ANRecordType.getNumber Method

Gets number representing record. Java public int getNumber(); Returns Returns record number.
8.1.2.1.25.3.8 ANRecordType.getStandardFieldNumbers Method

Gets all standard field numbers. Java public int getStandardFieldNumbers(NVersion version); Parameters Parameters NVersion version Description One of NVersion values. 278
Array of int containing standard field numbers.
8.1.2.1.25.3.9 ANRecordType.getType1 Method

Defines Type1 record record type object. Java public static ANRecordType getType1(); Returns ANRecordType ( see page 275) object representing record type 1.





Defines Type16 record record type object. Java public static ANRecordType getType16();
279
8.1 Java Reference Returns ANRecordType (
see page 275) object representing record type 16.






Defines Type6 record record type object. Java public static ANRecordType getType6();
280
8.1 Java Reference Returns ANRecordType (
see page 275) object representing record type 6.




8.1.2.1.25.3.25 ANRecordType.getTypeByNumber Method

Gets record type object by providing record number. Java public static ANRecordType getTypeByNumber(int number); Parameters Parameters int number Returns ANRecordType ( see page 275) object. Description Record number.
281
8.1 Java Reference
8.1.2.1.25.3.26 ANRecordType.getTypes Method

Defines collection containing all record type objects. Java public static RecordTypeCollection getTypes(); Returns ANRecordType ( see page 275) collection object RecordTypeCollection ( see page 276) which contains all record types.
8.1.2.1.25.3.27 ANRecordType.getUserDefinedFieldNumbers Method

Gets user defined field numbers available in record. Java public NRange getUserDefinedFieldNumbers(NVersion version); Parameters Parameters NVersion version Returns Array containing NRange objects. Description One of NVersion values.
8.1.2.1.25.3.28 ANRecordType.getVersion Method

Gets NVersion object representing standard version. Java public NVersion getVersion(); Returns NVersion object.
8.1.2.1.25.3.29 ANRecordType.isFieldKnown Method

Checks if field information in record is available. Java public boolean isFieldKnown(NVersion version, int fieldNumber); Parameters Parameters NVersion version int fieldNumber Returns true if information is available and false otherwise. Description One of NVersion values. Number representing field.
8.1.2.1.25.3.30 ANRecordType.isFieldMandatory Method

Checks if field contained in record is mandatory. Java public boolean isFieldMandatory(NVersion version, int fieldNumber); 282
8.1 Java Reference Parameters Parameters NVersion version int fieldNumber Returns true if field is mandatory and false otherwise.
Description One of NVersion values. Number representing field.
8.1.2.1.25.3.31 ANRecordType.isFieldStandard Method

Checks if field contained in record is standard. Java public boolean isFieldStandard(NVersion version, int fieldNumber); Parameters Parameters NVersion version int fieldNumber Returns true if field is standard and false otherwise. Description One of NVersion values. Number representing field.
8.1.2.1.25.3.32 ANRecordType.nativeTypeOf Method

8.1.2.1.26 ANSMT Class

Describes a general location of the captured scar, mark, tattoo, or other characteristic (including piercings) in the image. Java public final class ANSMT; File ANSMT.java Methods Name ANSMT ( see page 284) Description Initializes new instance of ANSMT structure.
283
8.1 Java Reference ANSMT Fields Name description ( source ( tattooClass ( see page 284) see page 284)
Description String containing SMT description. ANSmtSource object representing SMT source. ANTattooClass object representing tattoo class. ANTattooSubclass object representing tattoo subclass.
tattooSubclass (
8.1.2.1.26.1 ANSMT Constructor

8.1.2.1.26.1.1 ANSMT.ANSMT Constructor ()
Initializes new instance of ANSMT structure. Java public ANSMT();
8.1.2.1.26.1.2 ANSMT.ANSMT Constructor (ANSMTSource, ANTattooClass, ANTattooSubclass, String)

Initializes new instance of ANSMT structure. Java public ANSMT(ANSMTSource source, ANTattooClass tattooClass, ANTattooSubclass tattooSubclass, String description); Parameters Parameters ANSMTSource source ANTattooClass tattooClass ANTattooSubclass tattooSubclass String description Description One of ANSMTSource values representing SMT source ( see page 284). One of ANTattooClass values representing tattoo class. One of ANTattooSubclass values representing tattoo subclass. String containing SMT description ( see page 284).
8.1.2.1.26.2 ANSMT Fields

8.1.2.1.26.2.1 ANSMT.description Field
String containing SMT description. Java public String description;
8.1.2.1.26.2.2 ANSMT.source Field

ANSmtSource object representing SMT source. Java public ANSMTSource source;
8.1.2.1.26.2.3 ANSMT.tattooClass Field

ANTattooClass object representing tattoo class. Java public ANTattooClass tattooClass;
8.1.2.1.26.2.4 ANSMT.tattooSubclass Field

ANTattooSubclass object representing tattoo subclass. 284
public ANTattooSubclass tattooSubclass;
8.1.2.1.27 ANSubField Class

Provides functionality for managing subfields. Java public final class ANSubField extends NObject; File ANSubField.java ANSubField Classes Name ItemCollection ( ANSubField Methods Name getItems ( getValue ( setValue ( see page 285) see page 285) see page 286) see page 286) Description Gets particular item from the ANSubField. Gets field value. Retrieves a function that retrieves NType object for the enclosing type. Sets subfield value. see page 285) Description Represent collection of items in subfield.
nativeTypeOf (
8.1.2.1.27.1 ANSubField Classes

8.1.2.1.27.1.1 ANSubField.ItemCollection Class
Represent collection of items in subfield. Java public final class ItemCollection extends StringCollection; File ANSubField.java
8.1.2.1.27.2 ANSubField Methods

8.1.2.1.27.2.1 ANSubField.getItems Method
Gets particular item from the ANSubField ( Java public ItemCollection getItems(); Returns A ItemCollection ( see page 285) representing items from ANSubField ( see page 285). see page 285).
8.1.2.1.27.2.2 ANSubField.getValue Method

Gets field value. Java public String getValue(); Returns String containing field value. 285
8.1 Java Reference
8.1.2.1.27.2.3 ANSubField.nativeTypeOf Method

8.1.2.1.27.2.4 ANSubField.setValue Method

Sets subfield value. Java public void setValue(String value); Parameters Parameters String value Description String containing subfield value.
8.1.2.1.28 ANTemplate Class

Provides functionality for working with Neurotec.Biometrics.Standards.ANRecord ( see Neurotec.Biometrics.Standards.ANTemplate as it is described in ANSI/NIST-ITL 1-2007 standard. Java public final class ANTemplate extends NObject implements Cloneable; File ANTemplate.java Methods Name ANTemplate ( ANTemplate Classes Name RecordCollection ( ANTemplate Fields Name Description see page 290) Description Represent collection of records in ANTemplate. see page 287) Description Initializes a new instance of the ANTemplate class. page 270) and
FLAG_LEAVE_INVALID_RECORDS_UNVALIDATED Leaves invalid records unvalidated. ( see page 316) FLAG_USE_NIST_MINUTIA_NEIGHBORS ( page 316) VERSION_20 ( see page 316) see Uses NIST minutia neighbors data. This ANTemplate version implemets "Data Format for the Interchange of Fingerprint Information" standard (ANSI/NIST-CSL 1-1993) format. This ANTemplate version implemets "Data Format for the Interchange of Fingerprint Information" standard (ANSI/NIST-ITL 1a-1997) format. This ANTemplate version implemets "Data Format for the Interchange of Fingerprint, Facial, & Scar Mark & Tattoo (SMT) Information that carried the ANSI designation of ANSI/NIST-ITL 1-2000.
VERSION_21 (
see page 316)
VERSION_30 (
see page 317)
286
8.1 Java Reference VERSION_40 (
see page 317)
This ANTemplate version implemets current version of the standard that carried the ANSI designation of (ANSI/NIST-ITL 1-2007). Defines the current version of standard that ANTemplate library implements.
VERSION_CURRENT ( ANTemplate Methods Name getRecords ( getVersion (
see page 317)
Description see page 317) see page 317) see page 317) Gets particular records from the ANTemplate. Gets NVersion object representing standard version. Gets standard version name to which template loaded to memory conforms. Gets versions of standard to which template loaded to memory conforms. Checks if provided standard version is supported by ANTemplate library. Retrieves a function that retrieves NType object for the enclosing type. Saves the ANTemplate to the specified file. Sets NVersion object representing standard version. Converts ANTemplate to Neurotechnology Template (NTemplate ( page 210)). see see page 317) Gets validation level of ANTemplate.
getValidationLevel ( getVersionName ( getVersions (
isVersionSupported ( 318) nativeTypeOf ( save ( setVersion ( toNTemplate ( see page 318)
see page 318)
8.1.2.1.28.1 ANTemplate Constructor

8.1.2.1.28.1.1 ANTemplate.ANTemplate Constructor ()
Initializes a new instance of the ANTemplate class. Java public ANTemplate();
8.1.2.1.28.1.2 ANTemplate.ANTemplate Constructor (ByteBuffer, ANValidationLevel)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(ByteBuffer buffer, ANValidationLevel validationLevel); Parameters Parameters ByteBuffer buffer ANValidationLevel validationLevel Description ByteBuffer from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard.
8.1.2.1.28.1.3 ANTemplate.ANTemplate Constructor (ByteBuffer, ANValidationLevel, int)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(ByteBuffer buffer, ANValidationLevel validationLevel, int flags); Parameters Parameters ByteBuffer buffer ANValidationLevel validationLevel int flags Description ByteBuffer from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard. Should be zero. 287
8.1 Java Reference
8.1.2.1.28.1.4 ANTemplate.ANTemplate Constructor (InputStream, ANValidationLevel)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(InputStream in, ANValidationLevel validationLevel) throws IOException; Parameters Parameters InputStream in ANValidationLevel validationLevel Description Stream from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard.
8.1.2.1.28.1.5 ANTemplate.ANTemplate Constructor (InputStream, ANValidationLevel, int)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(InputStream in, ANValidationLevel validationLevel, int flags) throws IOException; Parameters Parameters InputStream in ANValidationLevel validationLevel int flags Description Stream from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard. Should be zero.
8.1.2.1.28.1.6 ANTemplate.ANTemplate Constructor (ReadableByteChannel, ANValidationLevel)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(ReadableByteChannel ch, ANValidationLevel validationLevel) throws IOException; Parameters Parameters ReadableByteChannel ch ANValidationLevel validationLevel Description Byte channel from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard.
8.1.2.1.28.1.7 ANTemplate.ANTemplate Constructor (ReadableByteChannel, ANValidationLevel, int)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(ReadableByteChannel ch, ANValidationLevel validationLevel, int flags) throws IOException; Parameters Parameters ReadableByteChannel ch ANValidationLevel validationLevel int flags Description Byte channel from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard. Should be zero.
288
8.1 Java Reference
8.1.2.1.28.1.8 ANTemplate.ANTemplate Constructor (String, ANValidationLevel)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(String fileName, ANValidationLevel validationLevel) throws IOException; Parameters Parameters String fileName ANValidationLevel validationLevel Description Name of file from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard.
8.1.2.1.28.1.9 ANTemplate.ANTemplate Constructor (String, ANValidationLevel, int)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(String fileName, ANValidationLevel validationLevel, int flags) throws IOException; Parameters Parameters String fileName ANValidationLevel validationLevel int flags Description Name of file from which ANTemplate would be initialized. Validation level of ANTemplate records. The following validation levels are supported Minimal, Standard. Should be zero.
8.1.2.1.28.1.10 ANTemplate.ANTemplate Constructor (String, String, String, String)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(String tot, String dai, String ori, String tcn); Parameters Parameters String tot String dai String ori String tcn Description String which contains transaction type identifier. String which contains destination agency identifier. String which contains originating agency identifier. String which contains transaction control identifier.
8.1.2.1.28.1.11 ANTemplate.ANTemplate Constructor (String, String, String, String, boolean, NTemplate)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(String tot, String dai, String ori, String tcn, boolean type9RecordFmt, NTemplate nTemplate); Parameters Parameters String tot String dai String ori String tcn boolean type9RecordFmt Description String which contains transaction type identifier. String which contains destination agency identifier. String which contains originating agency identifier. String which contains transaction control identifier. Minutiae format flag value. NTrue if minutiae format is standard NFalse otherwise. 289
8.1 Java Reference NTemplate nTemplate
NTemplate ( see page 210) from which ANTemplate would be initialized.
8.1.2.1.28.1.12 ANTemplate.ANTemplate Constructor (String, String, String, String, boolean, NTemplate, int)
Initializes a new instance of the ANTemplate class. Java public ANTemplate(String tot, String dai, String ori, String tcn, boolean type9RecordFmt, NTemplate nTemplate, int flags); Parameters Parameters String tot String dai String ori String tcn boolean type9RecordFmt NTemplate nTemplate int flags Description String which contains transaction type identifier. String which contains destination agency identifier. String which contains originating agency identifier. String which contains transaction control identifier. Minutiae format flag value. NTrue if minutiae format is standard NFalse otherwise. NTemplate ( see page 210) from which ANTemplate would be initialized. Should be zero.
8.1.2.1.28.1.13 ANTemplate.ANTemplate Constructor (String, String, String, String, int)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(String tot, String dai, String ori, String tcn, int flags); Parameters Parameters String tot String dai String ori String tcn int flags Description String which contains transaction type identifier. String which contains destination agency identifier. String which contains originating agency identifier. String which contains transaction control identifier. Should be zero.
8.1.2.1.28.1.14 ANTemplate.ANTemplate Constructor (int)

Initializes a new instance of the ANTemplate class. Java public ANTemplate(int flags); Parameters Parameters int flags Description Should be zero.
8.1.2.1.28.2 ANTemplate Classes

8.1.2.1.28.2.1 ANTemplate.RecordCollection Class
Represent collection of records in ANTemplate ( see page 286).
290
public final class RecordCollection extends NObjectCollection<ANRecord>; File ANTemplate.java RecordCollection Methods Name add ( see page 291) see page 292) see page 294) see page 296) see page 297) see page 299) see page 301) see page 303) see page 303) see page 305) see page 307) see page 308) see page 310) see page 311) see page 313) see page 315) addType10 ( addType13 ( addType14 ( addType15 ( addType16 ( addType17 ( addType2 ( addType3 ( addType4 ( addType5 ( addType6 ( addType7 ( addType8 ( addType9 ( addType99 ( Description Adds record to ANTemplate ( see page 286). see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. see page 286) object. Adds type-10 record to ANTemplate ( Adds type-13 record to ANTemplate ( Adds type-14 record to ANTemplate ( Adds type-15 record to ANTemplate ( Adds type-16 record to ANTemplate ( Adds type-17 record to ANTemplate ( Adds type-2 record to ANTemplate ( Adds type-3 record to ANTemplate ( Adds type-4 record to ANTemplate ( Adds type-5 record to ANTemplate ( Adds type-6 record to ANTemplate ( Adds type-7 record to ANTemplate ( Adds type-8 record to ANTemplate ( Adds type-9 record to ANTemplate ( Adds type-99 record to ANTemplate (
8.1.2.1.28.2.1.1 RecordCollection Methods 8.1.2.1.28.2.1.1.1 add Method 8.1.2.1.28.2.1.1.1.1 ANTemplate.RecordCollection.add Method (ANRecordType, int)
Adds record to ANTemplate ( Java public ANRecord add(ANRecordType recordType, int idc); Parameters Parameters ANRecordType recordType int idc Returns ANRecord ( see page 270) object. Description Record type object. Image designation character value. see page 286).
8.1.2.1.28.2.1.1.1.2 ANTemplate.RecordCollection.add Method (ANRecordType, int, int)

Adds record to ANTemplate ( Java public ANRecord add(ANRecordType recordType, int idc, int flags); Parameters Parameters ANRecordType recordType Description Record type object. 291 see page 286).
8.1 Java Reference int idc int flags Returns ANRecord ( see page 270) object.
Image designation character value. Must be zero.
8.1.2.1.28.2.1.1.2 addType10 Method 8.1.2.1.28.2.1.1.2.1 ANTemplate.RecordCollection.addType10 Method (int, ANImageType, String, BDIFScaleUnits, ANImageCompressionAlgorithm, String, NImage)
Adds type-10 record to ANTemplate ( Java public ANType10Record addType10(int idc, ANImageType imt, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, String smt, NImage image); Parameters Parameters int idc ANImageType imt String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga String smt NImage image Returns ANType10Record ( see page 320) object. Description Image designation character value. One of ANImageType values. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. String which contains general location of the captured scar, mark, tattoo, or other characteristic in image Facial image. see page 286) object.
8.1.2.1.28.2.1.1.2.2 ANTemplate.RecordCollection.addType10 Method (int, ANImageType, String, BDIFScaleUnits, ANImageCompressionAlgorithm, String, NImage, int)
Adds type-10 record to ANTemplate ( Java public ANType10Record addType10(int idc, ANImageType imt, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, String smt, NImage image, int flags); Parameters Parameters int idc ANImageType imt String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga String smt NImage image int flags Returns ANType10Record ( see page 320) object. Description Image designation character value. One of ANImageType values. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. String which contains general location of the captured scar, mark, tattoo, or other characteristic in image Facial image. Must be zero. see page 286) object.
292
8.1 Java Reference
8.1.2.1.28.2.1.1.2.3 ANTemplate.RecordCollection.addType10 Method (int, ANImageType, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, ANImageColorSpace, String, ByteBuffer)
Adds type-10 record to ANTemplate ( Java public ANType10Record addType10(int idc, ANImageType imt, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, ANImageColorSpace csp, String smt, ByteBuffer imageData); Parameters Parameters int idc ANImageType imt String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga ANImageColorSpace csp String smt ByteBuffer imageData Returns ANType10Record ( see page 320) object Description Image designation character value. One of ANImageType values. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. One of ANImageColorSpace values. String which contains general location of the captured scar, mark, tattoo, or other characteristic in image. Buffer containing image data. see page 286) object.
8.1.2.1.28.2.1.1.2.4 ANTemplate.RecordCollection.addType10 Method (int, ANImageType, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, ANImageColorSpace, String, ByteBuffer, int)
Adds type-10 record to ANTemplate ( Java public ANType10Record addType10(int idc, ANImageType imt, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, ANImageColorSpace csp, String smt, ByteBuffer imageData, int flags); Parameters Parameters int idc ANImageType imt String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga ANImageColorSpace csp String smt Description Image designation character value. One of ANImageType values. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. One of ANImageColorSpace values. String which contains general location of the captured scar, mark, tattoo, or other characteristic in image. 293 see page 286) object.
8.1 Java Reference ByteBuffer imageData int flags Returns ANType10Record (
Buffer containing image data. Must be zero.
see page 320) object
8.1.2.1.28.2.1.1.3 addType13 Method 8.1.2.1.28.2.1.1.3.1 ANTemplate.RecordCollection.addType13 Method (int, BDIFFPImpressionType, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage)
Adds type-13 record to ANTemplate ( Java public ANType13Record addType13(int idc, BDIFFPImpressionType imp, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image); Parameters Parameters int idc BDIFFPImpressionType imp String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image Returns ANType13Record ( see page 342) object. Description Image designation character value. One of BDIFFPImpressionType values. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Latent image. see page 286) object.
8.1.2.1.28.2.1.1.3.2 ANTemplate.RecordCollection.addType13 Method (int, BDIFFPImpressionType, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage, int)
Adds type-13 record to ANTemplate ( Java public ANType13Record addType13(int idc, BDIFFPImpressionType imp, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image, int flags); Parameters Parameters int idc BDIFFPImpressionType imp String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image int flags Returns ANType13Record ( see page 342) object. Description Image designation character value. One of BDIFFPImpressionType values. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Latent image. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.3.3 ANTemplate.RecordCollection.addType13 Method (int, BDIFFPImpressionType, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer)
Adds type-13 record to ANTemplate ( see page 286) object.
294
public ANType13Record addType13(int idc, BDIFFPImpressionType imp, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ByteBuffer imageData); Parameters Parameters int idc BDIFFPImpressionType imp String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ByteBuffer imageData Returns ANType13Record ( see page 342) object Description Image designation character value. One of BDIFFPImpressionType values. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. Buffer containing image data.
8.1.2.1.28.2.1.1.3.4 ANTemplate.RecordCollection.addType13 Method (int, BDIFFPImpressionType, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer, int)
Adds type-13 record to ANTemplate ( Java public ANType13Record addType13(int idc, BDIFFPImpressionType imp, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ByteBuffer imageData, int flags); Parameters Parameters int idc BDIFFPImpressionType imp String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ByteBuffer imageData int flags Returns ANType13Record ( see page 342) object Description Image designation character value. One of BDIFFPImpressionType values. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. Buffer containing image data. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.4 addType14 Method
295
8.1 Java Reference
8.1.2.1.28.2.1.1.4.1 ANTemplate.RecordCollection.addType14 Method (int, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage)

Adds type-14 record to ANTemplate ( Java public ANType14Record addType14(int idc, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image); Parameters Parameters int idc String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image Returns ANType14Record ( see page 349) object. Description Image designation character value. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Fingerprint image. see page 286) object.
8.1.2.1.28.2.1.1.4.2 ANTemplate.RecordCollection.addType14 Method (int, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage, int)

Adds type-14 record to ANTemplate ( Java public ANType14Record addType14(int idc, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image, int flags); Parameters Parameters int idc String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image int flags Returns ANType14Record ( see page 349) object. Description Image designation character value. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Fingerprint image. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.4.3 ANTemplate.RecordCollection.addType14 Method (int, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer)
Adds type-14 record to ANTemplate ( Java public ANType14Record addType14(int idc, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ByteBuffer imageData); Parameters Parameters int idc String src short hll short vll Description Image designation character value. String which contains identification of organization. Horizontal line length value. Vertical line length value. 296 see page 286) object.
8.1 Java Reference BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ByteBuffer imageData Returns ANType14Record (
One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. Buffer containing image data.
8.1.2.1.28.2.1.1.4.4 ANTemplate.RecordCollection.addType14 Method (int, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer, int)
Adds type-14 record to ANTemplate ( Java public ANType14Record addType14(int idc, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ByteBuffer imageData, int flags); Parameters Parameters int idc String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ByteBuffer imageData int flags Returns ANType14Record ( see page 349) object Description Image designation character value. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. Buffer containing image data. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.5 addType15 Method 8.1.2.1.28.2.1.1.5.1 ANTemplate.RecordCollection.addType15 Method (int, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage)
Adds type-15 record to ANTemplate ( Java public ANType15Record addType15(int idc, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image); Parameters Parameters int idc String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image Description Image designation character value. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Palmprint image. 297 see page 286) object.
8.1 Java Reference Returns ANType15Record (

Adds type-15 record to ANTemplate ( Java public ANType15Record addType15(int idc, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image, int flags); Parameters Parameters int idc String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image int flags Returns ANType15Record ( see page 360) object. Description Image designation character value. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Palmprint image. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.5.3 ANTemplate.RecordCollection.addType15 Method (int, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer)
Adds type-15 record to ANTemplate ( Java public ANType15Record addType15(int idc, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ByteBuffer imageData); Parameters Parameters int idc String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ByteBuffer imageData Returns ANType15Record ( see page 360) object Description Image designation character value. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. Buffer containing image data. see page 286) object.
8.1.2.1.28.2.1.1.5.4 ANTemplate.RecordCollection.addType15 Method (int, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer, int)
Adds type-15 record to ANTemplate ( Java public ANType15Record addType15(int idc, String src, short hll, short vll, BDIFScaleUnits 298 see page 286) object.
8.1 Java Reference
slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ByteBuffer imageData, int flags); Parameters Parameters int idc String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ByteBuffer imageData int flags Returns ANType15Record ( see page 360) object Description Image designation character value. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. Buffer containing image data. Must be zero.
8.1.2.1.28.2.1.1.6 addType16 Method 8.1.2.1.28.2.1.1.6.1 ANTemplate.RecordCollection.addType16 Method (int, String, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage)
Adds type-16 record to ANTemplate ( Java public ANType16Record addType16(int idc, String udi, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image); Parameters Parameters int idc String udi String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image Returns ANType16Record ( see page 366) object. Description Image designation character value. String which contains type of user-defined image that will be contained in record. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. An image. see page 286) object.
8.1.2.1.28.2.1.1.6.2 ANTemplate.RecordCollection.addType16 Method (int, String, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage, int)
Adds type-16 record to ANTemplate ( Java public ANType16Record addType16(int idc, String udi, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image, int flags); Parameters Parameters int idc Description Image designation character value. 299 see page 286) object.
8.1 Java Reference String udi String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image int flags Returns ANType16Record (
String which contains type of user-defined image that will be contained in record. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. An image. Must be zero.
8.1.2.1.28.2.1.1.6.3 ANTemplate.RecordCollection.addType16 Method (int, String, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ANImageColorSpace, ByteBuffer)
Adds type-16 record to ANTemplate ( Java public ANType16Record addType16(int idc, String udi, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ANImageColorSpace csp, ByteBuffer imageData); Parameters Parameters int idc String udi String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ANImageColorSpace csp ByteBuffer imageData Returns ANType16Record ( see page 366) object Description Image designation character value. String which contains type of user-defined image that will be contained in record. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. One of ANImageColorSpace values. Buffer containing image data. see page 286) object.
8.1.2.1.28.2.1.1.6.4 ANTemplate.RecordCollection.addType16 Method (int, String, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ANImageColorSpace, ByteBuffer, int)
Adds type-16 record to ANTemplate ( Java public ANType16Record addType16(int idc, String udi, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ANImageColorSpace csp, ByteBuffer imageData, int flags); Parameters Parameters int idc String udi String src Description Image designation character value. String which contains type of user-defined image that will be contained in record. String which contains identification of organization. 300 see page 286) object.
8.1 Java Reference short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ANImageColorSpace csp ByteBuffer imageData int flags Returns ANType16Record (
Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. One of ANImageColorSpace values. Buffer containing image data. Must be zero.
8.1.2.1.28.2.1.1.7 addType17 Method 8.1.2.1.28.2.1.1.7.1 ANTemplate.RecordCollection.addType17 Method (int, String, BDIFScaleUnits, ANImageCompressionAlgorithm, NImage)
Adds type-17 record to ANTemplate ( Java public ANType17Record addType17(int idc, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image); Parameters Parameters int idc String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image Returns ANType17Record ( see page 372) object. Description Image designation character value. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Palmprint image. see page 286) object.

Adds type-17 record to ANTemplate ( Java public ANType17Record addType17(int idc, String src, BDIFScaleUnits slc, ANImageCompressionAlgorithm cga, NImage image, int flags); Parameters Parameters int idc String src BDIFScaleUnits slc ANImageCompressionAlgorithm cga NImage image int flags Description Image designation character value. String which contains identification of organization. One of BDIFScaleUnits values. One of ANImageCompressionAlgorithm values. Palmprint image. Must be zero. see page 286) object.
301
8.1.2.1.28.2.1.1.7.3 ANTemplate.RecordCollection.addType17 Method (int, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ANImageColorSpace, ByteBuffer)
Adds type-17 record to ANTemplate ( Java public ANType17Record addType17(int idc, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ANImageColorSpace csp, ByteBuffer imageData); Parameters Parameters int idc String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ANImageColorSpace csp ByteBuffer imageData Returns ANType17Record ( see page 372) object Description Image designation character value. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. One of ANImageColorSpace values. Buffer containing image data. see page 286) object.
8.1.2.1.28.2.1.1.7.4 ANTemplate.RecordCollection.addType17 Method (int, String, short, short, BDIFScaleUnits, short, short, ANImageCompressionAlgorithm, byte, ANImageColorSpace, ByteBuffer, int)
Adds type-17 record to ANTemplate ( Java public ANType17Record addType17(int idc, String src, short hll, short vll, BDIFScaleUnits slc, short hps, short vps, ANImageCompressionAlgorithm cga, byte bpx, ANImageColorSpace csp, ByteBuffer imageData, int flags); Parameters Parameters int idc String src short hll short vll BDIFScaleUnits slc short hps short vps ANImageCompressionAlgorithm cga byte bpx ANImageColorSpace csp ByteBuffer imageData int flags Description Image designation character value. String which contains identification of organization. Horizontal line length value. Vertical line length value. One of BDIFScaleUnits values. Horizontal pixel scale value. Vertical pixel scale value. One of ANImageCompressionAlgorithm values. Bits per pixel value. One of ANImageColorSpace values. Buffer containing image data. Must be zero. 302 see page 286) object.
8.1.2.1.28.2.1.1.8 addType2 Method 8.1.2.1.28.2.1.1.8.1 ANTemplate.RecordCollection.addType2 Method (int)

Adds type-2 record to ANTemplate ( Java public ANType2Record addType2(int idc); Parameters Parameters int idc Returns ANType2Record ( see page 400) object Description Image designation character value. see page 286) object.
8.1.2.1.28.2.1.1.8.2 ANTemplate.RecordCollection.addType2 Method (int, int)

Adds type-2 record to ANTemplate ( Java public ANType2Record addType2(int idc, int flags); Parameters Parameters int idc int flags Returns ANType2Record ( see page 400) object Description Image designation character value. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.9 addType3 Method 8.1.2.1.28.2.1.1.9.1 ANTemplate.RecordCollection.addType3 Method (int, boolean, int, ANImageCompressionAlgorithm, NGrayscaleImage)
Adds type-3 record to ANTemplate ( Java public ANType3Record addType3(int idc, boolean isr, int isrValue, ANImageCompressionAlgorithm ca, NGrayscaleImage image); Parameters Parameters int idc boolean isr int isrValue ANImageCompressionAlgorithm ca NGrayscaleImage image Returns ANType3Record ( see page 401) object 303 Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANImageCompressionAlgorithm values. An image. see page 286) object.
8.1 Java Reference
8.1.2.1.28.2.1.1.9.2 ANTemplate.RecordCollection.addType3 Method (int, boolean, int, ANImageCompressionAlgorithm, NGrayscaleImage, int)

Adds type-3 record to ANTemplate ( Java public ANType3Record addType3(int idc, boolean isr, int isrValue, ANImageCompressionAlgorithm ca, NGrayscaleImage image, int flags); Parameters Parameters int idc boolean isr int isrValue ANImageCompressionAlgorithm ca NGrayscaleImage image int flags Returns ANType3Record ( see page 401) object Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANImageCompressionAlgorithm values. An image. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.9.3 ANTemplate.RecordCollection.addType3 Method (int, boolean, int, int, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer)
Adds type-3 record to ANTemplate ( Java public ANType3Record addType3(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData); Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll ANImageCompressionAlgorithm ca byte vendorCA ByteBuffer imageData Returns ANType3Record ( see page 401) object Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. One of ANImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. Buffer containing image data. see page 286) object.
8.1.2.1.28.2.1.1.9.4 ANTemplate.RecordCollection.addType3 Method (int, boolean, int, int, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer, int)
Adds type-3 record to ANTemplate ( Java public ANType3Record addType3(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData, int flags); see page 286) object.
304
8.1 Java Reference Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll ANImageCompressionAlgorithm ca byte vendorCA ByteBuffer imageData int flags Returns ANType3Record ( see page 401) object
Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. One of ANImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. Buffer containing image data. Must be zero.
8.1.2.1.28.2.1.1.10 addType4 Method 8.1.2.1.28.2.1.1.10.1 ANTemplate.RecordCollection.addType4 Method (int, boolean, int, ANImageCompressionAlgorithm, NGrayscaleImage)
Adds type-4 record to ANTemplate ( Java public ANType4Record addType4(int idc, boolean isr, int isrValue, ANImageCompressionAlgorithm ca, NGrayscaleImage image); Parameters Parameters int idc boolean isr int isrValue ANImageCompressionAlgorithm ca NGrayscaleImage image Returns ANType4Record ( see page 404) object Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANImageCompressionAlgorithm values. NGrayscaleImage image object see page 286) object.
8.1.2.1.28.2.1.1.10.2 ANTemplate.RecordCollection.addType4 Method (int, boolean, int, ANImageCompressionAlgorithm, NGrayscaleImage, int)

Adds type-4 record to ANTemplate ( Java public ANType4Record addType4(int idc, boolean isr, int isrValue, ANImageCompressionAlgorithm ca, NGrayscaleImage image, int flags); Parameters Parameters int idc boolean isr Description Image designation character value. Image scanning resolution flag. see page 286) object.
305
8.1 Java Reference int isrValue ANImageCompressionAlgorithm ca NGrayscaleImage image int flags Returns ANType4Record ( see page 404) object
Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANImageCompressionAlgorithm values. NGrayscaleImage image object Must be zero.
8.1.2.1.28.2.1.1.10.3 ANTemplate.RecordCollection.addType4 Method (int, boolean, int, int, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer)
Adds type-4 record to ANTemplate ( Java public ANType4Record addType4(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData); Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll ANImageCompressionAlgorithm ca byte vendorCA ByteBuffer imageData Returns ANType4Record ( see page 404) object Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. One of ANImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. Buffer containing image data. see page 286) object.
8.1.2.1.28.2.1.1.10.4 ANTemplate.RecordCollection.addType4 Method (int, boolean, int, int, short, short, ANImageCompressionAlgorithm, byte, ByteBuffer, int)
Adds type-4 record to ANTemplate ( Java public ANType4Record addType4(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData, int flags); Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll ANImageCompressionAlgorithm ca byte vendorCA Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. One of ANImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. 306 see page 286) object.
8.1 Java Reference ByteBuffer imageData int flags Returns ANType4Record ( see page 404) object
Buffer containing image data. Must be zero.
8.1.2.1.28.2.1.1.11 addType5 Method 8.1.2.1.28.2.1.1.11.1 ANTemplate.RecordCollection.addType5 Method (int, boolean, int, ANBinaryImageCompressionAlgorithm, NMonochromeImage)
Adds type-5 record to ANTemplate ( Java public ANType5Record addType5(int idc, boolean isr, int isrValue, ANBinaryImageCompressionAlgorithm ca, NMonochromeImage image); Parameters Parameters int idc boolean isr int isrValue ANBinaryImageCompressionAlgorithm ca NMonochromeImage image Returns ANType5Record ( see page 407) object. Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANBinaryImageCompressionAlgorithm values. NMonochromeImage image object. see page 286) object.
8.1.2.1.28.2.1.1.11.2 ANTemplate.RecordCollection.addType5 Method (int, boolean, int, ANBinaryImageCompressionAlgorithm, NMonochromeImage, int)

Adds type-5 record to ANTemplate ( Java public ANType5Record addType5(int idc, boolean isr, int isrValue, ANBinaryImageCompressionAlgorithm ca, NMonochromeImage image, int flags); Parameters Parameters int idc boolean isr int isrValue ANBinaryImageCompressionAlgorithm ca NMonochromeImage image int flags Returns ANType5Record ( see page 407) object. Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANBinaryImageCompressionAlgorithm values. NMonochromeImage image object. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.11.3 ANTemplate.RecordCollection.addType5 Method (int, boolean, int, int, short, short, ANBinaryImageCompressionAlgorithm, byte, ByteBuffer)
307
public ANType5Record addType5(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANBinaryImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData); Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll ANBinaryImageCompressionAlgorithm ca byte vendorCA ByteBuffer imageData Returns ANType5Record ( see page 407) object Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. One of ANBinaryImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. Buffer containing image data.
8.1.2.1.28.2.1.1.11.4 ANTemplate.RecordCollection.addType5 Method (int, boolean, int, int, short, short, ANBinaryImageCompressionAlgorithm, byte, ByteBuffer, int)
Adds type-5 record to ANTemplate ( Java public ANType5Record addType5(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANBinaryImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData, int flags); Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll ANBinaryImageCompressionAlgorithm ca byte vendorCA ByteBuffer imageData int flags Returns ANType5Record ( see page 407) object Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. One of ANBinaryImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. Buffer containing image data. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.12 addType6 Method 8.1.2.1.28.2.1.1.12.1 ANTemplate.RecordCollection.addType6 Method (int, boolean, int, ANBinaryImageCompressionAlgorithm, NMonochromeImage)
308
public ANType6Record addType6(int idc, boolean isr, int isrValue, ANBinaryImageCompressionAlgorithm ca, NMonochromeImage image); Parameters Parameters int idc boolean isr int isrValue ANBinaryImageCompressionAlgorithm ca NMonochromeImage image Returns ANType6Record ( see page 410) object. Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANBinaryImageCompressionAlgorithm values. NMonochromeImage image object.
8.1.2.1.28.2.1.1.12.2 ANTemplate.RecordCollection.addType6 Method (int, boolean, int, ANBinaryImageCompressionAlgorithm, NMonochromeImage, int)

Adds type-6 record to ANTemplate ( Java public ANType6Record addType6(int idc, boolean isr, int isrValue, ANBinaryImageCompressionAlgorithm ca, NMonochromeImage image, int flags); Parameters Parameters int idc boolean isr int isrValue ANBinaryImageCompressionAlgorithm ca NMonochromeImage image int flags Returns ANType6Record ( see page 410) object. Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. One of ANBinaryImageCompressionAlgorithm values. NMonochromeImage image object. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.12.3 ANTemplate.RecordCollection.addType6 Method (int, boolean, int, int, short, short, ANBinaryImageCompressionAlgorithm, byte, ByteBuffer)
Adds type-6 record to ANTemplate ( Java public ANType6Record addType6(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANBinaryImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData); Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. 309 see page 286) object.
8.1 Java Reference ANBinaryImageCompressionAlgorithm ca byte vendorCA ByteBuffer imageData Returns ANType6Record ( see page 410) object
One of ANBinaryImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. Buffer containing image data.
8.1.2.1.28.2.1.1.12.4 ANTemplate.RecordCollection.addType6 Method (int, boolean, int, int, short, short, ANBinaryImageCompressionAlgorithm, byte, ByteBuffer, int)
Adds type-6 record to ANTemplate ( Java public ANType6Record addType6(int idc, boolean isr, int isrValue, int ir, short hll, short vll, ANBinaryImageCompressionAlgorithm ca, byte vendorCA, ByteBuffer imageData, int flags); Parameters Parameters int idc boolean isr int isrValue int ir short hll short vll ANBinaryImageCompressionAlgorithm ca byte vendorCA ByteBuffer imageData int flags Returns ANType6Record ( see page 410) object Description Image designation character value. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. One of ANBinaryImageCompressionAlgorithm values. Value of compression algorithm used if anicaVendor passed as ca parameter. Otherwise zero. Buffer containing image data. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.13 addType7 Method 8.1.2.1.28.2.1.1.13.1 ANTemplate.RecordCollection.addType7 Method (int, int, int, ByteBuffer)
Adds type-7 record to ANTemplate ( Java public ANType7Record addType7(int idc, int isr, int ir, ByteBuffer imageData); Parameters Parameters int idc int isr int ir ByteBuffer imageData Returns ANType7Record ( see page 412) object Description Image designation character value. Image scanning resolution flag. Native image resolution value. Buffer containing image data. see page 286) object.
310
8.1 Java Reference
8.1.2.1.28.2.1.1.13.2 ANTemplate.RecordCollection.addType7 Method (int, int, int, ByteBuffer, int)

Adds type-7 record to ANTemplate ( Java public ANType7Record addType7(int idc, int isr, int ir, ByteBuffer imageData, int flags); Parameters Parameters int idc int isr int ir ByteBuffer imageData int flags Returns ANType7Record ( see page 412) object Description Image designation character value. Image scanning resolution flag. Native image resolution value. Buffer containing image data. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.14 addType8 Method 8.1.2.1.28.2.1.1.14.1 ANTemplate.RecordCollection.addType8 Method (int, ANSignatureRepresentationType, boolean, int, NMonochromeImage)
Adds type-8 record to ANTemplate ( Java public ANType8Record addType8(int idc, ANSignatureRepresentationType srt, boolean isr, int isrValue, NMonochromeImage image); Parameters Parameters int idc ANSignatureRepresentationType srt boolean isr int isrValue NMonochromeImage image Returns ANType8Record ( see page 414) object. Description Image designation character value. One of ANSignatureRepresentationType values. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. NMonochromeImage image object. see page 286) object.
8.1.2.1.28.2.1.1.14.2 ANTemplate.RecordCollection.addType8 Method (int, ANSignatureRepresentationType, boolean, int, NMonochromeImage, int)

Adds type-8 record to ANTemplate ( Java public ANType8Record addType8(int idc, ANSignatureRepresentationType srt, boolean isr, int isrValue, NMonochromeImage image, int flags); Parameters Parameters int idc ANSignatureRepresentationType srt boolean isr Description Image designation character value. One of ANSignatureRepresentationType values. Image scanning resolution flag. see page 286) object.
311
8.1 Java Reference int isrValue NMonochromeImage image int flags Returns ANType8Record ( see page 414) object.
Image scanning resolution value. Units of this parameter is pixel points per millimeter. NMonochromeImage image object. Must be zero.
8.1.2.1.28.2.1.1.14.3 ANTemplate.RecordCollection.addType8 Method (int, ANSignatureRepresentationType, boolean, int, int, short, short, ByteBuffer)
Adds type-8 record to ANTemplate ( Java public ANType8Record addType8(int idc, ANSignatureRepresentationType srt, boolean isr, int isrValue, int ir, short hll, short vll, ByteBuffer imageData); Parameters Parameters int idc ANSignatureRepresentationType srt boolean isr int isrValue int ir short hll short vll ByteBuffer imageData Returns ANType8Record ( see page 414) object Description Image designation character value. One of ANSignatureRepresentationType values. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. Buffer containing image data. see page 286) object.
8.1.2.1.28.2.1.1.14.4 ANTemplate.RecordCollection.addType8 Method (int, ANSignatureRepresentationType, boolean, int, int, short, short, ByteBuffer, int)
Adds type-8 record to ANTemplate ( Java public ANType8Record addType8(int idc, ANSignatureRepresentationType srt, boolean isr, int isrValue, int ir, short hll, short vll, ByteBuffer imageData, int flags); Parameters Parameters int idc ANSignatureRepresentationType srt boolean isr int isrValue int ir short hll short vll ByteBuffer imageData int flags Returns ANType8Record ( see page 414) object 312 Description Image designation character value. One of ANSignatureRepresentationType values. Image scanning resolution flag. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Horizontal line length value. Vertical line length value. Buffer containing image data. Must be zero. see page 286) object.
8.1 Java Reference
8.1.2.1.28.2.1.1.14.5 ANTemplate.RecordCollection.addType8 Method (int, int, int, ANPenVector[])

Adds type-8 record to ANTemplate ( Java public ANType8Record addType8(int idc, int isr, int ir, ANPenVector[] penVectors); Parameters Parameters int idc int isr int ir ANPenVector[] penVectors Returns ANType8Record ( see page 414) object. Description Image designation character value. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Vectors containing image data. see page 286) object.
8.1.2.1.28.2.1.1.14.6 ANTemplate.RecordCollection.addType8 Method (int, int, int, ANPenVector[], int)

Adds type-8 record to ANTemplate ( Java public ANType8Record addType8(int idc, int isr, int ir, ANPenVector[] penVectors, int flags); Parameters Parameters int idc int isr int ir ANPenVector[] penVectors int flags Returns ANType8Record ( see page 414) object. Description Image designation character value. Image scanning resolution value. Units of this parameter is pixel points per millimeter. Native image resolution value. Vectors containing image data. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.15 addType9 Method 8.1.2.1.28.2.1.1.15.1 ANTemplate.RecordCollection.addType9 Method (int, BDIFFPImpressionType, boolean)

Adds type-9 record to ANTemplate ( Java public ANType9Record addType9(int idc, BDIFFPImpressionType imp, boolean rdg); Parameters Parameters int idc BDIFFPImpressionType imp boolean rdg Returns ANType9Record ( see page 425) object. Description Image designation character value. One of BDIFFPImpressionType values. Minutiae ridge count flag. see page 286) object.
313
8.1 Java Reference
8.1.2.1.28.2.1.1.15.2 ANTemplate.RecordCollection.addType9 Method (int, BDIFFPImpressionType, boolean, boolean, boolean, boolean)

Adds type-9 record to ANTemplate ( Java public ANType9Record addType9(int idc, BDIFFPImpressionType imp, boolean fmt, boolean hasMinutiae, boolean rdg, boolean hasMinutiaeRidgeCountsIndicator); Parameters Parameters int idc BDIFFPImpressionType imp boolean fmt boolean hasMinutiae boolean rdg boolean hasMinutiaeRidgeCountsIndicator Returns ANType9Record ( see page 425) object. Description Image designation character value. One of BDIFFPImpressionType values. Minutiae format flag value. Minutiae flag. Minutiae ridge count flag. Minutiae ridge counts indicator. see page 286) object.
8.1.2.1.28.2.1.1.15.3 ANTemplate.RecordCollection.addType9 Method (int, BDIFFPImpressionType, boolean, boolean, boolean, boolean, int)
Adds type-9 record to ANTemplate ( Java public ANType9Record addType9(int idc, BDIFFPImpressionType imp, boolean fmt, boolean hasMinutiae, boolean rdg, boolean hasMinutiaeRidgeCountsIndicator, int flags); Parameters Parameters int idc BDIFFPImpressionType imp boolean fmt boolean hasMinutiae boolean rdg boolean hasMinutiaeRidgeCountsIndicator int flags Returns ANType9Record ( see page 425) object. Description Image designation character value. One of BDIFFPImpressionType values. Minutiae format flag value. Minutiae flag. Minutiae ridge count flag. Minutiae ridge counts indicator. Must be zero. see page 286) object.
8.1.2.1.28.2.1.1.15.4 ANTemplate.RecordCollection.addType9 Method (int, BDIFFPImpressionType, boolean, int)

Adds type-9 record to ANTemplate ( Java public ANType9Record addType9(int idc, BDIFFPImpressionType imp, boolean rdg, int flags); Parameters Parameters int idc BDIFFPImpressionType imp boolean rdg Description Image designation character value. One of BDIFFPImpressionType values. Minutiae ridge count flag. 314 see page 286) object.
8.1 Java Reference int flags Returns ANType9Record ( see page 425) object.
Must be zero.
8.1.2.1.28.2.1.1.15.5 ANTemplate.RecordCollection.addType9 Method (int, boolean, NFRecord)

Adds type-9 record to ANTemplate ( Java public ANType9Record addType9(int idc, boolean fmt, NFRecord nfRecord); Parameters Parameters int idc boolean fmt NFRecord nfRecord Returns ANType9Record ( see page 425) object. Description Image designation character value. Minutiae format flag value. NFRecord ( see page 110) object. see page 286) object.
8.1.2.1.28.2.1.1.15.6 ANTemplate.RecordCollection.addType9 Method (int, boolean, NFRecord, int)

Adds type-9 record to ANTemplate ( Java public ANType9Record addType9(int idc, boolean fmt, NFRecord nfRecord, int flags); Parameters Parameters int idc boolean fmt NFRecord nfRecord int flags Returns ANType9Record ( see page 425) object. Description Image designation character value. Minutiae format flag value. NFRecord ( Must be zero. see page 110) object. see page 286) object.
8.1.2.1.28.2.1.1.16 addType99 Method 8.1.2.1.28.2.1.1.16.1 ANTemplate.RecordCollection.addType99 Method (int, String, NVersion, EnumSet<ANBiometricType>, short, short, ByteBuffer)
Adds type-99 record to ANTemplate ( Java public ANType99Record addType99(int idc, String src, NVersion hdv, EnumSet<ANBiometricType> bty, short bfo, short bft, ByteBuffer bdb); Parameters Parameters int idc String src NVersion hdv EnumSet<ANBiometricType> bty short bfo Description Image designation character value. String which contains identification of organization. One of ANVersion values. One of ANBiometricType values. Biometric format owner id value. 315 see page 286) object.
8.1 Java Reference short bft ByteBuffer bdb Returns ANType99Record (
Biometric format type value. Buffer containing image data.
8.1.2.1.28.2.1.1.16.2 ANTemplate.RecordCollection.addType99 Method (int, String, NVersion, EnumSet<ANBiometricType>, short, short, ByteBuffer, int)
Adds type-99 record to ANTemplate ( Java public ANType99Record addType99(int idc, String src, NVersion hdv, EnumSet<ANBiometricType> bty, short bfo, short bft, ByteBuffer bdb, int flags); Parameters Parameters int idc String src NVersion hdv EnumSet<ANBiometricType> bty short bfo short bft ByteBuffer bdb int flags Returns ANType99Record ( see page 420) object Description Image designation character value. String which contains identification of organization. One of ANVersion values. One of ANBiometricType values. Biometric format owner id value. Biometric format type value. Buffer containing image data. Must be zero. see page 286) object.
8.1.2.1.28.3 ANTemplate Fields

8.1.2.1.28.3.1 ANTemplate.FLAG_LEAVE_INVALID_RECORDS_UNVALIDATED Field
Leaves invalid records unvalidated. Java public static final int FLAG_LEAVE_INVALID_RECORDS_UNVALIDATED = 0x00020000;
8.1.2.1.28.3.2 ANTemplate.FLAG_USE_NIST_MINUTIA_NEIGHBORS Field

Uses NIST minutia neighbors data. Java public static final int FLAG_USE_NIST_MINUTIA_NEIGHBORS = 0x00010000;
8.1.2.1.28.3.3 ANTemplate.VERSION_20 Field

This ANTemplate ( see page 286) version implemets "Data Format for the Interchange of Fingerprint Information" standard (ANSI/NIST-CSL 1-1993) format. Java public static final NVersion VERSION_20 = new NVersion((short) 0x0200);

This ANTemplate ( see page 286) version implemets "Data Format for the Interchange of Fingerprint Information" standard (ANSI/NIST-ITL 1a-1997) format.
316
public static final NVersion VERSION_21 = new NVersion((short) 0x0201);

This ANTemplate ( see page 286) version implemets "Data Format for the Interchange of Fingerprint, Facial, & Scar Mark & Tattoo (SMT) Information that carried the ANSI designation of ANSI/NIST-ITL 1-2000. Java public static final NVersion VERSION_30 = new NVersion((short) 0x0300);

This ANTemplate ( see page 286) version implemets current version of the standard that carried the ANSI designation of (ANSI/NIST-ITL 1-2007). Java public static final NVersion VERSION_40 = new NVersion((short) 0x0400);
8.1.2.1.28.3.7 ANTemplate.VERSION_CURRENT Field

Defines the current version of standard that ANTemplate ( Java public static final NVersion VERSION_CURRENT = VERSION_40; see page 286) library implements.
8.1.2.1.28.4 ANTemplate Methods

8.1.2.1.28.4.1 ANTemplate.getRecords Method
Gets particular records from the ANTemplate ( Java public RecordCollection getRecords(); Returns A RecordCollection ( see page 290) representing records in ANTemplate ( see page 286). see page 286).
8.1.2.1.28.4.2 ANTemplate.getValidationLevel Method

Gets validation level of ANTemplate ( Java public ANValidationLevel getValidationLevel(); Returns One of ANValidationLevel values. see page 286).
8.1.2.1.28.4.3 ANTemplate.getVersion Method

Gets NVersion object representing standard version. Java public NVersion getVersion(); Returns NVersion object.
8.1.2.1.28.4.4 ANTemplate.getVersionName Method

Gets standard version name to which template loaded to memory conforms. 317
public static String getVersionName(NVersion version); Parameters Parameters NVersion version Returns Standard version name. Description Version of standard.
8.1.2.1.28.4.5 ANTemplate.getVersions Method

Gets versions of standard to which template loaded to memory conforms. Java public static NVersion getVersions(); Returns Array of NVersion objects.
8.1.2.1.28.4.6 ANTemplate.isVersionSupported Method

Checks if provided standard version is supported by ANTemplate ( Java public static boolean isVersionSupported(NVersion version); Parameters Parameters NVersion version Returns true if standard version is supported otherwise false . Description Version of standard. see page 286) library.
8.1.2.1.28.4.7 ANTemplate.nativeTypeOf Method

8.1.2.1.28.4.8 save Method 8.1.2.1.28.4.8.1 ANTemplate.save Method (String)

Saves the ANTemplate ( Java public void save(String fileName) throws IOException; see page 286) to the specified file.
318
8.1 Java Reference Parameters Parameters String fileName
Description String which contains file name where {@link ANTemplate ( see page 286)} will be saved.
8.1.2.1.28.4.8.2 ANTemplate.save Method (String, int)

Saves the ANTemplate ( Java public void save(String fileName, int flags) throws IOException; Parameters Parameters String fileName int flags Description String which contains file name where {@link ANTemplate ( see page 286)} will be saved. Must be zero. see page 286) to the specified file.
8.1.2.1.28.4.9 ANTemplate.setVersion Method

Sets NVersion object representing standard version. Java public void setVersion(NVersion value); Parameters Parameters NVersion value Description NVersion object.
8.1.2.1.28.4.10 toNTemplate Method 8.1.2.1.28.4.10.1 ANTemplate.toNTemplate Method ()

Converts ANTemplate ( Java public NTemplate toNTemplate(); Returns NTemplate ( see page 210) object. see page 286) to Neurotechnology Template (NTemplate ( see page 210)).
8.1.2.1.28.4.10.2 ANTemplate.toNTemplate Method (int)

Converts ANTemplate ( Java public NTemplate toNTemplate(int flags); Parameters Parameters int flags Returns NTemplate ( see page 210) object. Description Must be zero. see page 286) to Neurotechnology Template (NTemplate ( see page 210)).
319
8.1 Java Reference
8.1.2.1.29 ANType10Record Class

Provides functions for working with Type-10 Facial & SMT image record. Java public final class ANType10Record extends ANImageASCIIBinaryRecord; File ANType10Record.java Remarks Type-10 tagged-field image records are used to exchange facial and image data from scars, marks, and tattoos (SMT) together with textual information pertinent to the digitized image. The source of the image data is the image captured from scanning a photograph, a live image captured with a digital camera, or a digitized "freeze-frame" from a video camera. ANRecord Classes Name FieldCollection ( ANType10Record Class Name FacialFeaturePointCollection ( page 327) see Description Represent collection of facial feature points. Represent collection NCIC designation codes. Represent collection of other photo characteristics. see page 271) Description Represent collection of subfields in field.
NCICDesignationCodeCollection ( see page 327) OtherPhotoCharacteristicCollection ( see page 328)
PhysicalPhotoCharacteristicCollection Represent collection of physical photo characteristics. ( see page 328) SMTCollection ( see page 328) see page Represent collection of smt. Represent collection of smt colors. Represent collection of subject facial characteristics. SMTColorsCollection ( 329)
SubjectFacialCharacteristicCollection ( see page 329) SubjectQualityScoreCollection ( page 329) ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272)
see Represent collection of subject quality scores.
Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged.
FIELD_LEN (
see page 273)
320
8.1 Java Reference ANASCIIBinaryRecord Class Name FIELD_DAT ( FIELD_SRC (
Description see page 218) see page 218) Defines DAT field number. Field referenced by this number contains the date that the transaction was initiated. Defines SRC field number. Field referenced by this number contains the administration or organization that originally captured the latent image contained in the record. Normally, the Originating Agency Identifier, ORI, of the agency that captured the image. Specifies starting number from which user defined field starts. Defines end number of user defined field starts. see page Defines maximal quality score value for record data. see Defines maximal value length of field referenced by FieldSrc field number. see Defines maximal value length of field referenced by FieldSrc field number in current implementation of ANSI-NIST standard in ANTemplate ( see page 286). Defines minimal value length of field referenced by FieldSrc field number. Defines code when quality assessment algorithm failed to asses record data quality.
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANImageASCIIBinaryRecord Class Name FIELD_BPX ( see page 254) Description Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data. Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record 321
FIELD_CGA (
see page 254)
FIELD_COM (
see page 254)
FIELD_CSP (
see page 255)
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
8.1 Java Reference FIELD_SHPS (
see page 255)
Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image.
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
see page 256)
Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
see page 256)
see page
see page 257)
see page Defines minimal scanned pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal scanned pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal scanned pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286).
see page
see
322
8.1 Java Reference
see
Defines minimal scanned pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per centimeter. Defines minimal pixel scale value per inch. Defines minimal scanned pixel scale value per centimeter. Defines minimal scanned pixel scale value per inch. Defines minimal length of vendor compression algorithm description.
see page 257)
see page 258)
MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH ( see page 258) ANType10Record Class Name FIELD_COL ( FIELD_CSP ( see page 330) see page 330)
Description Defines COL field number. Field referenced by this number contains Color value. Defines CSP field number. Field referenced by this number contains color space (CSP) value used to identify the color space used to exchange the image data. Defines FFP field number. Field referenced by this number contains facial feature points (FFP) used to exchange of facial image data. Defines IMT field number. Field referenced by this number contains Image type (IMT) which is used to indicate the type of image contained in this record. Defines PAS field number. Field referenced by this number contains photo acquisition source (PAS) value which specifies the classification of the source of the image contained in record. Defines PHD field number. Field referenced by this number contains photo date (PHD) value which contains the date that the facial or SMT image contained in the record was captured. Defines POA field number. Field referenced by this number contains pose offset angle. Defines POS field number. Field referenced by this number contains subject pose (POS) value. Defines PXS field number. Field referenced by this number contains photo description (PXS) that describes special attributes of the captured facial image. Defines SAP field number. Field referenced by this number contains subject acquisition profile (SAP). Intent of this field is to provide a general description of the criteria under which the facial image was captured. Defines SEC field number. Field referenced by this number contains subject eye color (SEC) value. Defines SHC field number. Field referenced by this number contains subject hair color value. Defines SMD field number. Field referenced by this number contains SMT descriptors (SMD) which is used to describe the content of the SMT image. 323
FIELD_FFP (
see page 330)
FIELD_IMT (
see page 330)
FIELD_PAS (
see page 330)
FIELD_PHD (
see page 330)
FIELD_POA ( FIELD_POS ( FIELD_PXS (
FIELD_SAP (
see page 331)
FIELD_SEC (
see page 331)
FIELD_SHC ( FIELD_SMD (
8.1 Java Reference FIELD_SMS (
see page 331)
Defines SMS field number. Field referenced by this number contains SMT size ( see page 275) (SMS) value which contains the dimensions of the scar, mark or tattoo. Defines SMT field number. Field referenced by this number contains NCIC designation code (SMT) which is used to identify a general location of the captured scar, mark, tattoo, or other characteristic (including piercings) in image. Defines SPA field number. Field referenced by this number contains subject pose angles. Defines SQS field number. Field referenced by this number contains subject quality score (SQS) which specifies quality score data for facial images stored in this record. Defines SXS field number. Field referenced by this number contains subject facial description (SXS) which describes the facial expression of the subject and other attributes associated with the subject's captured facial image. see page 332) see page see page Defines maximum number of facial features count. Defines maximum NCIC designation code (SMT) count value. Defines maximum NCIC designation code (SMT) length.
FIELD_SMT (
see page 331)
FIELD_SPA ( FIELD_SQS (
FIELD_SXS (
see page 332)
MAX_FACIAL_FEATURE_POINT_COUNT ( MAX_NCIC_DESIGNATION_CODE_COUNT ( 332)
MAX_NCIC_DESIGNATION_CODE_LENGTH ( 332)
MAX_OTHER_PHOTO_CHARACTERISTIC_LENGTH ( page 332) MAX_PHOTO_DESCRIPTION_COUNT ( see page 332)
see Defines other maximum physical photo characteristic length. Defines maximum number of photo description attributes. Defines maximum physical photo characteristic length. Defines maximum number of quality metric. Maximum number of the NCIC designation codes (SMT). Maximum size ( see page 275) of the field referenced by field number FieldSmt. Maximum subject facial characteristic length. Maximum subject facial description count.
MAX_PHYSICAL_PHOTO_CHARACTERISTIC_LENGTH ( see page 332) MAX_QUALITY_METRIC_COUNT ( MAX_SMT_COUNT ( MAX_SMT_SIZE ( see page 332) see page 332)
see page 333)
MAX_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH ( see page 333) MAX_SUBJECT_FACIAL_DESCRIPTION_COUNT ( page 333) see
MAX_VENDOR_PHOTO_ACQUISITION_SOURCE_LENGTH Defines maximum photo acquisition source ( see page 333) value. MIN_NCIC_DESIGNATION_CODE_LENGTH ( 333) see page Defines minimum NCIC designation code (SMT) count value. Defines minimum subject facial characteristic length. Defines ANSI full frontal facial image for the Subject Acquisition Profile (SAP). Defines ANSI token facial image for the Subject Acquisition Profile (SAP). Defines Best Practice Application - Level 30 value for the Subject Acquisition Profile (SAP). Defines Best Practice Application - Level 40 value for the Subject Acquisition Profile (SAP).
MIN_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH ( see page 333) SAP_ANSI_FULL_FRONTAL_FACIAL_IMAGE ( 333) SAP_ANSI_TOKEN_FACIAL_IMAGE ( SAP_BPA_LEVEL_30 ( SAP_BPA_LEVEL_40 ( see page 333) see page 333) see page
see page 333)
324
8.1 Java Reference SAP_BPA_LEVEL_50 ( SAP_BPA_LEVEL_51 (
Defines Best Practice Application - Level 50 value for the Subject Acquisition Profile (SAP). Defines Best Practice Application - Level 51 value for the Subject Acquisition Profile (SAP). Defines driver's license image for the Subject Acquisition Profile (SAP). Defines ISO full frontal face image. Defines ISO token face image. Defines legacy mugshot value for the Subject Acquisition Profile (SAP). Defines PIV facial image (NIST SP 800-76) for the Subject Acquisition Profile (SAP). Defines Surveillance facial image for the Subject Acquisition Profile (SAP). Defines that the Subject Acquisition Profile (SAP) is unknown.
SAP_DRIVERS_LICENSE_IMAGE (
SAP_ISO_FULL_FRONTAL_FACIAL_IMAGE ( 334) SAP_ISO_TOKEN_FACIAL_IMAGE ( SAP_LEGACY_MUGSHOT ( SAP_PIV_FACIAL_IMAGE ( see page 334) see page 334)
see page 334)
SAP_SURVEILLANCE_FACIAL_IMAGE ( SAP_UNKNOWN ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) see page 334)
see page 334)
see page 275)
see page 220)
setSourceAgency (
getCompressionAlgorithm ( page 258) getDeviceMonitoringMode ( page 259) getHorzLineLength ( 259) getHorzPixelScale (
see page
see page 259) Gets horizontal pixel scale of image. 325
8.1 Java Reference getScaleUnits (
see page 259) see
Gets scale units value. Gets scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression.
setDeviceMonitoringMode ( page 260) setScanHorzPixelScale ( page 261) setScanVertPixelScale ( 261) toNImage ( ANType10Record Class Name getBaldSubjectHairColor ( 335) getFacialFeaturePoints ( 335) getImageType (
see
see page 261)
Description see page see page Gets bald subject's hair color. Gets particular facial feature points from the ANType10Record. Gets subject's image type. Gets particular ncic designation codes from the ANType10Record. Gets particular other photo characteristics from the ANType10Record. Gets photo acquisition source. Gets photo attributes. Gets date when subjects photo has been obtained. Gets particular physical photo characteristics from the ANType10Record. Gets pose offset angle (POA). Gets particular smt designation codes from the ANType10Record. Gets particular smt color codes from the ANType10Record. Gets subject acquisition profile. Gets subject's eye color. Gets subject's facial attributes. see Gets particular subject facial characteristics from the ANType10Record. Gets subject's facial expression. Gets subject's hair color. see
getNCICDesignationCodes ( page 335)
getOtherPhotoCharacteristics ( page 335) getPhotoAcquisitionSource ( page 335) getPhotoAttributes ( getPhotoDate (
see
see page 336)
see page 336)
getPhysicalPhotoCharacteristics ( see page 336) getPoseOffsetAngle ( getSMTs ( see page 336)
getSMTsColors (
getSubjectAcquisitionProfile ( page 337) getSubjectEyeColor (
see page 337) see
getSubjectFacialAttributes ( page 337)
getSubjectFacialCharacteristics ( page 337) getSubjectFacialExpression ( page 337) getSubjectHairColor ( see
see page 337)
326
8.1 Java Reference getSubjectHairColorEx ( 338) getSubjectPose ( getSubjectPoseAngles ( 338)
see page
Gets subject's hair color value. Gets subject's pose value. Gets subject's pose angle values from ANType10Record object. Gets pose pitch angle in degrees.
see page 338) see page see
getSubjectPoseAnglesPitch ( page 338)
getSubjectPoseAnglesPitchUncertainty Gets uncertainty degrees of pitch of subject's pose. ( see page 338) getSubjectPoseAnglesRoll ( page 338) see Gets pose roll angle in degrees. Gets uncertainty degrees of roll of subject's pose. Gets pose yaw angle in degrees.
getSubjectPoseAnglesRollUncertainty ( see page 339) getSubjectPoseAnglesYaw ( page 339) see
getSubjectPoseAnglesYawUncertainty Gets uncertainty degrees of yaw of subject's pose. ( see page 339) getSubjectQualityScores ( 339) see page Gets particular subject quality score from the ANType10Record. Gets vendor's photo acquisition source. Retrieves a function that retrieves NType object for the enclosing type. Sets photo acquisition source value. Gets photo attributes. Sets date when subjects photo has been obtained. Gets pose offset angle (POA). Sets subject acquisition profile. Sets subject's eye color.
getVendorPhotoAcquisitionSource ( see page 339) nativeTypeOf ( see page 339) see setPhotoAcquisitionSource ( page 340) setPhotoAttributes ( setPhotoDate ( setPoseOffsetAngle (
see page 340)
setSubjectAcquisitionProfile ( page 340) setSubjectEyeColor ( setSubjectFacialAttributes ( 341) setSubjectFacialExpression ( page 341) setSubjectHairColor ( setSubjectPose (
see page 341)
see page Sets subject's facial attributes. see Sets subject's facial expression. Sets subject hair color value. Sets subject's pose value. Sets subject's pose angle values to ANType10Record object.
see page 342)
setSubjectPoseAngles ( 342)
8.1.2.1.29.1 ANType10Record Classes

8.1.2.1.29.1.1 ANType10Record.FacialFeaturePointCollection Class
Represent collection of facial feature points. Java public final class FacialFeaturePointCollection extends NStructureCollection<BDIFFaceFeaturePoint, BDIFFaceFeaturePointData>; File ANType10Record.java
8.1.2.1.29.1.2 ANType10Record.NCICDesignationCodeCollection Class

Represent collection NCIC designation codes.
327
public final class NCICDesignationCodeCollection extends StringCollection; File ANType10Record.java
8.1.2.1.29.1.3 ANType10Record.OtherPhotoCharacteristicCollection Class

Represent collection of other photo characteristics. Java public final class OtherPhotoCharacteristicCollection extends StringCollection; File ANType10Record.java
8.1.2.1.29.1.4 ANType10Record.PhysicalPhotoCharacteristicCollection Class

Represent collection of physical photo characteristics. Java public final class PhysicalPhotoCharacteristicCollection extends StringCollection; File ANType10Record.java
8.1.2.1.29.1.5 ANType10Record.SMTCollection Class

Represent collection of smt. Java public final class SMTCollection extends NStructureCollection<ANSMT, ANSMTData>; File ANType10Record.java SMTCollection Methods Name add ( see page 328) Description Adds smt to SmtCollection with provided parameters.
8.1.2.1.29.1.5.1 SMTCollection Methods 8.1.2.1.29.1.5.1.1 add Method 8.1.2.1.29.1.5.1.1.1 ANType10Record.SMTCollection.add Method (ANSMTSource, ANTattooClass, ANTattooSubclass, String)
Adds smt to SmtCollection with provided parameters. Java public boolean add(ANSMTSource source, ANTattooClass tattooClass, ANTattooSubclass tattooSubclass, String description); Parameters Parameters ANSMTSource source ANTattooClass tattooClass ANTattooSubclass tattooSubclass Description One of ANSMTSource values. One of ANSMTSource values. One of ANTattooSubclass values. 328
8.1 Java Reference String description Returns true if added successfully, false otherwise.
String containing smt description.
8.1.2.1.29.1.5.1.1.2 ANType10Record.SMTCollection.add Method (int, ANSMTSource, ANTattooClass, ANTattooSubclass, String)

Inserts smt to SmtCollection at specified index with provided parameters. Java public void add(int index, ANSMTSource source, ANTattooClass tattooClass, ANTattooSubclass tattooSubclass, String description); Parameters Parameters int index ANSMTSource source ANTattooClass tattooClass ANTattooSubclass tattooSubclass String description Description Position to insert to. One of ANSMTSource values. One of ANSMTSource values. One of ANTattooSubclass values. String containing smt description.
8.1.2.1.29.1.6 ANType10Record.SMTColorsCollection Class

Represent collection of smt colors. Java public final class SMTColorsCollection extends NEnumArrayCollection<ANColor, ANSMT>; File ANType10Record.java
8.1.2.1.29.1.7 ANType10Record.SubjectFacialCharacteristicCollection Class

Represent collection of subject facial characteristics. Java public final class SubjectFacialCharacteristicCollection extends StringCollection; File ANType10Record.java
8.1.2.1.29.1.8 ANType10Record.SubjectQualityScoreCollection Class

Represent collection of subject quality scores. Java public final class SubjectQualityScoreCollection extends NStructureCollection<ANQualityMetric, ANQualityMetricData>; File ANType10Record.java
8.1.2.1.29.2 ANType10Record Fields

329
8.1 Java Reference
8.1.2.1.29.2.1 ANType10Record.FIELD_COL Field

Defines COL field number. Field referenced by this number contains Color value. Java public static final int FIELD_COL = 43;
8.1.2.1.29.2.2 ANType10Record.FIELD_CSP Field

Defines CSP field number. Field referenced by this number contains color space (CSP) value used to identify the color space used to exchange the image data. Java public static final int FIELD_CSP = 12;
8.1.2.1.29.2.3 ANType10Record.FIELD_FFP Field

Defines FFP field number. Field referenced by this number contains facial feature points (FFP) used to exchange of facial image data. Java public static final int FIELD_FFP = 29;
8.1.2.1.29.2.4 ANType10Record.FIELD_IMT Field

Defines IMT field number. Field referenced by this number contains Image type (IMT) which is used to indicate the type of image contained in this record. Java public static final int FIELD_IMT = 3;
8.1.2.1.29.2.5 ANType10Record.FIELD_PAS Field

Defines PAS field number. Field referenced by this number contains photo acquisition source (PAS) value which specifies the classification of the source of the image contained in record. Java public static final int FIELD_PAS = 23;
8.1.2.1.29.2.6 ANType10Record.FIELD_PHD Field

Defines PHD field number. Field referenced by this number contains photo date (PHD) value which contains the date that the facial or SMT image contained in the record was captured. Java public static final int FIELD_PHD = FIELD_DAT;
8.1.2.1.29.2.7 ANType10Record.FIELD_POA Field

Defines POA field number. Field referenced by this number contains pose offset angle. Java public static final int FIELD_POA = 21;
8.1.2.1.29.2.8 ANType10Record.FIELD_POS Field

Defines POS field number. Field referenced by this number contains subject pose (POS) value. Java public static final int FIELD_POS = 20;
8.1.2.1.29.2.9 ANType10Record.FIELD_PXS Field

Defines PXS field number. Field referenced by this number contains photo description (PXS) that describes special 330
8.1 Java Reference attributes of the captured facial image. Java
public static final int FIELD_PXS = 22;
8.1.2.1.29.2.10 ANType10Record.FIELD_SAP Field

Defines SAP field number. Field referenced by this number contains subject acquisition profile (SAP). Intent of this field is to provide a general description of the criteria under which the facial image was captured. Java public static final int FIELD_SAP = 13;
8.1.2.1.29.2.11 ANType10Record.FIELD_SEC Field

Defines SEC field number. Field referenced by this number contains subject eye color (SEC) value. Java public static final int FIELD_SEC = 27;
8.1.2.1.29.2.12 ANType10Record.FIELD_SHC Field

Defines SHC field number. Field referenced by this number contains subject hair color value. Java public static final int FIELD_SHC = 28;
8.1.2.1.29.2.13 ANType10Record.FIELD_SMD Field

Defines SMD field number. Field referenced by this number contains SMT descriptors (SMD) which is used to describe the content of the SMT image. Java public static final int FIELD_SMD = 42;
8.1.2.1.29.2.14 ANType10Record.FIELD_SMS Field

Defines SMS field number. Field referenced by this number contains SMT size ( contains the dimensions of the scar, mark or tattoo. Java public static final int FIELD_SMS = 41; see page 275) (SMS) value which
8.1.2.1.29.2.15 ANType10Record.FIELD_SMT Field

Defines SMT field number. Field referenced by this number contains NCIC designation code (SMT) which is used to identify a general location of the captured scar, mark, tattoo, or other characteristic (including piercings) in image. Java public static final int FIELD_SMT = 40;
8.1.2.1.29.2.16 ANType10Record.FIELD_SPA Field

Defines SPA field number. Field referenced by this number contains subject pose angles. Java public static final int FIELD_SPA = 25;
8.1.2.1.29.2.17 ANType10Record.FIELD_SQS Field

Defines SQS field number. Field referenced by this number contains subject quality score (SQS) which specifies quality score data for facial images stored in this record. Java public static final int FIELD_SQS = FIELD_IQM; 331
8.1 Java Reference
8.1.2.1.29.2.18 ANType10Record.FIELD_SXS Field

Defines SXS field number. Field referenced by this number contains subject facial description (SXS) which describes the facial expression of the subject and other attributes associated with the subject's captured facial image. Java public static final int FIELD_SXS = 26;
8.1.2.1.29.2.19 ANType10Record.MAX_FACIAL_FEATURE_POINT_COUNT Field

Defines maximum number of facial features count. Java public static final int MAX_FACIAL_FEATURE_POINT_COUNT = 88;
8.1.2.1.29.2.20 ANType10Record.MAX_NCIC_DESIGNATION_CODE_COUNT Field

Defines maximum NCIC designation code (SMT) count value. Java public static final int MAX_NCIC_DESIGNATION_CODE_COUNT = 3;
8.1.2.1.29.2.21 ANType10Record.MAX_NCIC_DESIGNATION_CODE_LENGTH Field

Defines maximum NCIC designation code (SMT) length. Java public static final int MAX_NCIC_DESIGNATION_CODE_LENGTH = 10;
8.1.2.1.29.2.22 ANType10Record.MAX_OTHER_PHOTO_CHARACTERISTIC_LENGTH Field

Defines other maximum physical photo characteristic length. Java public static final int MAX_OTHER_PHOTO_CHARACTERISTIC_LENGTH = 14;
8.1.2.1.29.2.23 ANType10Record.MAX_PHOTO_DESCRIPTION_COUNT Field

Defines maximum number of photo description attributes. Java public static final int MAX_PHOTO_DESCRIPTION_COUNT = 9;
8.1.2.1.29.2.24 ANType10Record.MAX_PHYSICAL_PHOTO_CHARACTERISTIC_LENGTH Field

Defines maximum physical photo characteristic length. Java public static final int MAX_PHYSICAL_PHOTO_CHARACTERISTIC_LENGTH = 11;
8.1.2.1.29.2.25 ANType10Record.MAX_QUALITY_METRIC_COUNT Field

Defines maximum number of quality metric. Java public static final int MAX_QUALITY_METRIC_COUNT = 9;
8.1.2.1.29.2.26 ANType10Record.MAX_SMT_COUNT Field

Maximum number of the NCIC designation codes (SMT). Java public static final int MAX_SMT_COUNT = 9;
332
8.1 Java Reference
8.1.2.1.29.2.27 ANType10Record.MAX_SMT_SIZE Field

Maximum size ( Java public static final int MAX_SMT_SIZE = 99; see page 275) of the field referenced by field number FieldSmt.
8.1.2.1.29.2.28 ANType10Record.MAX_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH Field

Maximum subject facial characteristic length. Java public static final int MAX_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH = 20;
8.1.2.1.29.2.29 ANType10Record.MAX_SUBJECT_FACIAL_DESCRIPTION_COUNT Field

Maximum subject facial description count. Java public static final int MAX_SUBJECT_FACIAL_DESCRIPTION_COUNT = 50;
8.1.2.1.29.2.30 ANType10Record.MAX_VENDOR_PHOTO_ACQUISITION_SOURCE_LENGTH Field

Defines maximum photo acquisition source value. Java public static final int MAX_VENDOR_PHOTO_ACQUISITION_SOURCE_LENGTH = 7;
8.1.2.1.29.2.31 ANType10Record.MIN_NCIC_DESIGNATION_CODE_LENGTH Field

Defines minimum NCIC designation code (SMT) count value. Java public static final int MIN_NCIC_DESIGNATION_CODE_LENGTH = 3;
8.1.2.1.29.2.32 ANType10Record.MIN_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH Field

Defines minimum subject facial characteristic length. Java public static final int MIN_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH = 5;
8.1.2.1.29.2.33 ANType10Record.SAP_ANSI_FULL_FRONTAL_FACIAL_IMAGE Field

Defines ANSI full frontal facial image for the Subject Acquisition Profile (SAP). Java public static final int SAP_ANSI_FULL_FRONTAL_FACIAL_IMAGE = 11;
8.1.2.1.29.2.34 ANType10Record.SAP_ANSI_TOKEN_FACIAL_IMAGE Field

Defines ANSI token facial image for the Subject Acquisition Profile (SAP). Java public static final int SAP_ANSI_TOKEN_FACIAL_IMAGE = 12;
8.1.2.1.29.2.35 ANType10Record.SAP_BPA_LEVEL_30 Field

Defines Best Practice Application - Level 30 value for the Subject Acquisition Profile (SAP). Java public static final int SAP_BPA_LEVEL_30 = 30;

Defines Best Practice Application - Level 40 value for the Subject Acquisition Profile (SAP). 333
public static final int SAP_BPA_LEVEL_40 = 40;


8.1.2.1.29.2.39 ANType10Record.SAP_DRIVERS_LICENSE_IMAGE Field

Defines driver's license image for the Subject Acquisition Profile (SAP). Java public static final int SAP_DRIVERS_LICENSE_IMAGE = 10;
8.1.2.1.29.2.40 ANType10Record.SAP_ISO_FULL_FRONTAL_FACIAL_IMAGE Field

Defines ISO full frontal face image. Java public static final int SAP_ISO_FULL_FRONTAL_FACIAL_IMAGE = 13;
8.1.2.1.29.2.41 ANType10Record.SAP_ISO_TOKEN_FACIAL_IMAGE Field

Defines ISO token face image. Java public static final int SAP_ISO_TOKEN_FACIAL_IMAGE = 14;
8.1.2.1.29.2.42 ANType10Record.SAP_LEGACY_MUGSHOT Field

Defines legacy mugshot value for the Subject Acquisition Profile (SAP). Java public static final int SAP_LEGACY_MUGSHOT = 20;
8.1.2.1.29.2.43 ANType10Record.SAP_PIV_FACIAL_IMAGE Field

Defines PIV facial image (NIST SP 800-76) for the Subject Acquisition Profile (SAP). Java public static final int SAP_PIV_FACIAL_IMAGE = 15;
8.1.2.1.29.2.44 ANType10Record.SAP_SURVEILLANCE_FACIAL_IMAGE Field

Defines Surveillance facial image for the Subject Acquisition Profile (SAP). Java public static final int SAP_SURVEILLANCE_FACIAL_IMAGE = 1;
8.1.2.1.29.2.45 ANType10Record.SAP_UNKNOWN Field

Defines that the Subject Acquisition Profile (SAP) is unknown. Java public static final int SAP_UNKNOWN = 0; 334
8.1 Java Reference
8.1.2.1.29.3 ANType10Record Methods

8.1.2.1.29.3.1 ANType10Record.getBaldSubjectHairColor Method
Gets bald subject's hair color. Java public BDIFHairColor getBaldSubjectHairColor(); Returns One of BDIFHairColor values.
8.1.2.1.29.3.2 ANType10Record.getFacialFeaturePoints Method

Gets particular facial feature points from the ANType10Record ( Java public FacialFeaturePointCollection getFacialFeaturePoints(); Returns A FacialFeaturePointCollection ( see page 327) representing facial feature points from ANType10Record ( see page 320). see page 320).
8.1.2.1.29.3.3 ANType10Record.getImageType Method

Gets subject's image type. Java public ANImageType getImageType(); Returns One of ANImageType values.
8.1.2.1.29.3.4 ANType10Record.getNCICDesignationCodes Method

Gets particular ncic designation codes from the ANType10Record ( Java public NCICDesignationCodeCollection getNCICDesignationCodes(); Returns A NcicDesignationCodeCollection representing ncic designation codes from ANType10Record ( see page 320). see page 320).
8.1.2.1.29.3.5 ANType10Record.getOtherPhotoCharacteristics Method

Gets particular other photo characteristics from the ANType10Record ( Java public OtherPhotoCharacteristicCollection getOtherPhotoCharacteristics(); Returns A OtherPhotoCharacteristicCollection ( see page 320). see page 328) representing other photo characteristics from ANType10Record ( see page 320).
8.1.2.1.29.3.6 ANType10Record.getPhotoAcquisitionSource Method

Gets photo acquisition source. Java public BDIFImageSourceType getPhotoAcquisitionSource(); 335
8.1 Java Reference Returns One of BDIFImageSourceType values.
8.1.2.1.29.3.7 ANType10Record.getPhotoAttributes Method

Gets photo attributes. Java public EnumSet<BDIFFaceProperty> getPhotoAttributes(); Returns One of BDIFFaceProperties values.
8.1.2.1.29.3.8 ANType10Record.getPhotoDate Method

Gets date when subjects photo has been obtained. Java public Date getPhotoDate(); Returns Date object.
8.1.2.1.29.3.9 ANType10Record.getPhysicalPhotoCharacteristics Method

Gets particular physical photo characteristics from the ANType10Record ( Java public PhysicalPhotoCharacteristicCollection getPhysicalPhotoCharacteristics(); Returns A PhysicalPhotoCharacteristicCollection ANType10Record ( see page 320). ( see page 328) representing physical photo characteristics from see page 320).
8.1.2.1.29.3.10 ANType10Record.getPoseOffsetAngle Method

Gets pose offset angle (POA). Java public Integer getPoseOffsetAngle(); Returns Number containing pose offset angle.
8.1.2.1.29.3.11 ANType10Record.getSMTs Method

Gets particular smt designation codes from the ANType10Record ( Java public SMTCollection getSMTs(); Returns A SmtCollection representing smt designation codes from ANType10Record ( see page 320). see page 320).
8.1.2.1.29.3.12 ANType10Record.getSMTsColors Method

Gets particular smt color codes from the ANType10Record ( Java public SMTColorsCollection getSMTsColors(); 336 see page 320).
A SmtColorsCollection representing smt color codes from ANType10Record (
see page 320).
8.1.2.1.29.3.13 ANType10Record.getSubjectAcquisitionProfile Method

Gets subject acquisition profile. Java public int getSubjectAcquisitionProfile(); Returns Number containing criteria under which the facial image was captured.
8.1.2.1.29.3.14 ANType10Record.getSubjectEyeColor Method

Gets subject's eye color. Java public BDIFEyeColor getSubjectEyeColor(); Returns One of BDIFEyeColor values.
8.1.2.1.29.3.15 ANType10Record.getSubjectFacialAttributes Method

Gets subject's facial attributes. Java public EnumSet<BDIFFaceProperty> getSubjectFacialAttributes(); Returns One of BDIFFaceProperties values.
8.1.2.1.29.3.16 ANType10Record.getSubjectFacialCharacteristics Method

Gets particular subject facial characteristics from the ANType10Record ( Java public SubjectFacialCharacteristicCollection getSubjectFacialCharacteristics(); Returns A SubjectFacialCharacteristicCollection ( ( see page 320). see page 329) representing subject facial characteristics from ANType10Record see page 320).
8.1.2.1.29.3.17 ANType10Record.getSubjectFacialExpression Method

Gets subject's facial expression. Java public BDIFFaceExpression getSubjectFacialExpression(); Returns One of BDIFFaceExpression values.
8.1.2.1.29.3.18 ANType10Record.getSubjectHairColor Method

Gets subject's hair color. Java public BDIFHairColor getSubjectHairColor(); 337
8.1 Java Reference Returns One of BDIFHairColor values.
8.1.2.1.29.3.19 ANType10Record.getSubjectHairColorEx Method

Gets subject's hair color value. Java public ANHairColor getSubjectHairColorEx(); Returns ANHairColor object.
8.1.2.1.29.3.20 ANType10Record.getSubjectPose Method

Gets subject's pose value. Java public ANSubjectPose getSubjectPose(); Returns One of ANSubjectPose values.
8.1.2.1.29.3.21 ANType10Record.getSubjectPoseAngles Method

Gets subject's pose angle values from ANType10Record ( Java public ANPoseAngles getSubjectPoseAngles(); Returns ANPoseAngles object. see page 320) object.
8.1.2.1.29.3.22 ANType10Record.getSubjectPoseAnglesPitch Method

Gets pose pitch angle in degrees. Java public int getSubjectPoseAnglesPitch(); Returns Pose pitch angle in degrees.
8.1.2.1.29.3.23 ANType10Record.getSubjectPoseAnglesPitchUncertainty Method

Gets uncertainty degrees of pitch of subject's pose. Java public int getSubjectPoseAnglesPitchUncertainty(); Returns Number representing uncertainty degrees of pitch.
8.1.2.1.29.3.24 ANType10Record.getSubjectPoseAnglesRoll Method

Gets pose roll angle in degrees. Java public int getSubjectPoseAnglesRoll();
338
8.1 Java Reference Returns Pose roll angle in degrees.
8.1.2.1.29.3.25 ANType10Record.getSubjectPoseAnglesRollUncertainty Method

Gets uncertainty degrees of roll of subject's pose. Java public int getSubjectPoseAnglesRollUncertainty(); Returns Number representing uncertainty degrees of roll.
8.1.2.1.29.3.26 ANType10Record.getSubjectPoseAnglesYaw Method

Gets pose yaw angle in degrees. Java public int getSubjectPoseAnglesYaw(); Returns Pose yaw angle in degrees.
8.1.2.1.29.3.27 ANType10Record.getSubjectPoseAnglesYawUncertainty Method

Gets uncertainty degrees of yaw of subject's pose. Java public int getSubjectPoseAnglesYawUncertainty(); Returns Number representing uncertainty degrees of yaw.
8.1.2.1.29.3.28 ANType10Record.getSubjectQualityScores Method

Gets particular subject quality score from the ANType10Record ( Java public SubjectQualityScoreCollection getSubjectQualityScores(); Returns A SubjectQualityScoreCollection ( 320). see page 329) representing subject quality score from ANType10Record ( see page see page 320).
8.1.2.1.29.3.29 ANType10Record.getVendorPhotoAcquisitionSource Method

Gets vendor's photo acquisition source. Java public String getVendorPhotoAcquisitionSource(); Returns String containing vendors photo acquisition source description.
8.1.2.1.29.3.30 ANType10Record.nativeTypeOf Method

Retrieves a function that retrieves NType object for the enclosing type. Java public static NType nativeTypeOf(); 339
The function that retrieves NType object for the enclosing type.
8.1.2.1.29.3.31 ANType10Record.setPhotoAcquisitionSource Method

Sets photo acquisition source value. Java public void setPhotoAcquisitionSource(BDIFImageSourceType value, String vendorValue); Parameters Parameters BDIFImageSourceType value String vendorValue Description One of BDIFImageSourceType values. String containing vendor description.
8.1.2.1.29.3.32 ANType10Record.setPhotoAttributes Method

Gets photo attributes. Java public void setPhotoAttributes(EnumSet<BDIFFaceProperty> value); Parameters Parameters EnumSet<BDIFFaceProperty> value Description One of BDIFFaceProperties values.
8.1.2.1.29.3.33 ANType10Record.setPhotoDate Method

Sets date when subjects photo has been obtained. Java public void setPhotoDate(Date value); Parameters Parameters Date value Description Date value.
8.1.2.1.29.3.34 ANType10Record.setPoseOffsetAngle Method

Gets pose offset angle (POA). Java public void setPoseOffsetAngle(Integer value); Parameters Parameters Integer value Description Number containing pose offset angle.
8.1.2.1.29.3.35 ANType10Record.setSubjectAcquisitionProfile Method

Sets subject acquisition profile. Java public void setSubjectAcquisitionProfile(int value); Parameters Parameters int value Description Number containing criteria under which the facial image was captured. 340
8.1 Java Reference
8.1.2.1.29.3.36 ANType10Record.setSubjectEyeColor Method

Sets subject's eye color. Java public void setSubjectEyeColor(BDIFEyeColor value); Parameters Parameters BDIFEyeColor value Description One of BDIFEyeColor values.
8.1.2.1.29.3.37 ANType10Record.setSubjectFacialAttributes Method

Sets subject's facial attributes. Java public void setSubjectFacialAttributes(EnumSet<BDIFFaceProperty> value); Parameters Parameters EnumSet<BDIFFaceProperty> value Description One of BDIFFaceProperties values.
8.1.2.1.29.3.38 ANType10Record.setSubjectFacialExpression Method

Sets subject's facial expression. Java public void setSubjectFacialExpression(BDIFFaceExpression value); Parameters Parameters BDIFFaceExpression value Description One of BDIFFaceExpression values.
8.1.2.1.29.3.39 setSubjectHairColor Method 8.1.2.1.29.3.39.1 ANType10Record.setSubjectHairColor Method (ANHairColor)

Sets subject hair color value. Java public void setSubjectHairColor(ANHairColor value); Parameters Parameters ANHairColor value Description ANHairColor object.
8.1.2.1.29.3.39.2 ANType10Record.setSubjectHairColor Method (BDIFHairColor, BDIFHairColor)

Sets subject hair color value. Java public void setSubjectHairColor(BDIFHairColor value, BDIFHairColor baldValue); Parameters Parameters BDIFHairColor value BDIFHairColor baldValue Description One of BDIFHairColor values. One of BDIFHairColor values.
341
8.1 Java Reference
8.1.2.1.29.3.40 ANType10Record.setSubjectPose Method

Sets subject's pose value. Java public void setSubjectPose(ANSubjectPose value); Parameters Parameters ANSubjectPose value Description One of ANSubjectPose values.
8.1.2.1.29.3.41 setSubjectPoseAngles Method 8.1.2.1.29.3.41.1 ANType10Record.setSubjectPoseAngles Method (ANPoseAngles)

Sets subject's pose angle values to ANType10Record ( Java public void setSubjectPoseAngles(ANPoseAngles value); Parameters Parameters ANPoseAngles value Description ANPoseAngles object. see page 320) object.
8.1.2.1.29.3.41.2 ANType10Record.setSubjectPoseAngles Method (int, int, int, int, int, int)

Sets subject's pose angle values to ANType10Record ( Java public void setSubjectPoseAngles(int yaw, int pitch, int roll, int yawUncertainty, int pitchUncertainty, int rollUncertainty); Parameters Parameters int yaw int pitch int roll int yawUncertainty int pitchUncertainty int rollUncertainty Description Pose yaw angle value in degrees. Pose pitch angle in degrees. Pose roll angle in degrees. Pose uncertainty degrees of yaw. Pose uncertainty degrees of pitch. Pose uncertainty degrees of roll. see page 320) object.

Provides functions for working with Variable-resolution latent image record. Java public final class ANType13Record extends ANFPImageASCIIBinaryRecord; File ANType13Record.java ANRecord Classes Name FieldCollection ( see page 271) Description Represent collection of subfields in field.
342
8.1 Java Reference ANFPImageASCIIBinaryRecord Class Name PositionCollection ( PrintPositionCollection ( 238) QualityMetricCollection ( page 238) ANType13Record Class Name
Description see page 238) Represent collection of fingerprint positions. see page Represent collection of print positions. see Represent collection of fingerprint quality metrics.
Description
SearchPositionDescriptorCollection Represent collection of search position descriptors. ( see page 347) ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged.
FIELD_LEN (
see page 273)
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object.
343
8.1 Java Reference ANImageASCIIBinaryRecord Class Name FIELD_BPX (
Description see page 254) Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data. Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
FIELD_CGA (
see page 254)
FIELD_COM (
see page 254)
FIELD_CSP (
see page 255)
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
344
8.1 Java Reference
see page 256)
see page
see page 257)
see page
see
see
see page 257)
see page 258)
MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH ( see page 258) ANFPImageASCIIBinaryRecord Class Name FIELD_FGP ( FIELD_IMP ( FIELD_PD ( FIELD_PPC ( see page 239) see page 239) see page 239) see page 239) Description
Defines FGP field number. Field referenced by this number contains one or more possible finger or palm positions that may match the latent image. Defines IMP field number. Field referenced by this number indicates the manner by which the latent image information was obtained. Defines PD field number. Field referenced by this number is used to narrow the search of the latent image in this record against a database. Defined PPC field number. Field referenced by this number contains offsets to the locations for the bounding box of the EJI, each of the full finger views, or segments within the EJI. Defines maximum number of finger or palm position (FGP) in one record. Defines maximum number of Print Position Coordinates (PPC).
see
MAX_PRINT_POSITION_COUNT ( see page 239)
345
8.1 Java Reference ANType13Record Class Name FIELD_LCD (
Description see page 348) Defines LCD field number. Field referenced by this number contains the date that the latent image contained in the record was captured. Defines LQM field number. Field referenced by this number contains latent quality metric (LQM) - one or more different metrics of latent image quality score data for the image stored in this record. Defines SPD field number. Field referenced by this number contains search position descriptors (SPD). see page 348) Defines maximum number of quality metrics.
FIELD_LQM (
see page 348)
FIELD_SPD (
see page 348)
MAX_QUALITY_METRIC_COUNT (
MAX_SEARCH_POSITION_DESCRIPTOR_COUNT Defines maximum number of quality metrics. ( see page 348) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
see page 220)
setSourceAgency (
see page
see page 259) Gets horizontal pixel scale of image. Gets scale units value.
see page 259)
346
8.1 Java Reference getScanHorzPixelScale ( page 259) getScanVertPixelScale ( 259)
see
Gets scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression.
see
see page 261)
ANFPImageASCIIBinaryRecord Class Name getImpressionType ( 239) getPositions ( getPrintPositions ( getQualityMetrics ( nativeTypeOf ( setImpressionType ( 240) ANType13Record Class Name getLatentCaptureDate ( 348) see page Description Gets date when latent image has been captured. Gets particular search position description from ANType13Record. Retrieves a function that retrieves NType object for the enclosing type. Sets date when latent image has been captured. see page Description Gets the fingerprint impression type. Gets fingerprint positions contained in record. Gets fingerprint print positions contained in record. Retrieves a function that retrieves NType object for the enclosing type. Sets the fingerprint impression type.
see page 240)
getSearchPositionDescriptors ( see page 348) nativeTypeOf ( see page 349) see page setLatentCaptureDate ( 349)

8.1.2.1.30.1.1 ANType13Record.SearchPositionDescriptorCollection Class
Represent collection of search position descriptors. Java public final class SearchPositionDescriptorCollection extends NStructureCollection<ANFPositionDescriptor, ANFPositionDescriptorData>; File ANType13Record.java
8 8.1.2.1.30.2 ANType13Record Fields

347
8.1 Java Reference
8.1.2.1.30.2.1 ANType13Record.FIELD_LCD Field

Defines LCD field number. Field referenced by this number contains the date that the latent image contained in the record was captured. Java public static final int FIELD_LCD = FIELD_DAT;
8.1.2.1.30.2.2 ANType13Record.FIELD_LQM Field

Defines LQM field number. Field referenced by this number contains latent quality metric (LQM) - one or more different metrics of latent image quality score data for the image stored in this record. Java public static final int FIELD_LQM = FIELD_IQM;
8.1.2.1.30.2.3 ANType13Record.FIELD_SPD Field

Defines SPD field number. Field referenced by this number contains search position descriptors (SPD). Java public static final int FIELD_SPD = FIELD_PD;

Defines maximum number of quality metrics. Java public static final int MAX_QUALITY_METRIC_COUNT = 4;
8.1.2.1.30.2.5 ANType13Record.MAX_SEARCH_POSITION_DESCRIPTOR_COUNT Field

Defines maximum number of quality metrics. Java public static final int MAX_SEARCH_POSITION_DESCRIPTOR_COUNT = 9;

8.1.2.1.30.3.1 ANType13Record.getLatentCaptureDate Method
Gets date when latent image has been captured. Java public Date getLatentCaptureDate(); Returns Date object.
8.1.2.1.30.3.2 ANType13Record.getSearchPositionDescriptors Method

Gets particular search position description from ANType13Record ( Java public SearchPositionDescriptorCollection getSearchPositionDescriptors(); Returns A SearchPositionDescriptorCollection ( see page 342). see page 347) representing search position descriptions in ANType13Record ( see page 342).
348
8.1 Java Reference

8.1.2.1.30.3.4 ANType13Record.setLatentCaptureDate Method

Sets date when latent image has been captured. Java public void setLatentCaptureDate(Date value); Parameters Parameters Date value Description Date value.

Provides functions for working with Variable-resolution fingerprint image record. Java public final class ANType14Record extends ANFPImageASCIIBinaryRecord; File ANType14Record.java ANRecord Classes Name FieldCollection ( see page 271) Description Represent collection of subfields in field.
ANFPImageASCIIBinaryRecord Class Name PositionCollection ( PrintPositionCollection ( 238) QualityMetricCollection ( page 238) ANType14Record Class Name AlternateSegmentCollection ( page 355) see Description Represent collection of alternate segments. Represent collection of alternate segment vertices. Represent collection of amputations. Represent collection of NIST quality metrics. Description see page 238) Represent collection of fingerprint positions. see page Represent collection of print positions. see Represent collection of fingerprint quality metrics.
AlternateSegmentVerticesCollection ( see page 355) AmputationCollection ( 355) see page see
NISTQualityMetricCollection ( page 356)
SegmentationQualityMetricCollection Represent collection of segmentation quality metrics. ( see page 356) SegmentCollection ( see page 356) Represent collection of segments.
349
FIELD_LEN (
see page 273)
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANImageASCIIBinaryRecord Class Name FIELD_BPX ( see page 254) Description Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data.
FIELD_CGA (
see page 254)
FIELD_COM (
see page 254)
350
8.1 Java Reference FIELD_CSP (
see page 255)
Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
MAX_VENDOR_COMPRESSION_ALGORITHM_LENGTH Defines maximal length of vendor compression ( see page 256) algorithm description. MIN_LATENT_PIXEL_SCALE_PPCM ( see page 256) Defines minimal pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). 351
see page 256)
see page
8.1 Java Reference
see page 257)
Defines minimal pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286).
see page
see
see
see page 257)
see page 258)
see
MAX_PRINT_POSITION_COUNT ( see page 239) ANType14Record Class Name FIELD_AMP ( see page 356)
Description Defines AMP field number. Field referenced by this number specifies if one or more fingers are amputated or bandaged (AMP). Defines ASEG field number. Field referenced by this number specifies alternate finger segment position(s) (ASEG). Defines FCD field number. Field referenced by this number contains fingerprint capture date (FCD), the date that the fingerprint image contained in the record was captured.
FIELD_ASEG (
see page 356)
FIELD_FCD (
see page 356)
352
8.1 Java Reference FIELD_FQM (
see page 356)
Defines FQM field number. Field referenced by this number contains one or more different metrics of fingerprint image quality score data for the image stored in this record. Defines NQM field number. Field referenced by this number contains the NIST Fingerprint Image Quality (NFIQ) scores for the individual finger(s) derived from the slap impressions or individual rolled fingerprints. Defines PPD field number. Field referenced by this number contains Print Position Descriptors (PPD). Defines SEG field number. Field referenced by this number specifies alternate approach to describing the locations for each of the image segments of the individual fingers within a flat image. Defines SQM field number. Field referenced by this number contains a measure of estimated correctness regarding the accuracy of the location of the segmented finger within the right or left four finger or two thumbs slap image. see page Defines maximum number of alternate segments. Defines maximum alternative segment finger describing polygon vertex count. Defines maximum finger amputation count.
FIELD_NQM (
see page 357)
FIELD_PPD ( FIELD_SEG (
FIELD_SQM (
see page 357)
MAX_ALTERNATE_SEGMENT_COUNT ( 357)
MAX_ALTERNATE_SEGMENT_VERTEX_COUNT ( see page 357) MAX_AMPUTATION_COUNT ( see page 357) MAX_NIST_QUALITY_METRIC_COUNT ( 357)
see page Defines maximum Fingerprint Image Quality (NFIQ) scores evaluation count in one record. Defines minimum vertex count in finger describing polygon. Defines excellent NIST Fingerprint Image Quality (NFIQ) score. Defines failed attempt to calculate NIST Fingerprint Image Quality (NFIQ) score.
MIN_ALTERNATE_SEGMENT_VERTEX_COUNT ( see page 358) NIST_QUALITY_METRIC_SCORE_EXCELLENT ( see page 358) NIST_QUALITY_METRIC_SCORE_FAILED ( page 358) NIST_QUALITY_METRIC_SCORE_FAIR ( 358) NIST_QUALITY_METRIC_SCORE_GOOD ( page 358) see
see page Defines fair NIST Fingerprint Image Quality (NFIQ) score. see Defines good NIST Fingerprint Image Quality (NFIQ) score.
NIST_QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines that NIST Fingerprint Image Quality (NFIQ) ( see page 358) score is not available for the image. NIST_QUALITY_METRIC_SCORE_POOR ( page 358) see Defines poor NIST Fingerprint Image Quality (NFIQ) score. Defines very good NIST Fingerprint Image Quality (NFIQ) score.
NIST_QUALITY_METRIC_SCORE_VERY_GOOD ( see page 358) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description
Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. see page 270). see page 270).
getRecordType ( isValidated ( setData ( setIdc ( nativeTypeOf (
353
8.1 Java Reference size ( see page 275)
Gets record size.
see page 220)
setSourceAgency (
see page
see page 259)
see
see page 261)
ANFPImageASCIIBinaryRecord Class Name getImpressionType ( 239) getPositions ( getPrintPositions ( getQualityMetrics ( nativeTypeOf ( setImpressionType ( 240) see page Description Gets the fingerprint impression type. Gets fingerprint positions contained in record. Gets fingerprint print positions contained in record. Retrieves a function that retrieves NType object for the enclosing type. Sets the fingerprint impression type.
see page 240) Gets fingerprint quality metrics contained in record.
354
8.1 Java Reference ANType14Record Class Name getAlternateSegments ( 358)
Description see page Gets particular alternate segment from ANType14Record. Gets particular alternate segment vertices from ANType14Record. Gets particular amputation from ANType14Record. Gets fingerprint capturing date.
getAlternateSegmentsVertices ( see page 359) getAmputations ( see page 359) see getFingerprintCaptureDate ( page 359) getNISTQualityMetrics ( 359)
see page Gets particular NIST quality metric from ANType14Record. see Gets print position descriptor information for fingerprint. Gets particular segmentation quality metric from ANType14Record. Gets particular fingerprint segment from ANType14Record. Retrieves a function that retrieves NType object for the enclosing type. Sets fingerprint capturing date. Sets print position descriptor information for fingerprint.
getPrintPositionDescriptor ( page 359)
getSegmentationQualityMetrics ( see page 359) getSegments ( nativeTypeOf ( see page 360) see page 360) see see
setFingerprintCaptureDate ( page 360) setPrintPositionDescriptor ( page 360)

8.1.2.1.31.1.1 ANType14Record.AlternateSegmentCollection Class
Represent collection of alternate segments. Java public final class AlternateSegmentCollection extends NStructureCollection<ANFAlternateSegment, ANFAlternateSegmentData>; File ANType14Record.java
8.1.2.1.31.1.2 ANType14Record.AlternateSegmentVerticesCollection Class

Represent collection of alternate segment vertices. Java public final class AlternateSegmentVerticesCollection extends NStructureArrayCollection<Point, NPointData, ANFAlternateSegment>; File ANType14Record.java
8.1.2.1.31.1.3 ANType14Record.AmputationCollection Class

Represent collection of amputations. Java public final class AmputationCollection extends NStructureCollection<ANFAmputation, ANFAmputationData>; File ANType14Record.java
355
8.1 Java Reference
8.1.2.1.31.1.4 ANType14Record.NISTQualityMetricCollection Class

Represent collection of NIST quality metrics. Java public final class NISTQualityMetricCollection extends NStructureCollection<ANNISTQualityMetric, ANNISTQualityMetricData>; File ANType14Record.java
8.1.2.1.31.1.5 ANType14Record.SegmentationQualityMetricCollection Class

Represent collection of segmentation quality metrics. Java public final class SegmentationQualityMetricCollection extends NStructureCollection<ANFPQualityMetric, ANFPQualityMetricData>; File ANType14Record.java
8.1.2.1.31.1.6 ANType14Record.SegmentCollection Class

Represent collection of segments. Java public final class SegmentCollection extends NStructureCollection<ANFSegment, ANFSegmentData>; File ANType14Record.java

8.1.2.1.31.2.1 ANType14Record.FIELD_AMP Field
Defines AMP field number. Field referenced by this number specifies if one or more fingers are amputated or bandaged (AMP). Java public static final int FIELD_AMP = 18;
8.1.2.1.31.2.2 ANType14Record.FIELD_ASEG Field

Defines ASEG field number. Field referenced by this number specifies alternate finger segment position(s) (ASEG). Java public static final int FIELD_ASEG = 25;
8.1.2.1.31.2.3 ANType14Record.FIELD_FCD Field

Defines FCD field number. Field referenced by this number contains fingerprint capture date (FCD), the date that the fingerprint image contained in the record was captured. Java public static final int FIELD_FCD = FIELD_DAT;
8.1.2.1.31.2.4 ANType14Record.FIELD_FQM Field

Defines FQM field number. Field referenced by this number contains one or more different metrics of fingerprint image
356
8.1 Java Reference
quality score data for the image stored in this record. Java public static final int FIELD_FQM = FIELD_IQM;
8.1.2.1.31.2.5 ANType14Record.FIELD_NQM Field

Defines NQM field number. Field referenced by this number contains the NIST Fingerprint Image Quality (NFIQ) scores for the individual finger(s) derived from the slap impressions or individual rolled fingerprints. Java public static final int FIELD_NQM = 22;
8.1.2.1.31.2.6 ANType14Record.FIELD_PPD Field

Defines PPD field number. Field referenced by this number contains Print Position Descriptors (PPD). Java public static final int FIELD_PPD = FIELD_PD;
8.1.2.1.31.2.7 ANType14Record.FIELD_SEG Field

Defines SEG field number. Field referenced by this number specifies alternate approach to describing the locations for each of the image segments of the individual fingers within a flat image. Java public static final int FIELD_SEG = 21;
8.1.2.1.31.2.8 ANType14Record.FIELD_SQM Field

Defines SQM field number. Field referenced by this number contains a measure of estimated correctness regarding the accuracy of the location of the segmented finger within the right or left four finger or two thumbs slap image. Java public static final int FIELD_SQM = 23;
8.1.2.1.31.2.9 ANType14Record.MAX_ALTERNATE_SEGMENT_COUNT Field

Defines maximum number of alternate segments. Java public static final int MAX_ALTERNATE_SEGMENT_COUNT = 4;
8.1.2.1.31.2.10 ANType14Record.MAX_ALTERNATE_SEGMENT_VERTEX_COUNT Field

Defines maximum alternative segment finger describing polygon vertex count. Java public static final int MAX_ALTERNATE_SEGMENT_VERTEX_COUNT = 99;
8.1.2.1.31.2.11 ANType14Record.MAX_AMPUTATION_COUNT Field

Defines maximum finger amputation count. Java public static final int MAX_AMPUTATION_COUNT = 4;
8.1.2.1.31.2.12 ANType14Record.MAX_NIST_QUALITY_METRIC_COUNT Field

Defines maximum Fingerprint Image Quality (NFIQ) scores evaluation count in one record. Java public static final int MAX_NIST_QUALITY_METRIC_COUNT = 4;
357
8.1 Java Reference
8.1.2.1.31.2.13 ANType14Record.MIN_ALTERNATE_SEGMENT_VERTEX_COUNT Field

Defines minimum vertex count in finger describing polygon. Java public static final int MIN_ALTERNATE_SEGMENT_VERTEX_COUNT = 3;
8.1.2.1.31.2.14 ANType14Record.NIST_QUALITY_METRIC_SCORE_EXCELLENT Field

Defines excellent NIST Fingerprint Image Quality (NFIQ) score. Java public static final int NIST_QUALITY_METRIC_SCORE_EXCELLENT = 1;
8.1.2.1.31.2.15 ANType14Record.NIST_QUALITY_METRIC_SCORE_FAILED Field

Defines failed attempt to calculate NIST Fingerprint Image Quality (NFIQ) score. Java public static final int NIST_QUALITY_METRIC_SCORE_FAILED = 255;
8.1.2.1.31.2.16 ANType14Record.NIST_QUALITY_METRIC_SCORE_FAIR Field

Defines fair NIST Fingerprint Image Quality (NFIQ) score. Java public static final int NIST_QUALITY_METRIC_SCORE_FAIR = 4;
8.1.2.1.31.2.17 ANType14Record.NIST_QUALITY_METRIC_SCORE_GOOD Field

Defines good NIST Fingerprint Image Quality (NFIQ) score. Java public static final int NIST_QUALITY_METRIC_SCORE_GOOD = 3;
8.1.2.1.31.2.18 ANType14Record.NIST_QUALITY_METRIC_SCORE_NOT_AVAILABLE Field

Defines that NIST Fingerprint Image Quality (NFIQ) score is not available for the image. Java public static final int NIST_QUALITY_METRIC_SCORE_NOT_AVAILABLE = 254;
8.1.2.1.31.2.19 ANType14Record.NIST_QUALITY_METRIC_SCORE_POOR Field

Defines poor NIST Fingerprint Image Quality (NFIQ) score. Java public static final int NIST_QUALITY_METRIC_SCORE_POOR = 5;
8.1.2.1.31.2.20 ANType14Record.NIST_QUALITY_METRIC_SCORE_VERY_GOOD Field

Defines very good NIST Fingerprint Image Quality (NFIQ) score. Java public static final int NIST_QUALITY_METRIC_SCORE_VERY_GOOD = 2;

8.1.2.1.31.3.1 ANType14Record.getAlternateSegments Method
Gets particular alternate segment from ANType14Record ( Java public AlternateSegmentCollection getAlternateSegments(); 358 see page 349).
8.1 Java Reference Returns A AlternateSegmentCollection (
see page 355) representing alternate segments from ANType14Record (
see page 349).
8.1.2.1.31.3.2 ANType14Record.getAlternateSegmentsVertices Method

Gets particular alternate segment vertices from ANType14Record ( Java public AlternateSegmentVerticesCollection getAlternateSegmentsVertices(); Returns A AlternateSegmentVerticesCollection ( see page 349). see page 355) representing alternate segment vertices from ANType14Record ( see page 349).
8.1.2.1.31.3.3 ANType14Record.getAmputations Method

Gets particular amputation from ANType14Record ( Java public AmputationCollection getAmputations(); Returns A AmputationCollection ( see page 355) representing amputations from ANType14Record ( see page 349). see page 349).
8.1.2.1.31.3.4 ANType14Record.getFingerprintCaptureDate Method

Gets fingerprint capturing date. Java public Date getFingerprintCaptureDate(); Returns Date object.
8.1.2.1.31.3.5 ANType14Record.getNISTQualityMetrics Method

Gets particular NIST quality metric from ANType14Record ( Java public NISTQualityMetricCollection getNISTQualityMetrics(); Returns A NistQualityMetricCollection representing NIST quality metrics from ANType14Record ( see page 349). see page 349).
8.1.2.1.31.3.6 ANType14Record.getPrintPositionDescriptor Method

Gets print position descriptor information for fingerprint. Java public ANFPositionDescriptor getPrintPositionDescriptor(); Returns ANFPositionDescriptor ( see page 245) object representing print position descriptor.
8.1.2.1.31.3.7 ANType14Record.getSegmentationQualityMetrics Method

Gets particular segmentation quality metric from ANType14Record ( Java public SegmentationQualityMetricCollection getSegmentationQualityMetrics(); 359 see page 349).
8.1 Java Reference Returns A SegmentationQualityMetricCollection ( ( see page 349).
see page 356) representing segmentation quality metric from ANType14Record
8.1.2.1.31.3.8 ANType14Record.getSegments Method

Gets particular fingerprint segment from ANType14Record ( Java public SegmentCollection getSegments(); Returns A SegmentCollection ( see page 356) representing fingerprint segments from ANType14Record ( see page 349). see page 349).

8.1.2.1.31.3.10 ANType14Record.setFingerprintCaptureDate Method

Sets fingerprint capturing date. Java public void setFingerprintCaptureDate(Date value); Parameters Parameters Date value Description Date value.
8.1.2.1.31.3.11 ANType14Record.setPrintPositionDescriptor Method

Sets print position descriptor information for fingerprint. Java public void setPrintPositionDescriptor(ANFPositionDescriptor value); Parameters Parameters ANFPositionDescriptor value Description ANFPositionDescriptor ( print position descriptor. see page 245) object representing

Provides functionality for working with variable-resolution palmprint image record. Java public final class ANType15Record extends ANFPImageASCIIBinaryRecord; File ANType15Record.java
360
8.1 Java Reference ANRecord Classes Name FieldCollection (
ANFPImageASCIIBinaryRecord Class Name PositionCollection ( PrintPositionCollection ( 238) QualityMetricCollection ( page 238) ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. Description see page 238) Represent collection of fingerprint positions. see page Represent collection of print positions. see Represent collection of fingerprint quality metrics.
FIELD_LEN (
see page 273)
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object.
361
8.1 Java Reference ANImageASCIIBinaryRecord Class Name FIELD_BPX (
Description see page 254) Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data. Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
FIELD_CGA (
see page 254)
FIELD_COM (
see page 254)
FIELD_CSP (
see page 255)
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
362
8.1 Java Reference
see page 256)
see page
see page 257)
see page
see
see
see page 257)
see page 258)
see
MAX_PRINT_POSITION_COUNT ( see page 239)
363
8.1 Java Reference ANType15Record Class Name FIELD_PCD ( FIELD_PLP ( FIELD_PQM (
Description see page 365) see page 365) see page 365) Defines PCD field number. Field referenced by this number contains the date that the palmprint image contained in the record was captured. Defines PLP field number. Field referenced by this number contains the palmprint position that matches the palmprint image. Defines PQM field number. Field referenced by this number contains one or more different metrics of palm image quality score data for the image stored in this record. Defines maximum number of palmprint image quality score metrics for the palm image.
MAX_QUALITY_METRIC_COUNT ( see page 366) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274)
see page 275)
see page 220)
setSourceAgency (
see page
see page 259)
see page Gets scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression.
364
8.1 Java Reference
Gets description of vendor compression algorithm, that has been used to compress the transmitted images.
see
see page 261)
ANFPImageASCIIBinaryRecord Class Name getImpressionType ( 239) getPositions ( getPrintPositions ( getQualityMetrics ( nativeTypeOf ( setImpressionType ( 240) ANType15Record Class Name getPalmprintCaptureDate ( page 366) nativeTypeOf ( setPalmprintCaptureDate ( page 366) see Description Gets palmprint image capture date. Retrieves a function that retrieves NType object for the enclosing type. Sets palmprint image capture date. see page Description Gets the fingerprint impression type. Gets fingerprint positions contained in record. Gets fingerprint print positions contained in record. Retrieves a function that retrieves NType object for the enclosing type. Sets the fingerprint impression type.
see page 240)
see page 366) see

8.1.2.1.32.1.1 ANType15Record.FIELD_PCD Field
Defines PCD field number. Field referenced by this number contains the date that the palmprint image contained in the record was captured. Java public static final int FIELD_PCD = FIELD_DAT;
8.1.2.1.32.1.2 ANType15Record.FIELD_PLP Field

Defines PLP field number. Field referenced by this number contains the palmprint position that matches the palmprint image. Java public static final int FIELD_PLP = FIELD_FGP;
8.1.2.1.32.1.3 ANType15Record.FIELD_PQM Field

Defines PQM field number. Field referenced by this number contains one or more different metrics of palm image quality score data for the image stored in this record.
365
public static final int FIELD_PQM = FIELD_IQM;

Defines maximum number of palmprint image quality score metrics for the palm image. Java public static final int MAX_QUALITY_METRIC_COUNT = 4;

8.1.2.1.32.2.1 ANType15Record.getPalmprintCaptureDate Method
Gets palmprint image capture date. Java public Date getPalmprintCaptureDate(); Returns Date object.

8.1.2.1.32.2.3 ANType15Record.setPalmprintCaptureDate Method

Sets palmprint image capture date. Java public void setPalmprintCaptureDate(Date value); Parameters Parameters Date value Description Date value.

Provdes functionality for User-defined variable-resolution testing image record. Java public final class ANType16Record extends ANImageASCIIBinaryRecord; File ANType16Record.java ANRecord Classes Name FieldCollection ( see page 271) Description Represent collection of subfields in field.
366
FIELD_LEN (
see page 273)
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANImageASCIIBinaryRecord Class Name FIELD_BPX ( see page 254) Description Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data.
FIELD_CGA (
see page 254)
FIELD_COM (
see page 254)
367
8.1 Java Reference FIELD_CSP (
see page 255)
Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
MAX_VENDOR_COMPRESSION_ALGORITHM_LENGTH Defines maximal length of vendor compression ( see page 256) algorithm description. MIN_LATENT_PIXEL_SCALE_PPCM ( see page 256) Defines minimal pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). 368
see page 256)
see page
8.1 Java Reference
see page 257)
Defines minimal pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286).
see page
see
see
see page 257)
see page 258)
MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH ( see page 258) ANType16Record Class Name FIELD_UDI ( FIELD_UQS ( FIELD_UTD ( see page 371) see page 371) see page 371) Description
Defines UDI field number. Field referenced by this number contains type of user-defined image contained in this record. Defines UQS field number. Field referenced by this number contains quality score data for the user-defined testing image. Defines UTD field number. Field referenced by this number contains the date that the user-defined testing image contained in the record was captured.
MAX_USER_DEFINED_IMAGE_LENGTH Defines maximum available user defined image length. ( see page 371) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
369
8.1 Java Reference ANASCIIBinaryRecord Class Name getDate ( see page 219) getSourceAgency ( nativeTypeOf ( setDate (
Description Gets field referenced by FieldDat field number. Retrieves a function that retrieves NType object for the enclosing type. Sets field referenced by FieldDat field number. see page 220) Gets source agency identification.
see page 220)
see page 220)
setSourceAgency (
see page
see page 259)
setDeviceMonitoringMode ( page 260) setScanHorzPixelScale ( page 261) setScanVertPixelScale ( 261) toNImage ( ANType16Record Class Name getUserDefinedImage ( 371)
see
see page 261)
Description see page Gets type for user defined testing image value.
getUserDefinedQualityScore ( page 371) getUserDefinedTestingDate ( page 371) nativeTypeOf ( setUserDefinedImage ( 372)
see Gets quality score for user defined testing image. see Gets user defined testing image capture date. Retrieves a function that retrieves NType object for the enclosing type. Sets type for user defined testing image value.
370
8.1 Java Reference
setUserDefinedQualityScore ( page 372) setUserDefinedTestingDate ( page 372)
see Sets quality score for user defined testing image. see Sets user defined testing image capture date.

8.1.2.1.33.1.1 ANType16Record.FIELD_UDI Field
Defines UDI field number. Field referenced by this number contains type of user-defined image contained in this record. Java public static final int FIELD_UDI = 3;
8.1.2.1.33.1.2 ANType16Record.FIELD_UQS Field

Defines UQS field number. Field referenced by this number contains quality score data for the user-defined testing image. Java public static final int FIELD_UQS = FIELD_IQM;
8.1.2.1.33.1.3 ANType16Record.FIELD_UTD Field

Defines UTD field number. Field referenced by this number contains the date that the user-defined testing image contained in the record was captured. Java public static final int FIELD_UTD = FIELD_DAT;
8.1.2.1.33.1.4 ANType16Record.MAX_USER_DEFINED_IMAGE_LENGTH Field

Defines maximum available user defined image length. Java public static final int MAX_USER_DEFINED_IMAGE_LENGTH = 35;

8.1.2.1.33.2.1 ANType16Record.getUserDefinedImage Method
Gets type for user defined testing image value. Java public String getUserDefinedImage(); Returns String containing type of for user defined testing image.
8.1.2.1.33.2.2 ANType16Record.getUserDefinedQualityScore Method

Gets quality score for user defined testing image. Java public ANQualityMetric getUserDefinedQualityScore(); Returns ANQualityMetric ( see page 268) object representing quality score.
8.1.2.1.33.2.3 ANType16Record.getUserDefinedTestingDate Method

Gets user defined testing image capture date. 371
public Date getUserDefinedTestingDate(); Returns Date object.

8.1.2.1.33.2.5 ANType16Record.setUserDefinedImage Method

Sets type for user defined testing image value. Java public void setUserDefinedImage(String value); Parameters Parameters String value Description String containing type of for user defined testing image.
8.1.2.1.33.2.6 ANType16Record.setUserDefinedQualityScore Method

Sets quality score for user defined testing image. Java public void setUserDefinedQualityScore(ANQualityMetric value); Parameters Parameters ANQualityMetric value Description ANQualityMetric ( quality score. see page 268) object representing
8.1.2.1.33.2.7 ANType16Record.setUserDefinedTestingDate Method

Sets user defined testing image capture date. Java public void setUserDefinedTestingDate(Date value); Parameters Parameters Date value Description Date value.

Provides functionality for managing iris image record. Java public final class ANType17Record extends ANImageASCIIBinaryRecord; File ANType17Record.java 372
FIELD_LEN (
see page 273)
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANImageASCIIBinaryRecord Class Name FIELD_BPX ( see page 254) Description Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images.
FIELD_CGA (
see page 254)
373
8.1 Java Reference FIELD_COM (
see page 254)
Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data. Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image. Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
FIELD_CSP (
see page 255)
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
FIELD_IQM (
see page 255)
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
MAX_VENDOR_COMPRESSION_ALGORITHM_LENGTH Defines maximal length of vendor compression ( see page 256) algorithm description. MIN_LATENT_PIXEL_SCALE_PPCM ( see page 256) Defines minimal pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286).
see page 256)
374
8.1 Java Reference
see page
Defines minimal pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286).
see page 257)
see page
see
see
see page 257)
see page 258)
MIN_VENDOR_COMPRESSION_ALGORITHM_LENGTH ( see page 258) ANType17Record Class Name FIELD_ALS ( FIELD_COM ( FIELD_DUI ( FIELD_ECL ( FIELD_FID ( FIELD_GUI ( FIELD_ICD ( FIELD_IPC ( FIELD_IQS ( FIELD_IRD ( FIELD_MMS ( see page 378) see page 378) see page 378) see page 378) see page 378) see page 378) see page 378) see page 379) see page 379) see page 379) see page 379) Description
Defines ALS field number. Field referenced by this number contains the lighting spectrum used in capturing the iris image. Is used to insert comments or other ASCII text information with the image data. Defines DUI field number. Field referenced by this number contains id of the device or source of the data. Defines ECL field number. Field referenced by this number contains the subject's eye color. Defines FID field number. Field referenced by this number contains an identifier for the eye represented by the image in the record. Defines GUI field number. Field referenced by this number contains globally unique identifier. Defines ICD field number. Field referenced by this number contains the date that the iris image contained in the record was captured. Defines IPC field number. Field referenced by this number contains image property code. Defines IQS field number. Field referenced by this number contains a quality score data for the iris image stored in this record. Defines IRD field number. Field referenced by this number contains the expected iris diameter in pixels. Defines MMS field number. Field referenced by this number contains make, model and serial number for the iris capture device. 375
8.1 Java Reference FIELD_RAE ( FIELD_RAU ( FIELD_SHPS (
Defines RAE field number. Field referenced by this number contains the rotation angle of the eye. Defines RAU field number. Field referenced by this number contains the rotation uncertainty. Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression providing the SLC field. Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression providing the SLC field. Maximum iris diameter in pixels.
FIELD_SVPS (
see page 379)
MAX_IRIS_DIAMETER ( page 380) MAX_MAKE_LENGTH ( 380) MAX_MODEL_LENGTH ( page 380)
see
see page Defines maximum make length value. see Defines maximum model length value.
MAX_SERIAL_NUMBER_LENGTH Defines maximum serial number length value. ( see page 380) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
see page 220)
setSourceAgency (
getCompressionAlgorithm ( page 258) getDeviceMonitoringMode ( page 259) getHorzLineLength ( 259)
see page
376
8.1 Java Reference getHorzPixelScale ( getScaleUnits (
see page 259)
setDeviceMonitoringMode ( page 260) setScanHorzPixelScale ( page 261) setScanVertPixelScale ( 261) toNImage ( ANType17Record Class Name
see
see page 261)
Description Gets the lighting spectrum used in capturing the iris. Gets unique device identifier information. Gets eye color information. Gets subject eye identifier information. Gets iris image property code. Gets iris image quality score. Gets iris image capture date. Gets iris diameter in pixels. Gets make of iris capture devise. Gets model of iris capture devise. Gets the rotation angle uncertainty of the eye. Gets serial number of iris capture devise. Gets globally unique identifier. Retrieves a function that retrieves NType object for the enclosing type. Sets the lighting spectrum used in capturing the iris. Sets unique device identifier information. Sets eye color information. Sets subject eye identifier information. Sets iris image property code.
getAcquisitionLightingSpectrum ( see page 380) getDeviceUniqueIdentifier ( page 380) getEyeColor ( getFeatureIdentifier ( 381) getImageProperties ( 381) see
see page 380) see page see page see page
getImageQualityScore ( 381) getIrisCaptureDate ( 381) getIrisDiameter ( getMake ( getModel (
see page
see page 381)
getRotationAngle (
see page 382) Gets rotation angle of the eye.
getRotationAngleUncertainty ( see page 382) getSerialNumber ( getUuid ( nativeTypeOf ( see page 382) see page 382) see page 382)
setAcquisitionLightingSpectrum ( see page 383) setDeviceUniqueIdentifier ( page 383) setEyeColor ( setFeatureIdentifier ( 383) setImageProperties ( 383) see
377
8.1 Java Reference setImageQualityScore ( 383) setIrisCaptureDate ( 384) setIrisDiameter (
see page
Sets iris image quality score. Sets iris image capture date. Sets iris diameter in pixels.
see page
see page 384)
setMakeModelSerialNumber ( page 384) setRotationAngle ( setRotationAngleUncertainty ( page 384) setUuid ( see page 385)
see Sets make, model and serial number for the iris capture device. Sets rotation angle of the eye.
see page 384)
see Sets the rotation angle uncertainty of the eye. Sets globally unique identifier.

8.1.2.1.34.1.1 ANType17Record.FIELD_ALS Field
Defines ALS field number. Field referenced by this number contains the lighting spectrum used in capturing the iris image. Java public static final int FIELD_ALS = 25;
8.1.2.1.34.1.2 ANType17Record.FIELD_COM Field

Is used to insert comments or other ASCII text information with the image data. Java public static final int FIELD_COM = 21;
8.1.2.1.34.1.3 ANType17Record.FIELD_DUI Field

Defines DUI field number. Field referenced by this number contains id of the device or source of the data. Java public static final int FIELD_DUI = 17;
8.1.2.1.34.1.4 ANType17Record.FIELD_ECL Field

Defines ECL field number. Field referenced by this number contains the subject's eye color. Java public static final int FIELD_ECL = 20;
8.1.2.1.34.1.5 ANType17Record.FIELD_FID Field

Defines FID field number. Field referenced by this number contains an identifier for the eye represented by the image in the record. Java public static final int FIELD_FID = 3;
8.1.2.1.34.1.6 ANType17Record.FIELD_GUI Field

Defines GUI field number. Field referenced by this number contains globally unique identifier. Java public static final int FIELD_GUI = 18;
8.1.2.1.34.1.7 ANType17Record.FIELD_ICD Field

Defines ICD field number. Field referenced by this number contains the date that the iris image contained in the record was captured.
378
public static final int FIELD_ICD = FIELD_DAT;
8.1.2.1.34.1.8 ANType17Record.FIELD_IPC Field

Defines IPC field number. Field referenced by this number contains image property code. Java public static final int FIELD_IPC = 16;
8.1.2.1.34.1.9 ANType17Record.FIELD_IQS Field

Defines IQS field number. Field referenced by this number contains a quality score data for the iris image stored in this record. Java public static final int FIELD_IQS = FIELD_IQM;
8.1.2.1.34.1.10 ANType17Record.FIELD_IRD Field

Defines IRD field number. Field referenced by this number contains the expected iris diameter in pixels. Java public static final int FIELD_IRD = 26;
8.1.2.1.34.1.11 ANType17Record.FIELD_MMS Field

Defines MMS field number. Field referenced by this number contains make, model and serial number for the iris capture device. Java public static final int FIELD_MMS = 19;
8.1.2.1.34.1.12 ANType17Record.FIELD_RAE Field

Defines RAE field number. Field referenced by this number contains the rotation angle of the eye. Java public static final int FIELD_RAE = 14;
8.1.2.1.34.1.13 ANType17Record.FIELD_RAU Field

Defines RAU field number. Field referenced by this number contains the rotation uncertainty. Java public static final int FIELD_RAU = 15;
8.1.2.1.34.1.14 ANType17Record.FIELD_SHPS Field

Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression providing the SLC field. Java public static final int FIELD_SHPS = 22;
8.1.2.1.34.1.15 ANType17Record.FIELD_SVPS Field

Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS) - the vertical pixel density used for the scanning of the original impression providing the SLC field. Java public static final int FIELD_SVPS = 23;
379
8.1 Java Reference
8.1.2.1.34.1.16 ANType17Record.MAX_IRIS_DIAMETER Field

Maximum iris diameter in pixels. Java public static final int MAX_IRIS_DIAMETER = 9999;
8.1.2.1.34.1.17 ANType17Record.MAX_MAKE_LENGTH Field

Defines maximum make length value. Java public static final int MAX_MAKE_LENGTH = 50;
8.1.2.1.34.1.18 ANType17Record.MAX_MODEL_LENGTH Field

Defines maximum model length value. Java public static final int MAX_MODEL_LENGTH = 50;
8.1.2.1.34.1.19 ANType17Record.MAX_SERIAL_NUMBER_LENGTH Field

Defines maximum serial number length value. Java public static final int MAX_SERIAL_NUMBER_LENGTH = 50;

8.1.2.1.34.2.1 ANType17Record.getAcquisitionLightingSpectrum Method
Gets the lighting spectrum used in capturing the iris. Java public ANIrisAcquisitionLightingSpectrum getAcquisitionLightingSpectrum(); Returns One of ANIrisAcquisitionLightingSpectrum values.
8.1.2.1.34.2.2 ANType17Record.getDeviceUniqueIdentifier Method

Gets unique device identifier information. Java public String getDeviceUniqueIdentifier(); Returns String containing unique device identifier information.
8.1.2.1.34.2.3 ANType17Record.getEyeColor Method

Gets eye color information. Java public BDIFEyeColor getEyeColor(); Returns One of BDIFEyeColor values.
380
8.1 Java Reference
8.1.2.1.34.2.4 ANType17Record.getFeatureIdentifier Method

Gets subject eye identifier information. Java public BDIFEyePosition getFeatureIdentifier(); Returns One of BDIFEyePosition values.
8.1.2.1.34.2.5 ANType17Record.getImageProperties Method

Gets iris image property code. Java public ANIrisImageProperties getImageProperties(); Returns ANIrisImageProperties ( see page 265) object.
8.1.2.1.34.2.6 ANType17Record.getImageQualityScore Method

Gets iris image quality score. Java public ANQualityMetric getImageQualityScore(); Returns ANQualityMetric ( see page 268) object.
8.1.2.1.34.2.7 ANType17Record.getIrisCaptureDate Method

Gets iris image capture date. Java public Date getIrisCaptureDate(); Returns Date object.
8.1.2.1.34.2.8 ANType17Record.getIrisDiameter Method

Gets iris diameter in pixels. Java public int getIrisDiameter(); Returns Number containing iris diameter in pixels.
8.1.2.1.34.2.9 ANType17Record.getMake Method

Gets make of iris capture devise. Java public String getMake(); Returns String containing make of iris capture device.
381
8.1 Java Reference
8.1.2.1.34.2.10 ANType17Record.getModel Method

Gets model of iris capture devise. Java public String getModel(); Returns String containing model of iris capture device.
8.1.2.1.34.2.11 ANType17Record.getRotationAngle Method

Gets rotation angle of the eye. Java public int getRotationAngle(); Returns Number representing rotation angle of the eye.
8.1.2.1.34.2.12 ANType17Record.getRotationAngleUncertainty Method

Gets the rotation angle uncertainty of the eye. Java public int getRotationAngleUncertainty(); Returns Number containing the rotation angle uncertainty.
8.1.2.1.34.2.13 ANType17Record.getSerialNumber Method

Gets serial number of iris capture devise. Java public String getSerialNumber(); Returns String containing serial number of iris capture device.
8.1.2.1.34.2.14 ANType17Record.getUuid Method

Gets globally unique identifier. Java public UUID getUuid(); Returns UUID object.

382
8.1 Java Reference
8.1.2.1.34.2.16 ANType17Record.setAcquisitionLightingSpectrum Method

Sets the lighting spectrum used in capturing the iris. Java public void setAcquisitionLightingSpectrum(ANIrisAcquisitionLightingSpectrum value); Parameters Parameters ANIrisAcquisitionLightingSpectrum value Description One of ANIrisAcquisitionLightingSpectrum values.
8.1.2.1.34.2.17 ANType17Record.setDeviceUniqueIdentifier Method

Sets unique device identifier information. Java public void setDeviceUniqueIdentifier(String value); Parameters Parameters String value Description String containing unique device identifier information.
8.1.2.1.34.2.18 ANType17Record.setEyeColor Method

Sets eye color information. Java public void setEyeColor(BDIFEyeColor value); Parameters Parameters BDIFEyeColor value Description One of BDIFEyeColor values.
8.1.2.1.34.2.19 ANType17Record.setFeatureIdentifier Method

Sets subject eye identifier information. Java public void setFeatureIdentifier(BDIFEyePosition value); Parameters Parameters BDIFEyePosition value Description One of BDIFEyePosition values.
8.1.2.1.34.2.20 ANType17Record.setImageProperties Method

Sets iris image property code. Java public void setImageProperties(ANIrisImageProperties value); Parameters Parameters ANIrisImageProperties value Description ANIrisImageProperties ( see page 265) object.
8.1.2.1.34.2.21 ANType17Record.setImageQualityScore Method

Sets iris image quality score.
383
public void setImageQualityScore(ANQualityMetric value); Parameters Parameters ANQualityMetric value Description ANQualityMetric ( see page 268) object.
8.1.2.1.34.2.22 ANType17Record.setIrisCaptureDate Method

Sets iris image capture date. Java public void setIrisCaptureDate(Date value); Parameters Parameters Date value Description Date value.
8.1.2.1.34.2.23 ANType17Record.setIrisDiameter Method

Sets iris diameter in pixels. Java public void setIrisDiameter(int value); Parameters Parameters int value Description Number containing iris diameter in pixels.
8.1.2.1.34.2.24 ANType17Record.setMakeModelSerialNumber Method

Sets make, model and serial number for the iris capture device. Java public void setMakeModelSerialNumber(String make, String model, String serialNumber); Parameters Parameters String make String model String serialNumber Description String containing make of the iris capture device. String containing model of the iris capture device. String containing serial number of iris capture device.
8.1.2.1.34.2.25 ANType17Record.setRotationAngle Method

Sets rotation angle of the eye. Java public void setRotationAngle(int value); Parameters Parameters int value Description Number representing rotation angle of the eye.
8.1.2.1.34.2.26 ANType17Record.setRotationAngleUncertainty Method

Sets the rotation angle uncertainty of the eye. Java public void setRotationAngleUncertainty(int value); 384
Description Number containing the rotation angle uncertainty.
8.1.2.1.34.2.27 ANType17Record.setUuid Method

Sets globally unique identifier. Java public void setUuid(UUID value); Parameters Parameters UUID value Description UUID object.

Provides functions for managing Type-1 Transaction information record. A Type-1 logical record is mandatory and is required for each transaction. The Type-1 record provides information describing type and use or purpose for the transaction involved, a listing of each logical record included in the file, the originator or source of the physical record, and other useful and required information items. Java public final class ANType1Record extends ANASCIIRecord; File ANType1Record.java ANRecord Classes Name FieldCollection ( ANType1Record Class Name CharsetCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. Description see page 389) Represent collection of subfields in field. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
385
8.1 Java Reference ANASCIIRecord Class Name MAX_FIELD_NUMBER ( page 221) ANType1Record Class Name CHARSET_ASCII ( CHARSET_LATIN (
Description see Defines maximum quantity of fields in record of Type-1, Type-2 and Type-9.
Description see page 390) see page 390) see page 390) see Defines 7-bit Ascii characters set. Defines 8-bit Ascii Latin characters set. Defines 16-bit Unicode characters set. User defined character set. Character set index starts at 128. User defined character set. Character set index ends at 999. Defines 8-bit UTF-8 characters set. Defines CNT field number. Field referenced by this number contains file content (CNT). This mandatory field shall list and identify each of the logical records in the file by record type. It also specifies the order in which the remaining logical records shall appear in the file. Defines DAI field number. Field referenced by this number contains destination agency identifier, the administration or organization designated to receive the transmission. Defines DAI field number. Field referenced by this number contains the date that the transaction was initiated. Defines DCS field number. Field referenced by this number contains directory of character sets. Defines DOM field number. Field referenced by this number contains domain name. This optional field identifies the domain name for the user-defined Type-2 logical record implementation. Defines GMT field number. Field referenced by this number contains greenwich mean time. Defines NSR field number. Field referenced by this number contains native scanning resolution. Defines NTR field number. Field referenced by this number contains native transmitting resolution. Defines ORI field number. Field referenced by this number contains originating agency identifier (ORI). This mandatory field shall contain the identifier of the administration or organization originating the transaction. Defines PRY field number. Field referenced by this number contains priority (PRY). This optional field shall contain a single information character to designate the urgency with which a response is desired. Defines TCN field number. Field referenced by this number contains transaction control number (TCN). This mandatory field shall contain the Transaction Control Number as assigned by the originating agency. Defines TCR field number. Field referenced by this number contains transaction control reference (TCR). This optional field shall be used for responses that refer to the TCN of a previous transaction involving an inquiry or other action that required a response.
CHARSET_UNICODE (
CHARSET_USER_DEFINED_FROM ( page 390) CHARSET_USER_DEFINED_TO ( page 390) CHARSET_UTF_8 ( FIELD_CNT ( see page 390) see page 390)
see
FIELD_DAI (
see page 391)
FIELD_DAT ( FIELD_DCS ( FIELD_DOM (
FIELD_GMT ( FIELD_NSR ( FIELD_NTR ( FIELD_ORI (
FIELD_PRY (
see page 392)
FIELD_TCN (
see page 392)
FIELD_TCR (
see page 392)
386
8.1 Java Reference FIELD_TOT (
see page 392)
Defines TOT field number. Field referenced by this number contains type of transaction (TOT). This mandatory field shall contain an identifier, which designates the type of transaction and subsequent processing that this file should be given. Defines VER field number. Field referenced by this number contains the current version number of the standard implemented by the software.
FIELD_VER (
see page 392)
MAX_HIGH_TRANSMITTING_RESOLUTION Defines maximal transmitting resolution for high-resolution ( see page 392) records. MAX_LOW_TRANSMITTING_RESOLUTION Defines maximal transmitting resolution for low-resolution ( see page 392) records. MAX_PRIORITY ( see page 392) Defines the urgency with which a response is desired. Earlier standard defined that priority values would be from 1 to 4. Lower numbers representing higher priority. Defines the urgency with which a response is desired. Current standard defines priority values from 1 to 9. Lower numbers represents higher priority. Defines maximal resolution value for NSR and NTR. Defines maximal resolution value for NSR and NTR for version 4.0 of the standard. Defines maximal length of transaction type field value. Defines minimal transmitting resolution for high-resolution records. Defines minimal transmitting resolution for low-resolution records. Defines minimal Native scanning resolution (NSR). Defines minimal Minimal scanning resolution which is 19.60 pixel points per millimeter. Defines minimal length of transaction type field value.
MAX_PRIORITY_V3 (
see page 393)
MAX_RESOLUTION (
MAX_RESOLUTION_V4 (
MAX_TRANSACTION_TYPE_LENGTH_V4 ( see page 393) MIN_HIGH_TRANSMITTING_RESOLUTION ( see page 393) MIN_LOW_TRANSMITTING_RESOLUTION ( see page 393) MIN_NATIVE_SCANNING_RESOLUTION ( see page 393) MIN_SCANNING_RESOLUTION ( page 393) see
MIN_TRANSACTION_TYPE_LENGTH_V4 ( see page 393) ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274)
see page 275)
ANASCIIRecord Class Name nativeTypeOf ( ANType1Record Class Name getCharsets ( see page 394) Description Gets particular charset from ANType1Record. see page 222) Description Retrieves a function that retrieves NType object for the enclosing type.
387
8.1 Java Reference getDate ( see page 394)
Gets date value. Gets destination agency identifier. Gets domain name for the user-defined Type-2 logical record implementation. Gets domain version for the user-defined Type-2 logical record implementation. Gets Greenwich mean time. Gets native scanning resolution. Gets nominal transmitting resolution. Gets originating agency identifier. Gets priority - the urgency with which a response is desired. Retrieves standard description of the charset specified by an index and version. Gets charset index by charset name.
getDestinationAgency ( 394) getDomainName ( getDomainVersion ( 394) getGmt (
see page
see page 394)
getNativeScanningResolution ( see page 395) getNominalTransmittingResolution ( see page 395) getOriginatingAgency ( 395) getPriority ( see page
see page 395)
getStandardCharsetDescription ( see page 395) getStandardCharsetIndexByName ( see page 395) getStandardCharsetIndexes ( page 396) getStandardCharsetName ( page 396) getTransactionControl ( 396)
see Gets all standard charset indexes. see Gets standard charset name by charset index. Gets transaction control identifier. Gets transaction control reference. Gets type of the transaction. Check if sharset is known. Check if sharset is standard. Check if charset specified by charsetIndex is user defined. Retrieves a function that retrieves NType object for the enclosing type. Sets date value. Sets destination agency identifier. Sets domain name of the ANRecord ( see page 270) for the user-defined Type-2 logical record implementation. Sets Greenwich mean time. Sets originating agency identifier. Sets priority - the urgency with which a response is desired. Sets transaction control identifier. Sets transaction control reference. Sets type of the transaction.
see page
getTransactionControlReference ( see page 396) getTransactionType ( 397) isCharsetKnown ( isCharsetStandard ( 397) see page
isCharsetUserDefined ( 397) nativeTypeOf ( setDate (
see page 398)
setDestinationAgency ( 398) setDomain ( setGmt (
see page 398)
setOriginatingAgency ( 399) setPriority ( setTransactionControl ( 399)
setTransactionControlReference ( see page 399) setTransactionType ( 399) see page
388
8.1 Java Reference
8.1.2.1.35.1.1 ANType1Record.CharsetCollection Class

Represent collection of subfields in field. Java public final class CharsetCollection extends NStructureCollection<ANCharset, ANCharsetData>; File ANType1Record.java CharsetCollection Methods Name add ( see page 389) see page 389) contains ( Description Adds character set to CharsetCollection with specified name, version. Check if character set specified by charsetIndex is in CharsetCollection.
8.1.2.1.35.1.1.1 CharsetCollection Methods 8.1.2.1.35.1.1.1.1 add Method 8.1.2.1.35.1.1.1.1.1 ANType1Record.CharsetCollection.add Method (int, String, String)
Adds character set to CharsetCollection ( Java public boolean add(int charsetIndex, String name, String version); Parameters Parameters int charsetIndex String name String version Returns Number of character sets in CharsetCollection ( see page 389). Description Character set index. String containing character set name. String containing character set version. see page 389) with specified name, version.
8.1.2.1.35.1.1.1.1.2 ANType1Record.CharsetCollection.add Method (int, int, String, String)

Adds character set to CharsetCollection ( Java public void add(int index, int charsetIndex, String name, String version); Parameters Parameters int index int charsetIndex String name String version Returns Number of character sets in CharsetCollection ( see page 389). Description Added charset index. Character set index. String containing character set name. String containing character set version. see page 389) with specified name, version and index.
8.1.2.1.35.1.1.1.2 ANType1Record.CharsetCollection.contains Method

Check if character set specified by charsetIndex is in CharsetCollection ( see page 389).
389
public boolean contains(int charsetIndex); Parameters Parameters int charsetIndex Returns true if character set is in CharsetCollection ( false . see page 389) otherwise Description Character set index.

8.1.2.1.35.2.1 ANType1Record.CHARSET_ASCII Field
Defines 7-bit Ascii characters set. Java public static final int CHARSET_ASCII = 0;
8.1.2.1.35.2.2 ANType1Record.CHARSET_LATIN Field

Defines 8-bit Ascii Latin characters set. Java public static final int CHARSET_LATIN = 1;
8.1.2.1.35.2.3 ANType1Record.CHARSET_UNICODE Field

Defines 16-bit Unicode characters set. Java public static final int CHARSET_UNICODE = 2;
8.1.2.1.35.2.4 ANType1Record.CHARSET_USER_DEFINED_FROM Field

User defined character set. Character set index starts at 128. Java public static final int CHARSET_USER_DEFINED_FROM = 128;
8.1.2.1.35.2.5 ANType1Record.CHARSET_USER_DEFINED_TO Field

User defined character set. Character set index ends at 999. Java public static final int CHARSET_USER_DEFINED_TO = 999;
8.1.2.1.35.2.6 ANType1Record.CHARSET_UTF_8 Field

Defines 8-bit UTF-8 characters set. Java public static final int CHARSET_UTF_8 = 3;
8.1.2.1.35.2.7 ANType1Record.FIELD_CNT Field

Defines CNT field number. Field referenced by this number contains file content (CNT). This mandatory field shall list and identify each of the logical records in the file by record type. It also specifies the order in which the remaining logical records 390
8.1 Java Reference shall appear in the file. Java
public static final int FIELD_CNT = 3;
8.1.2.1.35.2.8 ANType1Record.FIELD_DAI Field

Defines DAI field number. Field referenced by this number contains destination agency identifier, the administration or organization designated to receive the transmission. Java public static final int FIELD_DAI = 7;
8.1.2.1.35.2.9 ANType1Record.FIELD_DAT Field

Defines DAI field number. Field referenced by this number contains the date that the transaction was initiated. Java public static final int FIELD_DAT = 5;
8.1.2.1.35.2.10 ANType1Record.FIELD_DCS Field

Defines DCS field number. Field referenced by this number contains directory of character sets. Java public static final int FIELD_DCS = 15;
8.1.2.1.35.2.11 ANType1Record.FIELD_DOM Field

Defines DOM field number. Field referenced by this number contains domain name. This optional field identifies the domain name for the user-defined Type-2 logical record implementation. Java public static final int FIELD_DOM = 13;
8.1.2.1.35.2.12 ANType1Record.FIELD_GMT Field

Defines GMT field number. Field referenced by this number contains greenwich mean time. Java public static final int FIELD_GMT = 14;
8.1.2.1.35.2.13 ANType1Record.FIELD_NSR Field

Defines NSR field number. Field referenced by this number contains native scanning resolution. Java public static final int FIELD_NSR = 11;
8.1.2.1.35.2.14 ANType1Record.FIELD_NTR Field

Defines NTR field number. Field referenced by this number contains native transmitting resolution. Java public static final int FIELD_NTR = 12;
8.1.2.1.35.2.15 ANType1Record.FIELD_ORI Field

Defines ORI field number. Field referenced by this number contains originating agency identifier (ORI). This mandatory field shall contain the identifier of the administration or organization originating the transaction. Java public static final int FIELD_ORI = 8;
391
8.1 Java Reference
8.1.2.1.35.2.16 ANType1Record.FIELD_PRY Field

Defines PRY field number. Field referenced by this number contains priority (PRY). This optional field shall contain a single information character to designate the urgency with which a response is desired. Java public static final int FIELD_PRY = 6;
8.1.2.1.35.2.17 ANType1Record.FIELD_TCN Field

Defines TCN field number. Field referenced by this number contains transaction control number (TCN). This mandatory field shall contain the Transaction Control Number as assigned by the originating agency. Java public static final int FIELD_TCN = 9;
8.1.2.1.35.2.18 ANType1Record.FIELD_TCR Field

Defines TCR field number. Field referenced by this number contains transaction control reference (TCR). This optional field shall be used for responses that refer to the TCN of a previous transaction involving an inquiry or other action that required a response. Java public static final int FIELD_TCR = 10;
8.1.2.1.35.2.19 ANType1Record.FIELD_TOT Field

Defines TOT field number. Field referenced by this number contains type of transaction (TOT). This mandatory field shall contain an identifier, which designates the type of transaction and subsequent processing that this file should be given. Java public static final int FIELD_TOT = 4;
8.1.2.1.35.2.20 ANType1Record.FIELD_VER Field

Defines VER field number. Field referenced by this number contains the current version number of the standard implemented by the software. Java public static final int FIELD_VER = 2;
8.1.2.1.35.2.21 ANType1Record.MAX_HIGH_TRANSMITTING_RESOLUTION Field

Defines maximal transmitting resolution for high-resolution records. Java public static final int MAX_HIGH_TRANSMITTING_RESOLUTION = 20670;
8.1.2.1.35.2.22 ANType1Record.MAX_LOW_TRANSMITTING_RESOLUTION Field

Defines maximal transmitting resolution for low-resolution records. Java public static final int MAX_LOW_TRANSMITTING_RESOLUTION = 10340;
8.1.2.1.35.2.23 ANType1Record.MAX_PRIORITY Field

Defines the urgency with which a response is desired. Earlier standard defined that priority values would be from 1 to 4. Lower numbers representing higher priority. Java public static final int MAX_PRIORITY = 4;
392
8.1 Java Reference
8.1.2.1.35.2.24 ANType1Record.MAX_PRIORITY_V3 Field

Defines the urgency with which a response is desired. Current standard defines priority values from 1 to 9. Lower numbers represents higher priority. Java public static final int MAX_PRIORITY_V3 = 9;
8.1.2.1.35.2.25 ANType1Record.MAX_RESOLUTION Field

Defines maximal resolution value for NSR and NTR. Java public static final int MAX_RESOLUTION = 99990;
8.1.2.1.35.2.26 ANType1Record.MAX_RESOLUTION_V4 Field

Defines maximal resolution value for NSR and NTR for version 4.0 of the standard. Java public static final int MAX_RESOLUTION_V4 = 999990;
8.1.2.1.35.2.27 ANType1Record.MAX_TRANSACTION_TYPE_LENGTH_V4 Field

Defines maximal length of transaction type field value. Java public static final int MAX_TRANSACTION_TYPE_LENGTH_V4 = 4;
8.1.2.1.35.2.28 ANType1Record.MIN_HIGH_TRANSMITTING_RESOLUTION Field

Defines minimal transmitting resolution for high-resolution records. Java public static final int MIN_HIGH_TRANSMITTING_RESOLUTION = 19490;
8.1.2.1.35.2.29 ANType1Record.MIN_LOW_TRANSMITTING_RESOLUTION Field

Defines minimal transmitting resolution for low-resolution records. Java public static final int MIN_LOW_TRANSMITTING_RESOLUTION = 9740;
8.1.2.1.35.2.30 ANType1Record.MIN_NATIVE_SCANNING_RESOLUTION Field

Defines minimal Native scanning resolution (NSR). Java public static final int MIN_NATIVE_SCANNING_RESOLUTION = 19490;
8.1.2.1.35.2.31 ANType1Record.MIN_SCANNING_RESOLUTION Field

Defines minimal Minimal scanning resolution which is 19.60 pixel points per millimeter. Java public static final int MIN_SCANNING_RESOLUTION = 19690;
8.1.2.1.35.2.32 ANType1Record.MIN_TRANSACTION_TYPE_LENGTH_V4 Field

Defines minimal length of transaction type field value. Java public static final int MIN_TRANSACTION_TYPE_LENGTH_V4 = 3;

393
8.1 Java Reference
8.1.2.1.35.3.1 ANType1Record.getCharsets Method

Gets particular charset from ANType1Record ( Java public CharsetCollection getCharsets(); Returns A CharsetCollection ( see page 389) representing charsets from ANType1Record ( see page 385). see page 385).
8.1.2.1.35.3.2 ANType1Record.getDate Method

Gets date value. Java public Date getDate(); Returns Date object.
8.1.2.1.35.3.3 ANType1Record.getDestinationAgency Method

Gets destination agency identifier. Java public String getDestinationAgency(); Returns String containing destination agency identifier.
8.1.2.1.35.3.4 ANType1Record.getDomainName Method

Gets domain name for the user-defined Type-2 logical record implementation. Java public String getDomainName(); Returns String containing domain name.
8.1.2.1.35.3.5 ANType1Record.getDomainVersion Method

Gets domain version for the user-defined Type-2 logical record implementation. Java public String getDomainVersion(); Returns String containing domain version.
8.1.2.1.35.3.6 ANType1Record.getGmt Method

Gets Greenwich mean time. Java public Date getGmt(); Returns Date object.
394
8.1 Java Reference
8.1.2.1.35.3.7 ANType1Record.getNativeScanningResolution Method

Gets native scanning resolution. Java public int getNativeScanningResolution(); Returns Number containing native scanning resolution.
8.1.2.1.35.3.8 ANType1Record.getNominalTransmittingResolution Method

Gets nominal transmitting resolution. Java public int getNominalTransmittingResolution(); Returns Number containing nominal transmitting resolution.
8.1.2.1.35.3.9 ANType1Record.getOriginatingAgency Method

Gets originating agency identifier. Java public String getOriginatingAgency(); Returns String originating agency identifier.
8.1.2.1.35.3.10 ANType1Record.getPriority Method

Gets priority - the urgency with which a response is desired. Java public int getPriority(); Returns Number containing priority value.
8.1.2.1.35.3.11 ANType1Record.getStandardCharsetDescription Method

Retrieves standard description of the charset specified by an index and version. Java public static String getStandardCharsetDescription(NVersion version, int charsetIndex); Parameters Parameters NVersion version int charsetIndex Returns String containing charset description. Description One of NVersion values. Charset index.
8.1.2.1.35.3.12 ANType1Record.getStandardCharsetIndexByName Method

Gets charset index by charset name.
395
public static int getStandardCharsetIndexByName(NVersion version, String name); Parameters Parameters NVersion version String name Returns Charset index. Description One of NVersion values. Name of the charset.
8.1.2.1.35.3.13 ANType1Record.getStandardCharsetIndexes Method

Gets all standard charset indexes. Java public static int getStandardCharsetIndexes(NVersion version); Parameters Parameters NVersion version Returns Array containing ctandard charset indexes. Description One of NVersion values.
8.1.2.1.35.3.14 ANType1Record.getStandardCharsetName Method

Gets standard charset name by charset index. Java public static String getStandardCharsetName(NVersion version, int charsetIndex); Parameters Parameters NVersion version int charsetIndex Returns String containing standard charset name. Description One of NVersion values. Charset index.
8.1.2.1.35.3.15 ANType1Record.getTransactionControl Method

Gets transaction control identifier. Java public String getTransactionControl(); Returns String transaction control identifier.
8.1.2.1.35.3.16 ANType1Record.getTransactionControlReference Method

Gets transaction control reference. Java public String getTransactionControlReference();
396
8.1 Java Reference Returns String transaction control reference.
8.1.2.1.35.3.17 ANType1Record.getTransactionType Method

Gets type of the transaction. Java public String getTransactionType(); Returns String containing type of the transaction.
8.1.2.1.35.3.18 ANType1Record.isCharsetKnown Method

Check if sharset is known. Java public static boolean isCharsetKnown(NVersion version, int charsetIndex); Parameters Parameters NVersion version int charsetIndex Returns true if charset is known otherwise false . Description One of NVersion values. Charset index.
8.1.2.1.35.3.19 ANType1Record.isCharsetStandard Method

Check if sharset is standard. Java public static boolean isCharsetStandard(NVersion version, int charsetIndex); Parameters Parameters NVersion version int charsetIndex Returns true if charset is standard otherwise false . Description One of NVersion values. Charset index.
8.1.2.1.35.3.20 ANType1Record.isCharsetUserDefined Method

Check if charset specified by charsetIndex is user defined. Java public static boolean isCharsetUserDefined(NVersion version, int charsetIndex);
397
8.1 Java Reference Parameters Parameters NVersion version int charsetIndex Returns true if charset is user defined otherwise false .
Description One of NVersion values. Charset index.

8.1.2.1.35.3.22 ANType1Record.setDate Method

Sets date value. Java public void setDate(Date value); Parameters Parameters Date value Description Date object.
8.1.2.1.35.3.23 ANType1Record.setDestinationAgency Method

Sets destination agency identifier. Java public void setDestinationAgency(String value); Parameters Parameters String value Description String containing destination agency identifier.
8.1.2.1.35.3.24 ANType1Record.setDomain Method

Sets domain name of the ANRecord ( Java public void setDomain(String name, String version); Parameters Parameters String name String version Description String which contains domain name of the ANRecord ( page 270) Type-1 record. String which contains ANRecord ( see see page 270) for the user-defined Type-2 logical record implementation.
see page 270) version.
398
8.1 Java Reference
8.1.2.1.35.3.25 ANType1Record.setGmt Method

Sets Greenwich mean time. Java public void setGmt(Date value); Parameters Parameters Date value Description Date object.
8.1.2.1.35.3.26 ANType1Record.setOriginatingAgency Method

Sets originating agency identifier. Java public void setOriginatingAgency(String value); Parameters Parameters String value Description String containing originating agency identifier.
8.1.2.1.35.3.27 ANType1Record.setPriority Method

Sets priority - the urgency with which a response is desired. Java public void setPriority(int value); Parameters Parameters int value Description Number containing priority value.
8.1.2.1.35.3.28 ANType1Record.setTransactionControl Method

Sets transaction control identifier. Java public void setTransactionControl(String value); Parameters Parameters String value Description String containing transaction control identifier.
8.1.2.1.35.3.29 ANType1Record.setTransactionControlReference Method

Sets transaction control reference. Java public void setTransactionControlReference(String value); Parameters Parameters String value Description String containing transaction control reference.
8.1.2.1.35.3.30 ANType1Record.setTransactionType Method

Sets type of the transaction.
399
public void setTransactionType(String value); Parameters Parameters String value Description String containing type of the transaction.

Contain user-defined textual fields providing identification and descriptive information associated with the subject of the transaction. Data contained in this record conforms in format and content to the specifications of the domain name as listed in Domain Name field found in the Type-1 record. Java public final class ANType2Record extends ANASCIIRecord; File ANType2Record.java ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( ANASCIIRecord Class Name MAX_FIELD_NUMBER ( page 221) ANType2Record Class Name FIELD_UDF_FROM ( 401) FIELD_UDF_TO ( FIELD_UDF_TO_V4 ( 401) ANRecord Methods Name beginUpdate ( see page 273) Description Begins updating the record. 400 see page Description Defines the starting position of the User-defined fields. Defines the end position of the User-defined fields. Defines the end position of the User-defined fields. (This flag is valid since ANSI/NIST-ITL 1-2007 standard.) see Description Defines maximum quantity of fields in record of Type-1, Type-2 and Type-9. see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. see page 273)
8.1 Java Reference endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 274)
Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
ANASCIIRecord Class Name nativeTypeOf ( ANType2Record Class Name nativeTypeOf ( see page 401) Description Retrieves a function that retrieves NType object for the enclosing type. see page 222) Description Retrieves a function that retrieves NType object for the enclosing type.

8.1.2.1.36.1.1 ANType2Record.FIELD_UDF_FROM Field
Defines the starting position of the User-defined fields. Java public static final int FIELD_UDF_FROM = FIELD_IDC + 1;
8.1.2.1.36.1.2 ANType2Record.FIELD_UDF_TO Field

Defines the end position of the User-defined fields. Java public static final int FIELD_UDF_TO = ANRecord.MAX_FIELD_NUMBER;
8.1.2.1.36.1.3 ANType2Record.FIELD_UDF_TO_V4 Field

Defines the end position of the User-defined fields. (This flag is valid since ANSI/NIST-ITL 1-2007 standard.) Java public static final int FIELD_UDF_TO_V4 = MAX_FIELD_NUMBER;


Provides functions and fields for managing low-resolution grayscale fingerprint image. 401
public final class ANType3Record extends ANFImageBinaryRecord; File ANType3Record.java ANRecord Classes Name FieldCollection ( ANFImageBinaryRecord Class Name PositionCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. Description see page 231) Represent collection of fingerprint positions. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
402
8.1 Java Reference ANType3Record Class Name FIELD_GCA ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc (
Description see page 404) Defines GCA field number. Field referenced by this number contains compression algorithm.
see page 275)
ANBinaryRecord Class Name nativeTypeOf ( ANImageBinaryRecord Class Name getHorzLineLength ( 263) getImageResolution ( 263) see page see page Description Gets or horizontal line length value. Gets image resolution value. Gets value of image scanning resolution. see page 223) Description Retrieves a function that retrieves NType object for the enclosing type.
see page 264)
see page 264)
setImpressionType ( 232) ANType3Record Class Name
Description see Gets compression algorithm used to compress image data. Gets vendor compression algorithm value used to compress image data. Retrieves a function that retrieves NType object for the enclosing type. 403
getUserDefinedQualityScore ( page 404)
getVendorCompressionAlgorithm ( see page 404) nativeTypeOf ( see page 404)
8.1 Java Reference

8.1.2.1.37.1.1 ANType3Record.FIELD_GCA Field
Defines GCA field number. Field referenced by this number contains compression algorithm. Java public static final int FIELD_GCA = FIELD_CA;

Gets compression algorithm used to compress image data. Java public ANImageCompressionAlgorithm getUserDefinedQualityScore(); Returns One of ANImageCompressionAlgorithm values.
8.1.2.1.37.2.2 ANType3Record.getVendorCompressionAlgorithm Method

Gets vendor compression algorithm value used to compress image data. Java public byte getVendorCompressionAlgorithm(); Returns Vendor compression algorithm.


Provides functions and methods for managing High-resolution grayscale fingerprint images. Java public final class ANType4Record extends ANFImageBinaryRecord; File ANType4Record.java ANRecord Classes Name FieldCollection ( ANFImageBinaryRecord Class Name PositionCollection ( Description see page 231) Represent collection of fingerprint positions. 404 see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
MAX_POSITION_COUNT ( page 232) ANType4Record Class Name FIELD_GCA ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc (
Description see page 406) Defines GCA field number. Field referenced by this number contains compression algorithm.
Description see page 273) see page 273) see page 274) see page 274) see page 274) Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( see page 270). 405 see page 270).
getRecordType ( isValidated ( setData ( nativeTypeOf (
see page 275)
8.1 Java Reference setIdc ( size ( see page 275) see page 275)
Sets idc of record. Gets record size.
see page 264)
see page 264)
Description see Gets compression algorithm used to compress image data. Gets vendor compression algorithm value used to compress image data. Retrieves a function that retrieves NType object for the enclosing type.

8.1.2.1.38.1.1 ANType4Record.FIELD_GCA Field
Defines GCA field number. Field referenced by this number contains compression algorithm. Java public static final int FIELD_GCA = FIELD_CA;

Gets compression algorithm used to compress image data. Java public ANImageCompressionAlgorithm getUserDefinedQualityScore();
406
One of ANImageCompressionAlgorithm values.



Provides functions and methods for managing Low-resolution binary fingerprint images. Java public final class ANType5Record extends ANFImageBinaryRecord; File ANType5Record.java ANRecord Classes Name FieldCollection ( ANFImageBinaryRecord Class Name PositionCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. Description see page 231) Represent collection of fingerprint positions. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. 407
see page 273)
8.1 Java Reference ANImageBinaryRecord Class Name
Description
MAX_POSITION_COUNT ( page 232) ANType5Record Class Name FIELD_BCA ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc (
Description see page 409) Defines BCA field number. Field referenced by this number contains compression algorithm.
see page 275)
getImageScanResolutionValue ( see page 264) getVertLineLength (
see page 264) Gets or vertical line length value. 408
8.1 Java Reference isImageScanResolution ( page 264) nativeTypeOf ( toNImage (
see
Gets flag which defines what type of image scan resolution was used. Retrieves a function that retrieves NType object for the enclosing type. Converts image contained in logical record to NImage format.
see page 264)
see page 264)

8.1.2.1.39.1.1 ANType5Record.FIELD_BCA Field
Defines BCA field number. Field referenced by this number contains compression algorithm. Java public static final int FIELD_BCA = FIELD_CA;



Retrieves a function that retrieves NType object for the enclosing type.
409
public static NType nativeTypeOf(); Returns The function that retrieves NType object for the enclosing type.

Provides functions and methods for managing High-resolution binary fingerprint image. Java public final class ANType6Record extends ANFImageBinaryRecord; File ANType6Record.java ANRecord Classes Name FieldCollection ( ANFImageBinaryRecord Class Name PositionCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. Description see page 231) Represent collection of fingerprint positions. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
AN_IMAGE_BINARY_RECORD_FIELD_HLL Defines HLL field number. Field referenced by this number ( see page 263) contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). AN_IMAGE_BINARY_RECORD_FIELD_ISR Defines ISE field number. Field referenced by this number ( see page 263) contains flag of image scanning resolution. AN_IMAGE_BINARY_RECORD_FIELD_VLL Defines VLL field number. Field referenced by this number ( see page 263) contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. ANFImageBinaryRecord Class Name FIELD_CA ( see page 231) Description Defines CA field number. Field referenced by this number specify the type of compression algorithm used(if any).
410
8.1 Java Reference FIELD_FGP ( FIELD_IMP (
Defines FGP field number. Field represented by this number contains possible finger positions. Defined IMP field number. Field referenced by this number describes the manner by which the fingerprint image information has been obtained. Defines maximum count of positions in fingerprint record.
MAX_POSITION_COUNT ( page 232) ANType6Record Class Name FIELD_BCA ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc (
Description see page 412) Defines BCA field number. Field referenced by this number contains compression algorithm.
see page 275)
see page 264)
see page 264)
setImpressionType ( 232)
411
8.1 Java Reference ANType6Record Class Name

8.1.2.1.40.1.1 ANType6Record.FIELD_BCA Field
Defines BCA field number. Field referenced by this number contains compression algorithm. Java public static final int FIELD_BCA = FIELD_CA;




Provides functionality for managing User-defined image record. Java public final class ANType7Record extends ANBinaryRecord; File ANType7Record.java 412
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( ANType7Record Class Name FIELD_UDF ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) Description Begins updating the record. Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270). see page 413) Description Defines UDF field number. Field referenced by this number contains user-defined fields for Type-7 logical record. see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. see page 273)
see page 275)
ANBinaryRecord Class Name nativeTypeOf ( ANType7Record Class Name nativeTypeOf ( see page 414) Description Retrieves a function that retrieves NType object for the enclosing type. see page 223) Description Retrieves a function that retrieves NType object for the enclosing type.

8.1.2.1.41.1.1 ANType7Record.FIELD_UDF Field
Defines UDF field number. Field referenced by this number contains user-defined fields for Type-7 logical record.
413
public static final int FIELD_UDF = FIELD_DATA;


Provides functions for working with signature image record. Java public final class ANType8Record extends ANFPImageASCIIBinaryRecord; File ANType8Record.java ANRecord Classes Name FieldCollection ( see page 271) Description Represent collection of subfields in field.
ANFPImageASCIIBinaryRecord Class Name PositionCollection ( PrintPositionCollection ( 238) QualityMetricCollection ( page 238) ANType8Record Class Name PenVectorCollection ( 419) ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. see page Description Represent collection of pen vectors. Description see page 238) Represent collection of fingerprint positions. see page Represent collection of print positions. see Represent collection of fingerprint quality metrics.
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( see page 273) Defines maximal number of fields in logical record.
414
8.1 Java Reference MAX_IDC ( see page 273)
Defines maximum value that image designation character (IDC) can obtain.
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANImageASCIIBinaryRecord Class Name FIELD_BPX ( see page 254) Description Defines BPX field number. Field referenced by this number contains bits per pixel (BPX), the number of bits used to represent a pixel. Defines CGA field number. Field referenced by this number specifies compression algorithm (CGA), the algorithm used to compress the transmitted grayscale images. Defines COM field number. Field referenced by this number contains comments or other ASCII text information with the image data. Defines CSP field number. Field referenced by this number contains color space used to exchange the image data. Defines DMM field number. Field referenced by this number contains device monitoring mode (DMM) value which provides information describing the level of human monitoring for the image capture device. Defines HLL field number. Field referenced by this number contain the number of pixels contained on a single horizontal line of the transmitted image (horizontal line length - HLL). Defines HPS field number. Field referenced by this number contains horizontal pixel scale (HPS), the integer pixel density used in the horizontal direction of the transmitted image.
FIELD_CGA (
see page 254)
FIELD_COM (
see page 254)
FIELD_CSP (
see page 255)
FIELD_DMM (
see page 255)
FIELD_HLL (
see page 255)
FIELD_HPS (
see page 255)
415
8.1 Java Reference FIELD_IQM (
see page 255)
Defines IQM field number. Field referenced by this number contains a quality score data for the image stored in record Defines SHPS field number. Field referenced by this number contains scanned horizontal pixel scale (SHPS) - the horizontal pixel density used for the scanning of the original impression. Defines SLC field number. Field referenced by this number contains scale units (SLC) - the units used to describe the image sampling frequency (pixel density). Defines SVPS field number. Field referenced by this number contains scanned vertical pixel scale (SVPS), the vertical pixel density used for the scanning of the original impression. Defines VLL field number. Field referenced by this number contains contains vertical line length (VLL), the number of horizontal lines contained in the transmitted image. Defines VPS field number. Field referenced by this number contains vertical pixel scale (VPS), the integer pixel density used in the vertical direction of the transmitted image. see page 256) Defines maximal length of textual information associated with image contained in record. Defines the maximum value that field referenced by FieldHLL and FieldVLL can have. Defines maximal pixel scale value.
FIELD_SHPS (
see page 255)
FIELD_SLC (
see page 255)
FIELD_SVPS (
see page 255)
FIELD_VLL (
see page 256)
FIELD_VPS (
see page 256)
see page 256)
see page
see page 257)
see page Defines minimal scanned pixel scale value per centimeter for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal scanned pixel scale value per inch for latent images for prior ANSI-NIST standard versions implemented in ANTemplate ( see page 286). Defines minimal scanned pixel scale value per centimeter for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). 416
see page
see
8.1 Java Reference
see
Defines minimal scanned pixel scale value per inch for latent images in current ANSI-NIST standard version implemented in ANTemplate ( see page 286). Defines minimal pixel scale value per centimeter. Defines minimal pixel scale value per inch. Defines minimal scanned pixel scale value per centimeter. Defines minimal scanned pixel scale value per inch. Defines minimal length of vendor compression algorithm description.
see page 257)
see page 258)
see
MAX_PRINT_POSITION_COUNT ( see page 239) ANType8Record Class Name FIELD_SIG ( FIELD_SRT ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274) see page 419) see page 419)
Description Defines SIG field number. Field referenced by this number contains signature type. Defines SRT field number. Field referenced by this number contains signature representation type.
see page 275)
ANASCIIBinaryRecord Class Name getDate ( see page 219) getSourceAgency ( Description Gets field referenced by FieldDat field number. see page 220) Gets source agency identification. 417
8.1 Java Reference nativeTypeOf ( setDate (
see page 220)
Retrieves a function that retrieves NType object for the enclosing type. Sets field referenced by FieldDat field number.
see page 220)
setSourceAgency (
see page
see page 259)
see
see page 261)
ANFPImageASCIIBinaryRecord Class Name getImpressionType ( 239) getPositions ( getPrintPositions ( getQualityMetrics ( nativeTypeOf ( setImpressionType ( 240) ANType8Record Class Name getPenVectors ( see page 419) getSignatureRepresentationType ( see page 419) Description Gets particular pen vector from ANType8Record. Gets signature representation type. see page Description Gets the fingerprint impression type. Gets fingerprint positions contained in record. Gets fingerprint print positions contained in record. Retrieves a function that retrieves NType object for the enclosing type. Sets the fingerprint impression type.
see page 240)
418
8.1 Java Reference getSignatureType ( nativeTypeOf ( setSignatureType (
see page 419) Gets signature type. Retrieves a function that retrieves NType object for the enclosing type. see page 420) Sets signature type.
see page 420)

8.1.2.1.42.1.1 ANType8Record.PenVectorCollection Class
Represent collection of pen vectors. Java public final class PenVectorCollection extends NStructureCollection<ANPenVector, ANPenVectorData>; File ANType8Record.java

8.1.2.1.42.2.1 ANType8Record.FIELD_SIG Field
Defines SIG field number. Field referenced by this number contains signature type. Java public static final int FIELD_SIG = 3;
8.1.2.1.42.2.2 ANType8Record.FIELD_SRT Field

Defines SRT field number. Field referenced by this number contains signature representation type. Java public static final int FIELD_SRT = 4;

8.1.2.1.42.3.1 ANType8Record.getPenVectors Method
Gets particular pen vector from ANType8Record ( Java public PenVectorCollection getPenVectors(); Returns A PenVectorCollection ( see page 419) representing pen vectors from ANType8Record ( see page 414). see page 414).
8.1.2.1.42.3.2 ANType8Record.getSignatureRepresentationType Method

Gets signature representation type. Java public ANSignatureRepresentationType getSignatureRepresentationType(); Returns One of ANSignatureRepresentationType values.
8.1.2.1.42.3.3 ANType8Record.getSignatureType Method

Gets signature type.
419
public ANSignatureType getSignatureType(); Returns One of ANSignatureType values.

8.1.2.1.42.3.5 ANType8Record.setSignatureType Method

Sets signature type. Java public void setSignatureType(ANSignatureType value); Parameters Parameters ANSignatureType value Description One of ANSignatureType values.

Contain user-defined textual fields providing identification and descriptive information associated with the subject of the transaction. Data contained in this record conforms in format and content to the specifications of the domain name as listed in Domain Name field found in the Type-1 record. Java public final class ANType99Record extends ANASCIIBinaryRecord; File ANType99Record.java ANRecord Classes Name FieldCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC ( see page 272) see page 272) Description Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record. Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged. see page 271) Description Represent collection of subfields in field.
FIELD_LEN (
see page 273)
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( see page 273) Defines maximal number of fields in logical record.
420
8.1 Java Reference MAX_IDC ( see page 273)
Defines maximum value that image designation character (IDC) can obtain.
see page 219)
see page 219)
see
QUALITY_METRIC_SCORE_NOT_AVAILABLE Defines code when quality score has not been calculated or ( see page 219) provided for data contained in record object. ANType99Record Class Name FIELD_BCD ( FIELD_BDB ( FIELD_BDQ ( see page 422) see page 422) see page 422) Description Defines BCD field number. Field referenced by this number contains the date that the biometric sample was captured. Defines BDB field number. Field referenced by this number contains the CBEFF Biometric Data Block. Defines BDQ field number. Field referenced by this number contains aquality score data for the biometric data stored in the BDB field of this record. Defines BFO field number. Field referenced by this number contains the vendor, standards ( see page 214) body, working group, or industry consortium that has defined the format of the biometric data (in the BDB). Defines BFT field number. Field referenced by this number contains the value assigned by the format owner to represent the specific BDB format as specified by the format owner. Defines BFY field number. Field referenced by this number contains the type of biometric technology used. Defines HDV field number. Field referenced by this number contains the version of CBEFF specification that this record conforms. Defines older version of CBEFF specification. Defines current version of CBEFF specification (The current version of CBEFF is INCITS 398-2005).
FIELD_BFO (
see page 423)
FIELD_BFT (
see page 423)
FIELD_BTY ( FIELD_HDV (
see page 423) see page 423) see see
HEADER_VERSION_1_0 ( page 423) HEADER_VERSION_1_1 ( page 423) ANRecord Methods Name beginUpdate (
Description see page 273) Begins updating the record.
421
8.1 Java Reference endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 274)
Finishes updating the record. Gets ByteBuffer that contains data field of record. Gets particular fields from the ANRecord ( Gets idc of record. Gets record type. Checks if record is validated. Retrieves a function that retrieves NType object for the enclosing type. Sets data of the current ANRecord ( Sets idc of record. Gets record size. see page 270). see page 270).
see page 275)
see page 220)
setSourceAgency ( ANType99Record Class Name
Description see page see page see see Gets the identification of whom defined the format of biometric data. ets the format type assigned by the format owner to represent specific biometric data. Gets creation date of biometric sample. Gets the quality score of biometric data.
getBdbFormatOwner ( 423) getBdbFormatType ( 424)
getBiometricCreationDate ( page 424) getBiometricDataQuality ( page 424) getBiometricType ( getHeaderVersion ( nativeTypeOf (
see page 424) Gets type of biometric technology. see page 424) Gets version of CBEFF specification that this record conforms to. Retrieves a function that retrieves NType object for the enclosing type. Sets creation date of biometric sample. Sets the quality score of biometric data. see see
see page 424)
setBiometricCreationDate ( page 425) setBiometricDataQuality ( page 425)

8.1.2.1.43.1.1 ANType99Record.FIELD_BCD Field
Defines BCD field number. Field referenced by this number contains the date that the biometric sample was captured. Java public static final int FIELD_BCD = FIELD_DAT;
8.1.2.1.43.1.2 ANType99Record.FIELD_BDB Field

Defines BDB field number. Field referenced by this number contains the CBEFF Biometric Data Block. Java public static final int FIELD_BDB = FIELD_DATA;
8.1.2.1.43.1.3 ANType99Record.FIELD_BDQ Field

Defines BDQ field number. Field referenced by this number contains aquality score data for the biometric data stored in the 422
8.1 Java Reference BDB field of this record. Java
public static final int FIELD_BDQ = 102;
8.1.2.1.43.1.4 ANType99Record.FIELD_BFO Field

Defines BFO field number. Field referenced by this number contains the vendor, standards ( group, or industry consortium that has defined the format of the biometric data (in the BDB). Java public static final int FIELD_BFO = 103; see page 214) body, working
8.1.2.1.43.1.5 ANType99Record.FIELD_BFT Field

Defines BFT field number. Field referenced by this number contains the value assigned by the format owner to represent the specific BDB format as specified by the format owner. Java public static final int FIELD_BFT = 104;
8.1.2.1.43.1.6 ANType99Record.FIELD_BTY Field

Defines BFY field number. Field referenced by this number contains the type of biometric technology used. Java public static final int FIELD_BTY = 101;
8.1.2.1.43.1.7 ANType99Record.FIELD_HDV Field

Defines HDV field number. Field referenced by this number contains the version of CBEFF specification that this record conforms. Java public static final int FIELD_HDV = 100;
8.1.2.1.43.1.8 ANType99Record.HEADER_VERSION_1_0 Field

Defines older version of CBEFF specification. Java public static final NVersion HEADER_VERSION_1_0 = new NVersion((short) 0x0100);
8.1.2.1.43.1.9 ANType99Record.HEADER_VERSION_1_1 Field

Defines current version of CBEFF specification (The current version of CBEFF is INCITS 398-2005). Java public static final NVersion HEADER_VERSION_1_1 = new NVersion((short) 0x0101);

8.1.2.1.43.2.1 ANType99Record.getBdbFormatOwner Method
Gets the identification of whom defined the format of biometric data. Java public short getBdbFormatOwner(); Returns Number containing identification of format owner.
423
8.1 Java Reference
8.1.2.1.43.2.2 ANType99Record.getBdbFormatType Method

ets the format type assigned by the format owner to represent specific biometric data. Java public short getBdbFormatType(); Returns Number containing format type.
8.1.2.1.43.2.3 ANType99Record.getBiometricCreationDate Method

Gets creation date of biometric sample. Java public Date getBiometricCreationDate(); Returns Date object.
8.1.2.1.43.2.4 ANType99Record.getBiometricDataQuality Method

Gets the quality score of biometric data. Java public ANQualityMetric getBiometricDataQuality(); Returns One of ANQualityMetric ( see page 268) values.
8.1.2.1.43.2.5 ANType99Record.getBiometricType Method

Gets type of biometric technology. Java public EnumSet<ANBiometricType> getBiometricType(); Returns One of ANBiometricType values.
8.1.2.1.43.2.6 ANType99Record.getHeaderVersion Method

Gets version of CBEFF specification that this record conforms to. Java public NVersion getHeaderVersion(); Returns One of NVersion values.

424
8.1 Java Reference
8.1.2.1.43.2.8 ANType99Record.setBiometricCreationDate Method

Sets creation date of biometric sample. Java public void setBiometricCreationDate(Date value); Parameters Parameters Date value Description Date value.
8.1.2.1.43.2.9 ANType99Record.setBiometricDataQuality Method

Sets the quality score of biometric data. Java public void setBiometricDataQuality(ANQualityMetric value); Parameters Parameters ANQualityMetric value Description One of ANQualityMetric ( see page 268) values.

Provides functions for working with Minutiae data record. Java public final class ANType9Record extends ANASCIIRecord; File ANType9Record.java ANRecord Classes Name FieldCollection ( ANType9Record Class Name CoreCollection ( DeltaCollection ( MinutiaCollection ( see page 428) see page 428) see page 428) see Description Represent collection of cores. Represent collection of deltas. Represent collection of minutiaes. Represent collection of minutiae neighbors. see page 271) Description Represent collection of subfields in field.
MinutiaNeighborsCollection ( page 428) PatternClassCollection ( 428) PositionCollection ( ANRecord Fields Name FIELD_DATA ( FIELD_IDC (
see page Represent collection of pattern classes.
see page 429) Represent collection of fingerprint positions.
Description see page 272) see page 272) Defines Image data (DATA) contained in logical record. This field is identifies the user-defined text information contained in the record. The IDC (image designation character) contained in field shall be the IDC of the Type-2 logical record as found in the file content (CNT) field of the Type-1 record. Describes total count of the number of bytes in logical record.
FIELD_LEN (
see page 273)
425
8.1 Java Reference
Flag used to merge duplicate fields in a record (file). If this flag is not used duplicate fields are nor merged.
FLAG_RECOVER_FROM_BINARY_DATA Flag used to recover from binary data in some buggy files during ( see page 273) read. MAX_FIELD_NUMBER ( MAX_IDC ( ANASCIIRecord Class Name MAX_FIELD_NUMBER ( page 221) ANType9Record Class Name FIELD_ALL_FROM ( FIELD_ALL_TO ( FIELD_CRP ( FIELD_DLT ( FIELD_FGP ( FIELD_FMT ( FIELD_FPC ( see page 429) Description Defines the starting filed of a common block of tagged fields. Defines the ending filed number of a common block of tagged fields. Defines CRP field number. Field referenced by this number contains core position (CRP) value. Defines DLT field number. Field referenced by this number contains delta(s) position (DLT). Defines FGP field number. Field referenced by this number contains finger position (FGP) value. Defines FMT field number. Field referenced by this number contains minutiae format (FMT) value. Defines FPC field number. Field referenced by this number contains fingerprint pattern classification (FPC) value. Defines IMP field number. Field referenced by this number contains impression type (IMP) value. Defines MIN field number. Field referenced by this number contains number of minutiae (MIN). Defines MRC field number. Field referenced by this number contains minutiae and ridge count data (MRC). Defines OFR field number. Field referenced by this number contains originating fingerprint reading system (OFR) value. Defines RDG field number. Field referenced by this number contains minutiae ridge count indicator (RDG) value. see Description Defines maximum quantity of fields in record of Type-1, Type-2 and Type-9. see page 273) Defines maximal number of fields in logical record. Defines maximum value that image designation character (IDC) can obtain. see page 273)
see page 429)
FIELD_IMP ( FIELD_MIN ( FIELD_MRC ( FIELD_OFR (
FIELD_RDG (
see page 430)
FIELD_STANDARD_FORMAT_FEATURES_FROM Defines the starting filed of a standard format features ( see page 430) block. FIELD_STANDARD_FORMAT_FEATURES_TO ( see page 430) FIELD_VENDOR_DEFINED_FEATURES_FROM ( see page 431) FIELD_VENDOR_DEFINED_FEATURES_TO ( see page 431) MAX_FINGERPRINT_X ( MAX_FINGERPRINT_Y ( MAX_PALMPRINT_X ( MAX_PALMPRINT_Y ( see page 431) see page 431) Defines the ending filed of a standard format features block. Defines the starting filed of a vendor defined features block. Defines the ending filed of a vendor defined features block. Defines maximum fingerprint X coordinate. Defines maximum fingerprint Y coordinate. Defines maximum palmprint X coordinate. Defines maximum palmprint Y coordinate. Defines greatest confidence in minutia quality.
MINUTIA_QUALITY_BEST (
426
8.1 Java Reference
MINUTIA_QUALITY_MANUAL (
see page 431) see
Defines that minutia has been encoded manually. Defines that no method of indicating a confidence level is available. Defines worst confidence in minutia quality.
MINUTIA_QUALITY_NOT_AVAILABLE ( page 431) MINUTIA_QUALITY_WORST ( ANRecord Methods Name beginUpdate ( endUpdate ( getData ( getFields ( getIdc ( see page 273) see page 273) see page 274) see page 274) see page 274)
see page 431)
see page 275)
ANASCIIRecord Class Name nativeTypeOf ( ANType9Record Class Name getCores ( getDeltas ( see page 432) see page 432) see page Description Gets particular core from ANType9Record. Gets particular delta from ANType9Record. Gets the impression type value. Gets particular minutiae from ANType9Record. Gets particular minutiae neighbors from ANType9Record. Gets originating fingerprint reading system equipment name. Gets the method by which the minutiae data was read, encoded, and recorded. Gets originating fingerprint reading system name. Gets particular fingerprint position from ANType9Record. Checks if ANType9Record contains minutiae. Check if minutia has ridge counts data. see see page 222) Description Retrieves a function that retrieves NType object for the enclosing type.
getImpressionType ( 432) getMinutiae (
getMinutiaeNeighbors ( 432) getOFRSEquipment ( 432) getOFRSMethod ( getOFRSName ( getPositions ( isHasMinutiae (
getPatternClasses (
see page 433) Gets particular pattern class from ANType9Record.
isHasMinutiaeRidgeCounts ( page 434)
isHasMinutiaeRidgeCountsIndicator Check if minutia has ridge counts indicator field. ( see page 434) isMinutiaFormat ( nativeTypeOf ( see page 434) see page Gets minutiae format values. Retrieves a function that retrieves NType object for the enclosing type. Sets the impression type value. Sets value for the originating fingerprint reading system. Transforms ANType9Record minutiae data record to NFRecord ( page 110). see see page 434)
setImpressionType ( 434) setOFRS ( toNFRecord (
427
8.1 Java Reference

8.1.2.1.44.1.1 ANType9Record.CoreCollection Class
Represent collection of cores. Java public final class CoreCollection extends NStructureCollection<ANFCore, ANFCoreData>; File ANType9Record.java
8.1.2.1.44.1.2 ANType9Record.DeltaCollection Class

Represent collection of deltas. Java public final class DeltaCollection extends NStructureCollection<ANFDelta, ANFDeltaData>; File ANType9Record.java
8.1.2.1.44.1.3 ANType9Record.MinutiaCollection Class

Represent collection of minutiaes. Java public final class MinutiaCollection extends NStructureCollection<ANFPMinutia, ANFPMinutiaData>; File ANType9Record.java
8.1.2.1.44.1.4 ANType9Record.MinutiaNeighborsCollection Class

Represent collection of minutiae neighbors. Java public final class MinutiaNeighborsCollection extends NStructureArrayCollection<BDIFFPMinutiaNeighbor, BDIFFPMinutiaNeighborData, ANFPMinutia>; File ANType9Record.java
8.1.2.1.44.1.5 ANType9Record.PatternClassCollection Class

Represent collection of pattern classes. Java public final class PatternClassCollection extends NStructureCollection<ANFPatternClass, ANFPatternClassData>; File ANType9Record.java PatternClassCollection Methods Name add ( see page 429) Description Adds fingerprint pattern class to PatternClassCollection.
428
8.1 Java Reference
8.1.2.1.44.1.5.1 PatternClassCollection Methods 8.1.2.1.44.1.5.1.1 ANType9Record.PatternClassCollection.add Method

Adds fingerprint pattern class to PatternClassCollection ( Java public boolean add(BDIFFPatternClass value, String vendorValue); Parameters Parameters BDIFFPatternClass value String vendorValue Returns Number of pattern classes in PatternClassCollection ( see page 428). Description One of BdifFPatternClass values. Sting containing pattern class description. see page 428).
8.1.2.1.44.1.6 ANType9Record.PositionCollection Class

Represent collection of fingerprint positions. Java public final class PositionCollection extends NEnumCollection<BDIFFPPosition>; File ANType9Record.java

8.1.2.1.44.2.1 ANType9Record.FIELD_ALL_FROM Field
Defines the starting filed of a common block of tagged fields. Java public static final int FIELD_ALL_FROM = FIELD_LEN;
8.1.2.1.44.2.2 ANType9Record.FIELD_ALL_TO Field

Defines the ending filed number of a common block of tagged fields. Java public static final int FIELD_ALL_TO = FIELD_FMT;
8.1.2.1.44.2.3 ANType9Record.FIELD_CRP Field

Defines CRP field number. Field referenced by this number contains core position (CRP) value. Java public static final int FIELD_CRP = 8;
8.1.2.1.44.2.4 ANType9Record.FIELD_DLT Field

Defines DLT field number. Field referenced by this number contains delta(s) position (DLT). Java public static final int FIELD_DLT = 9;
8.1.2.1.44.2.5 ANType9Record.FIELD_FGP Field

Defines FGP field number. Field referenced by this number contains finger position (FGP) value.
429
public static final int FIELD_FGP = 6;
8.1.2.1.44.2.6 ANType9Record.FIELD_FMT Field

Defines FMT field number. Field referenced by this number contains minutiae format (FMT) value. Java public static final int FIELD_FMT = 4;
8.1.2.1.44.2.7 ANType9Record.FIELD_FPC Field

Defines FPC field number. Field referenced by this number contains fingerprint pattern classification (FPC) value. Java public static final int FIELD_FPC = 7;
8.1.2.1.44.2.8 ANType9Record.FIELD_IMP Field

Defines IMP field number. Field referenced by this number contains impression type (IMP) value. Java public static final int FIELD_IMP = 3;
8.1.2.1.44.2.9 ANType9Record.FIELD_MIN Field

Defines MIN field number. Field referenced by this number contains number of minutiae (MIN). Java public static final int FIELD_MIN = 10;
8.1.2.1.44.2.10 ANType9Record.FIELD_MRC Field

Defines MRC field number. Field referenced by this number contains minutiae and ridge count data (MRC). Java public static final int FIELD_MRC = 12;
8.1.2.1.44.2.11 ANType9Record.FIELD_OFR Field

Defines OFR field number. Field referenced by this number contains originating fingerprint reading system (OFR) value. Java public static final int FIELD_OFR = 5;
8.1.2.1.44.2.12 ANType9Record.FIELD_RDG Field

Defines RDG field number. Field referenced by this number contains minutiae ridge count indicator (RDG) value. Java public static final int FIELD_RDG = 11;
8.1.2.1.44.2.13 ANType9Record.FIELD_STANDARD_FORMAT_FEATURES_FROM Field

Defines the starting filed of a standard format features block. Java public static final int FIELD_STANDARD_FORMAT_FEATURES_FROM = FIELD_OFR;
8.1.2.1.44.2.14 ANType9Record.FIELD_STANDARD_FORMAT_FEATURES_TO Field

Defines the ending filed of a standard format features block. Java public static final int FIELD_STANDARD_FORMAT_FEATURES_TO = FIELD_MRC; 430
8.1 Java Reference
8.1.2.1.44.2.15 ANType9Record.FIELD_VENDOR_DEFINED_FEATURES_FROM Field

Defines the starting filed of a vendor defined features block. Java public static final int FIELD_VENDOR_DEFINED_FEATURES_FROM = (FIELD_MRC + 1);
8.1.2.1.44.2.16 ANType9Record.FIELD_VENDOR_DEFINED_FEATURES_TO Field

Defines the ending filed of a vendor defined features block. Java public static final int FIELD_VENDOR_DEFINED_FEATURES_TO = MAX_FIELD_NUMBER;
8.1.2.1.44.2.17 ANType9Record.MAX_FINGERPRINT_X Field

Defines maximum fingerprint X coordinate. Java public static final int MAX_FINGERPRINT_X = 4999;
8.1.2.1.44.2.18 ANType9Record.MAX_FINGERPRINT_Y Field

Defines maximum fingerprint Y coordinate. Java public static final int MAX_FINGERPRINT_Y = 4999;
8.1.2.1.44.2.19 ANType9Record.MAX_PALMPRINT_X Field

Defines maximum palmprint X coordinate. Java public static final int MAX_PALMPRINT_X = 13999;
8.1.2.1.44.2.20 ANType9Record.MAX_PALMPRINT_Y Field

Defines maximum palmprint Y coordinate. Java public static final int MAX_PALMPRINT_Y = 20999;
8.1.2.1.44.2.21 ANType9Record.MINUTIA_QUALITY_BEST Field

Defines greatest confidence in minutia quality. Java public static final int MINUTIA_QUALITY_BEST = 2;
8.1.2.1.44.2.22 ANType9Record.MINUTIA_QUALITY_MANUAL Field

Defines that minutia has been encoded manually. Java public static final int MINUTIA_QUALITY_MANUAL = 0;
8.1.2.1.44.2.23 ANType9Record.MINUTIA_QUALITY_NOT_AVAILABLE Field

Defines that no method of indicating a confidence level is available. Java public static final int MINUTIA_QUALITY_NOT_AVAILABLE = 1;
8.1.2.1.44.2.24 ANType9Record.MINUTIA_QUALITY_WORST Field

Defines worst confidence in minutia quality. 431
public static final int MINUTIA_QUALITY_WORST = 63;

8.1.2.1.44.3.1 ANType9Record.getCores Method
Gets particular core from ANType9Record ( Java public CoreCollection getCores(); Returns A CoreCollection ( see page 428) representing cores in ANType9Record ( see page 425). see page 425).
8.1.2.1.44.3.2 ANType9Record.getDeltas Method

Gets particular delta from ANType9Record ( Java public DeltaCollection getDeltas(); Returns A DeltaCollection ( see page 428) representing deltas in ANType9Record ( see page 425). see page 425).
8.1.2.1.44.3.3 ANType9Record.getImpressionType Method

Gets the impression type value. Java public BDIFFPImpressionType getImpressionType(); Returns One of BDIFFPImpressionType values.
8.1.2.1.44.3.4 ANType9Record.getMinutiae Method

Gets particular minutiae from ANType9Record ( Java public MinutiaCollection getMinutiae(); Returns A MinutiaCollection ( see page 428) that contains minutiae. see page 425).
8.1.2.1.44.3.5 ANType9Record.getMinutiaeNeighbors Method

Gets particular minutiae neighbors from ANType9Record ( Java public MinutiaNeighborsCollection getMinutiaeNeighbors(); Returns A MinutiaNeighborsCollection ( see page 428) representing minutiae neighbors in ANType9Record ( see page 425). see page 425).
8.1.2.1.44.3.6 ANType9Record.getOFRSEquipment Method

Gets originating fingerprint reading system equipment name.
432
public String getOFRSEquipment(); Returns String containing originating fingerprint reading system equipment name.
8.1.2.1.44.3.7 ANType9Record.getOFRSMethod Method

Gets the method by which the minutiae data was read, encoded, and recorded. Java public ANFPMinutiaeMethod getOFRSMethod(); Returns One of ANFPMinutiaeMethod values.
8.1.2.1.44.3.8 ANType9Record.getOFRSName Method

Gets originating fingerprint reading system name. Java public String getOFRSName(); Returns String containing originating fingerprint reading system name.
8.1.2.1.44.3.9 ANType9Record.getPatternClasses Method

Gets particular pattern class from ANType9Record ( Java public PatternClassCollection getPatternClasses(); Returns A PatternClassCollection ( see page 428) representing pattern class in ANType9Record ( see page 425). see page 425).
8.1.2.1.44.3.10 ANType9Record.getPositions Method

Gets particular fingerprint position from ANType9Record ( Java public PositionCollection getPositions(); Returns A PositionCollection ( see page 429) representing fingerprint positions in ANType9Record ( see page 425). see page 425).
8.1.2.1.44.3.11 ANType9Record.isHasMinutiae Method

Checks if ANType9Record ( Java public boolean isHasMinutiae(); Returns true if contains minutiae, false otherwise. see page 425) contains minutiae.
433
8.1 Java Reference
8.1.2.1.44.3.12 ANType9Record.isHasMinutiaeRidgeCounts Method

Check if minutia has ridge counts data. Java public boolean isHasMinutiaeRidgeCounts(); Returns true if minutia has ridge counts data, false otherwise.
8.1.2.1.44.3.13 ANType9Record.isHasMinutiaeRidgeCountsIndicator Method

Check if minutia has ridge counts indicator field. Java public boolean isHasMinutiaeRidgeCountsIndicator(); Returns true if record has ridge counts indicator field, false otherwise.
8.1.2.1.44.3.14 ANType9Record.isMinutiaFormat Method

Gets minutiae format values. Java public boolean isMinutiaFormat(); Returns true if minutia format is standard, false otherwise.

8.1.2.1.44.3.16 ANType9Record.setImpressionType Method

Sets the impression type value. Java public void setImpressionType(BDIFFPImpressionType type);
434
8.1 Java Reference Parameters Parameters BDIFFPImpressionType type
Description One of BDIFFPImpressionType values.
8.1.2.1.44.3.17 ANType9Record.setOFRS Method

Sets value for the originating fingerprint reading system. Java public void setOFRS(String name, ANFPMinutiaeMethod method, String equipment); Parameters Parameters String name ANFPMinutiaeMethod method String equipment Description String containing originating fingerprint reading name. One of ANFPMinutiaeMethod values. String containing the originating fingerprint reading system equipment name.
8.1.2.1.44.3.18 toNFRecord Method 8.1.2.1.44.3.18.1 ANType9Record.toNFRecord Method ()

Transforms ANType9Record ( Java public NFRecord toNFRecord(); Returns NFRecord ( see page 110) object. see page 425) minutiae data record to NFRecord ( see page 110).
8.1.2.1.44.3.18.2 ANType9Record.toNFRecord Method (int)

Transforms ANType9Record ( Java public NFRecord toNFRecord(int flags); Parameters Parameters int flags Returns NFRecord ( see page 110) object. Description Must be zero. see page 425) minutiae data record to NFRecord ( see page 110).
8.1.2.1.45 BDIFFaceFeaturePoint Class

Provides properties for getting and setting face feature point. Java public final class BDIFFaceFeaturePoint; File BDIFFaceFeaturePoint.java
435
8.1 Java Reference Methods Name BDIFFaceFeaturePoint ( page 436) BDIFFaceFeaturePoint Fields Name code ( type ( x( y( see page 436) see page 437)
Description see Initializes a new instance of the BDIFFaceFeaturePoint class.
Description Code. Type of face feature point. X coordinate of the face feature point. Y coordinate of the face feature point.
8.1.2.1.45.1 BDIFFaceFeaturePoint Constructor

8.1.2.1.45.1.1 BDIFFaceFeaturePoint.BDIFFaceFeaturePoint Constructor ()
Initializes a new instance of the BDIFFaceFeaturePoint class. Java public BDIFFaceFeaturePoint();
8.1.2.1.45.1.2 BDIFFaceFeaturePoint.BDIFFaceFeaturePoint Constructor (BDIFFaceFeaturePointType, byte, short, short)

Initializes a new instance of the BDIFFaceFeaturePoint class. Java public BDIFFaceFeaturePoint(BDIFFaceFeaturePointType type, byte code, short x, short y); Parameters Parameters BDIFFaceFeaturePointType type byte code short x short y Description type ( code ( x( y( see page 437) of face feature point. see page 436).
see page 437) coordinate of the face feature point. see page 437) coordinate of the face feature point.
8.1.2.1.45.1.3 BDIFFaceFeaturePoint.BDIFFaceFeaturePoint Constructor (byte, short, short)

Initializes a new instance of the BDIFFaceFeaturePoint class. Java public BDIFFaceFeaturePoint(byte code, short x, short y); Parameters Parameters byte code short x short y Description code ( x( y( see page 436). see page 437) coordinate of the face feature point. see page 437) coordinate of the face feature point.
8.1.2.1.45.2 BDIFFaceFeaturePoint Fields

8.1.2.1.45.2.1 BDIFFaceFeaturePoint.code Field
Code.
436
8.1 Java Reference Java public byte code;
8.1.2.1.45.2.2 BDIFFaceFeaturePoint.type Field

Type of face feature point. Java public BDIFFaceFeaturePointType type;
8.1.2.1.45.2.3 BDIFFaceFeaturePoint.x Field

X coordinate of the face feature point. Java public short x;
8.1.2.1.45.2.4 BDIFFaceFeaturePoint.y Field

Y coordinate of the face feature point. Java public short y;
8.1.2.1.46 BDIFFPMinutiaNeighbor Class

Provides properties for getting and setting fingerprint minutia neighbor. Java public final class BDIFFPMinutiaNeighbor; File BDIFFPMinutiaNeighbor.java Methods Name BDIFFPMinutiaNeighbor ( page 437) BDIFFPMinutiaNeighbor Fields Name EMPTY ( index ( see page 438) see page 438) see page 438) Description This field is used for an empty BDIFFPMinutiaNeighbor object. The index of minutia neighbor. The ridge count between the minutia and minutia neighbor. see Description Initializes a new instance of the BDIFFPMinutiaNeighbor class.
ridgeCount (
8.1.2.1.46.1 BDIFFPMinutiaNeighbor Constructor

8.1.2.1.46.1.1 BDIFFPMinutiaNeighbor.BDIFFPMinutiaNeighbor Constructor ()
Initializes a new instance of the BDIFFPMinutiaNeighbor class. Java public BDIFFPMinutiaNeighbor();
8.1.2.1.46.1.2 BDIFFPMinutiaNeighbor.BDIFFPMinutiaNeighbor Constructor (int, byte)

Initializes a new instance of the BDIFFPMinutiaNeighbor class. Java public BDIFFPMinutiaNeighbor(int index, byte ridgeCount); 437
8.1 Java Reference Parameters Parameters int index byte ridgeCount
Description The index ( see page 438) of neighbor. The ridge count of neighbor.
8.1.2.1.46.2 BDIFFPMinutiaNeighbor Fields

8.1.2.1.46.2.1 BDIFFPMinutiaNeighbor.EMPTY Field
This field is used for an empty BDIFFPMinutiaNeighbor ( Java public static final BDIFFPMinutiaNeighbor EMPTY = new BDIFFPMinutiaNeighbor(-1, (byte) 255); see page 437) object.
8.1.2.1.46.2.2 BDIFFPMinutiaNeighbor.index Field

The index of minutia neighbor. Java public int index;
8.1.2.1.46.2.3 BDIFFPMinutiaNeighbor.ridgeCount Field

The ridge count between the minutia and minutia neighbor. Java public byte ridgeCount;
8.1.2.1.47 CBEFFBDBFormatIdentifiers Class

Specifies CBEFF Biometric Data Block (BDB) Format identifiers registered with International Biometric Industry Association (IBIA). Java public class CBEFFBDBFormatIdentifiers; File CBEFFBDBFormatIdentifiers.java CBEFFBDBFormatIdentifiers Fields Name D e s c r i p t i o n
8.1.2.1.47.1 CBEFFBDBFormatIdentifiers Fields

8.1.2.1.47.1.1 CBEFFBDBFormatIdentifiers.BIOLOGICA_SISTEMAS_ISO_19794_2_BIOUNISTATION Field
The CBEFF DBD format identifier assigned to BioLogica Sistemas Ltda ISO 19794-2/BioUniStation format. Java public static final int BIOLOGICA_SISTEMAS_ISO_19794_2_BIOUNISTATION = 0x0002; 438
8.1 Java Reference

The CBEFF DBD format identifier assigned to BioLogica Sistemas Ltda ISO 19794-4/BioUniStation format. Java public static final int BIOLOGICA_SISTEMAS_ISO_19794_4_BIOUNISTATION = 0x0004;

The CBEFF DBD format identifier assigned to BioLogica Sistemas Ltda ISO 19794-5/BioUniStation format. Java public static final int BIOLOGICA_SISTEMAS_ISO_19794_5_BIOUNISTATION = 0x0005;
8.1.2.1.47.1.4 CBEFFBDBFormatIdentifiers.FEDERAL_OFFICE_FOR_INFORMATION_SECURITY_TR_BIOMETRICS_XML_ FACE_1_0 Field

The CBEFF DBD format identifier assigned to Federal Office for Information Security (BSI) TR Biometrics XML-Face 1.0 format. Java public static final int FEDERAL_OFFICE_FOR_INFORMATION_SECURITY_TR_BIOMETRICS_XML_FACE_1_0 = 0x0001;
8.1.2.1.47.1.5 CBEFFBDBFormatIdentifiers.FEDERAL_OFFICE_FOR_INFORMATION_SECURITY_TR_BIOMETRICS_XML_ FINGER_1_0 Field

The CBEFF DBD format identifier assigned to Federal Office for Information Security (BSI) TR Biometrics XML-Finger 1.0 format. Java public static final int FEDERAL_OFFICE_FOR_INFORMATION_SECURITY_TR_BIOMETRICS_XML_FINGER_1_0 = 0x0002;
8.1.2.1.47.1.6 CBEFFBDBFormatIdentifiers.ID3_SEMICONDUCTORS_COMPACT_CARD_EXTENSION Field

The CBEFF DBD format identifier assigned to id3 Semiconductors compact card extension format. Java public static final int ID3_SEMICONDUCTORS_COMPACT_CARD_EXTENSION = 0x0001;
8.1.2.1.47.1.7 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_AVI_MEDIA Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics AVI media file format. Java public static final int INCITS_TC_M1_BIOMETRICS_AVI_MEDIA = 0x800B;
8.1.2.1.47.1.8 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_BIOMETRIC_FUSION_DATA Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Biometric Fusion Data Format. Java public static final int INCITS_TC_M1_BIOMETRICS_BIOMETRIC_FUSION_DATA = 0x0901;
8.1.2.1.47.1.9 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_BMP_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Microsoft Windows bitmap image format.
439
public static final int INCITS_TC_M1_BIOMETRICS_BMP_IMAGE = 0x8002;
8.1.2.1.47.1.10 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_EBTS Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Electronic Biometric Transmission Specification (EBTS) format. Java public static final int INCITS_TC_M1_BIOMETRICS_EBTS = 0x8019;
8.1.2.1.47.1.11 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_FACE_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Face Image Format. Java public static final int INCITS_TC_M1_BIOMETRICS_FACE_IMAGE = 0x0501;
8.1.2.1.47.1.12 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_FINGER_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Finger Image format. Java public static final int INCITS_TC_M1_BIOMETRICS_FINGER_IMAGE = 0x0401;
8.1.2.1.47.1.13 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_N Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Finger Minutiae format - no extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_N = 0x0201;
8.1.2.1.47.1.14 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_U Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Finger Minutiae format presence of extended data unspecified. Java public static final int INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_U = 0x0203;
8.1.2.1.47.1.15 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_X Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Finger Minutiae Format - with extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_X = 0x0202;
8.1.2.1.47.1.16 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_FINGER_PATTERN_N Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Finger Pattern format - no extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_FINGER_PATTERN_N = 0x0301;
8.1.2.1.47.1.17 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_GENERIC_FBI_EFTS_RECORD Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Generic FBI EFTS record format.
440
public static final int INCITS_TC_M1_BIOMETRICS_GENERIC_FBI_EFTS_RECORD = 0x8014;
8.1.2.1.47.1.18 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_GIF89A_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics CompuServe GIF89a image format. Java public static final int INCITS_TC_M1_BIOMETRICS_GIF89A_IMAGE = 0x8006;
8.1.2.1.47.1.19 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_HAND_GEOMETRY_N Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Hand Geometry format - no extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_HAND_GEOMETRY_N = 0x0801;
8.1.2.1.47.1.20 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_HAND_GEOMETRY_X Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Hand Geometry format - with extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_HAND_GEOMETRY_X = 0x0802;
8.1.2.1.47.1.21 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_IRIS_POLAR Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Iris Format - polar. Java public static final int INCITS_TC_M1_BIOMETRICS_IRIS_POLAR = 0x0602;
8.1.2.1.47.1.22 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_IRIS_RECTILINEAR Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Iris Format - rectilinear. Java public static final int INCITS_TC_M1_BIOMETRICS_IRIS_RECTILINEAR = 0x0601;
8.1.2.1.47.1.23 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_JPEG_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics JPEG image format. Java public static final int INCITS_TC_M1_BIOMETRICS_JPEG_IMAGE = 0x8003;
8.1.2.1.47.1.24 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_JPEG2000_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics JPEG2000 image format. Java public static final int INCITS_TC_M1_BIOMETRICS_JPEG2000_IMAGE = 0x8004;
8.1.2.1.47.1.25 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_MPEG_MEDIA Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics MPEG media file format. Java public static final int INCITS_TC_M1_BIOMETRICS_MPEG_MEDIA = 0x8009;
8.1.2.1.47.1.26 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_MPEG1_PART_3_MEDIA Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics MPEG1 Part 3 media file format. 441
public static final int INCITS_TC_M1_BIOMETRICS_MPEG1_PART_3_MEDIA = 0x800A;
8.1.2.1.47.1.27 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_NIEM Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics National Information Exchange Model format. Java public static final int INCITS_TC_M1_BIOMETRICS_NIEM = 0x8015;
8.1.2.1.47.1.28 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE_10_RECORD Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics NIST-ITL 1-2000 Type 10 record format. Java public static final int INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE_10_RECORD = 0x800E;

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics NIST-ITL 1-2000 Type 13 record format. Java public static final int INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE_13_RECORD = 0x800F;

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics NIST-ITL 1-2000 Type 14 record format. Java public static final int INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE_14_RECORD = 0x8010;



The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics NIST-ITL 1-2000 Type 4 record format.
442
public static final int INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE_4_RECORD = 0x800D;
8.1.2.1.47.1.34 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_200X_RECORD_COLLECTION_FO R_TENPRINT_CAPTURE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics NIST-ITL 1-200x record collection for TenPrint Capture format. Java public static final int INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_200X_RECORD_COLLECTION_FOR_TENPRINT_CAPTURE = 0x8013;
8.1.2.1.47.1.35 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_NIST_ITL1_2007_TYPE_10_RECORD Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics NIST-ITL 1-2007 Type 10 record format. Java public static final int INCITS_TC_M1_BIOMETRICS_NIST_ITL1_2007_TYPE_10_RECORD = 0x8016;


8.1.2.1.47.1.38 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_PNG_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Portable Network Graphics (PNG) data format. Java public static final int INCITS_TC_M1_BIOMETRICS_PNG_IMAGE = 0x8007;
8.1.2.1.47.1.39 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_COMMON_FEATURE_DAT A_N Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Signature/Sign format Common feature data - no extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_COMMON_FEATURE_DATA_N = 0x0703;
443
8.1 Java Reference
8.1.2.1.47.1.40 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_COMMON_FEATURE_DAT A_X Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Signature/Sign format Common feature data - with extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_COMMON_FEATURE_DATA_X = 0x0704;
8.1.2.1.47.1.41 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_AND_COMMON_FEA TURE_DATA_N Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Signature/Sign format - both Raw and Common feature data - no extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_AND_COMMON_FEATURE_DATA_N = 0x0705;
8.1.2.1.47.1.42 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_AND_COMMON_FEA TURE_DATA_X Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Signature/Sign format - both Raw and Common feature data - with extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_AND_COMMON_FEATURE_DATA_X = 0x0706;
8.1.2.1.47.1.43 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_DATA_N Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Signature/Sign format - Raw data - no extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_DATA_N = 0x0701;
8.1.2.1.47.1.44 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_DATA_X Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics Signature/Sign format - Raw data - with extended data. Java public static final int INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RAW_DATA_X = 0x0702;
8.1.2.1.47.1.45 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_TIFF_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics TIFF image format. Java public static final int INCITS_TC_M1_BIOMETRICS_TIFF_IMAGE = 0x8005;
444
8.1 Java Reference
8.1.2.1.47.1.46 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_VRML_3D_OBJECT_DATA Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics VRML 3D object data format. Java public static final int INCITS_TC_M1_BIOMETRICS_VRML_3D_OBJECT_DATA = 0x800C;
8.1.2.1.47.1.47 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_WAV_AUDIO Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics WAV audio file format. Java public static final int INCITS_TC_M1_BIOMETRICS_WAV_AUDIO = 0x8008;
8.1.2.1.47.1.48 CBEFFBDBFormatIdentifiers.INCITS_TC_M1_BIOMETRICS_WSQ_IMAGE Field

The CBEFF DBD format identifier assigned to INCITS Technical Committee M1 - Biometrics WSQ compressed fingerprint image format. Java public static final int INCITS_TC_M1_BIOMETRICS_WSQ_IMAGE = 0x8001;
8.1.2.1.47.1.49 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_27_IT_SECURITY_TECHNIQUES_BIOMETRIC_REFEREN CE_TEMPLATE_CERTIFICATE Field

The CBEFF DBD format identifier assigned biometric-reference-template-certificate format. Java public static final int ISO_IEC_JTC_1_SC_27_IT_SECURITY_TECHNIQUES_BIOMETRIC_REFERENCE_TEMPLATE_CERTIFICATE = 0x0001; to ISO/IEC JTC 1 SC 27 IT Security techniques
8.1.2.1.47.1.50 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FACE_IMAGE Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics face-image format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FACE_IMAGE = 0x0008;
8.1.2.1.47.1.51 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_IMAGE Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-image format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_IMAGE = 0x0007;
8.1.2.1.47.1.52 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT _N Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-card-compact-n format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT_N = 0x0006;
445
8.1 Java Reference
8.1.2.1.47.1.53 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT _R_H Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-card-compact-r-h format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT_R_H = 0x001A;
8.1.2.1.47.1.54 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT _V Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-card-compact-v format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT_V = 0x0005;
8.1.2.1.47.1.55 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT _V_H Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-card-compact-v-h format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_COMPACT_V_H = 0x0019;
8.1.2.1.47.1.56 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_ N Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-card-normal-n format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_N = 0x0004;
8.1.2.1.47.1.57 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_ R_NH Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37-Biometrics finger-minutiae-card-normal-r-nh format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_R_NH = 0x001C;
8.1.2.1.47.1.58 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_ V Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-card-normal-v format.
446
public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_V = 0x0003;
8.1.2.1.47.1.59 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_ V_NH Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-card-normal-v-nh format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_CARD_NORMAL_V_NH = 0x001B;
8.1.2.1.47.1.60 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_RECORD_N Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-record-n format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_RECORD_N = 0x0001;
8.1.2.1.47.1.61 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_RECORD_X Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-minutiae-record-x format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINUTIAE_RECORD_X = 0x0002;
8.1.2.1.47.1.62 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SKELETAL_DATA _CARD_COMPACT Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-pattern-skeletal-data-card-compact format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SKELETAL_DATA_CARD_COMPACT = 0x0013;
8.1.2.1.47.1.63 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SKELETAL_DATA _CARD_NORMAL Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-pattern-skeletal-data-card-normal format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SKELETAL_DATA_CARD_NORMAL = 0x0012;
8.1.2.1.47.1.64 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SKELETAL_DATA _RECORD Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-pattern-skeletal-data-record format.
447
public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SKELETAL_DATA_RECORD = 0x0011;
8.1.2.1.47.1.65 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SPECTRAL_DISC RETE_FOURIER_TRANSFORM Field

The CBEFF DBD format identifier assigned finger-pattern-spectral-discrete-fourier-transform format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SPECTRAL_DISCRETE_FOURIER_TRANSFORM = 0x000C; to ISO/IEC JTC 1 SC 37 Biometrics
8.1.2.1.47.1.66 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SPECTRAL_GABO R_FILTER Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics finger-pattern-spectral-gabor-filter format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SPECTRAL_GABOR_FILTER = 0x000D;
8.1.2.1.47.1.67 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SPECTRAL_QUAN TIZED_CO_SINUSOIDAL_TRIPLET Field

The CBEFF DBD format identifier assigned finger-pattern-spectral-quantized-co-sinusoidal-triplet format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATTERN_SPECTRAL_QUANTIZED_CO_SINUSOIDAL_TRIPLET = 0x000A; to ISO/IEC JTC 1 SC 37 Biometrics
8.1.2.1.47.1.68 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_HAND_GEOMETRY_SILHOUETTE Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics hand-geometry-silhouette format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_HAND_GEOMETRY_SILHOUETTE = 0x0018;
8.1.2.1.47.1.69 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_IRIS_IMAGE_POLAR Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics iris-image-polar format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_IRIS_IMAGE_POLAR = 0x000B;
8.1.2.1.47.1.70 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_IRIS_IMAGE_RECTILINEAR Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics iris-image-rectilinear format.
448
public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_IRIS_IMAGE_RECTILINEAR = 0x0009;
8.1.2.1.47.1.71 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_SIGNATURE_SIGN_TIME_SERIES_CO MPACT Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics signature-sign-time-series-compact format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_SIGNATURE_SIGN_TIME_SERIES_COMPACT = 0x000F;
8.1.2.1.47.1.72 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_SIGNATURE_SIGN_TIME_SERIES_FUL L Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics signature-sign-time-series-full format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_SIGNATURE_SIGN_TIME_SERIES_FULL = 0x000E;
8.1.2.1.47.1.73 CBEFFBDBFormatIdentifiers.ISO_IEC_JTC_1_SC_37_BIOMETRICS_VASCULAR_IMAGE_DATA Field

The CBEFF DBD format identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics vascular-image-data format. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS_VASCULAR_IMAGE_DATA = 0x0014;
8.1.2.1.47.1.74 CBEFFBDBFormatIdentifiers.NEUROTECHNOLOGIJA_NERECORD_1 Field

The CBEFF DBD format identifier assigned by Neurotechnologija for NERecord ( Java public static final int NEUROTECHNOLOGIJA_NERECORD_1 = 0x0500; see page 75) version 1 format.
8.1.2.1.47.1.75 CBEFFBDBFormatIdentifiers.NEUROTECHNOLOGIJA_NLRECORD_3 Field

The CBEFF DBD format identifier assigned by Neurotechnologija for NLRecord ( Java public static final int NEUROTECHNOLOGIJA_NLRECORD_3 = 0x0302; see page 163) version 3 format.
8.1.2.1.47.1.76 CBEFFBDBFormatIdentifiers.NEUROTECHNOLOGIJA_NTEMPLATE Field

The CBEFF DBD format identifier assigned by Neurotechnologija for NTemplate ( Java public static final int NEUROTECHNOLOGIJA_NTEMPLATE = 0x0000; see page 210) format.
8.1.2.1.48 CBEFFBiometricOrganizations Class

Specifies CBEFF biometric organizations identifiers registered with International Biometric Industry Association (IBIA). Java public final class CBEFFBiometricOrganizations; File CBEFFBiometricOrganizations.java 449
8.1 Java Reference CBEFFBiometricOrganizations Fields Name _123ID ( see page 453)
Description The CBEFF biometric organization identifier assigned to 123ID, Inc. The CBEFF biometric organization identifier assigned to A 4 Vision, S.A. The CBEFF biometric organization identifier assigned to AcSys Biometrics Corp. The CBEFF biometric organization identifier assigned to ActivCard, Inc. see page 453) The CBEFF biometric organization identifier assigned to Antheus Technology. The CBEFF biometric organization identifier assigned to AOptix. The CBEFF biometric organization identifier assigned to Atmel. see page The CBEFF biometric organization identifier assigned to Aurora Wireless Technologies, Inc. The CBEFF biometric organization identifier assigned to Authen Tec. The CBEFF biometric organization identifier assigned to Aware, Inc. The CBEFF biometric organization identifier assigned to Bio Wise, NV. see page 454) see page 454) see The CBEFF biometric organization identifier assigned to BIO-key International. The CBEFF biometric organization identifier assigned to Bio-Key International. The CBEFF biometric organization identifier assigned to BioLink Technologies International, Inc. The CBEFF biometric organization identifier assigned to BioLogica Sistemas Ltda. The CBEFF biometric organization identifier assigned to Bioscrypt, Inc. The CBEFF biometric organization identifier assigned to Biovision, Inc. The CBEFF biometric organization identifier assigned to Cogent Systems, Inc. see page 455) The CBEFF biometric organization identifier assigned to Cross Match Technologies, Inc. The CBEFF biometric organization identifier assigned to CryptoMetrics. The CBEFF biometric organization identifier assigned to Cyber SIGN, Inc. see page The CBEFF biometric organization identifier assigned to DERMALOG Identification Systems, GmbH. The CBEFF biometric organization identifier assigned to Digent Co., Ltd. The CBEFF biometric organization identifier assigned to DigitalPersona, Inc. see page 455) The CBEFF biometric organization identifier assigned to East Shore Technologies.
A_4_VISION (
ACSYS_BIOMETRICS ( ACTIVCARD (
see page 453)
ANTHEUS_TECHNOLOGY ( AOPTIX ( ATMEL ( see page 453) see page 453)
AURORA_WIRELESS_TECHNOLOGIES ( 453) AUTHEN_TEC ( AWARE ( see page 454)
BIO_WISE (
BIOKEY_INTERNATIONAL (
BIOKEY_INTERNATIONAL_2 (
BIOLINK_TECHNOLOGIES_INTERNATIONAL ( page 454) BIOLOGICA_SISTEMAS ( BIOSCRYPT ( BIOVISION ( see page 454)
COGENT_SYSTEMS (
CROSS_MATCH_TECHNOLOGIES ( CRYPTO_METRICS ( CYBER_SIGN ( see page 455)
see page 455)
DERMALOG_IDENTIFICATION_SYSTEMS ( 455) DIGENT ( see page 455) see page 455)
DIGITALPERSONA (
EAST_SHORE_TECHNOLOGIES (
450
8.1 Java Reference
EASTERN_GOLDEN_FINGER_TECHNOLOGY_BEIJING The CBEFF biometric organization identifier ( see page 455) assigned to Eastern Golden Finger Technology Beijing Co., Ltd. ECRYP ( see page 455) The CBEFF biometric organization identifier assigned to eCryp, Inc. The CBEFF biometric organization identifier assigned to Federal Office for Information Security (BSI). The CBEFF biometric organization identifier assigned to Fingerprint Cards AB. The CBEFF biometric organization identifier assigned to Fujitsu Ltd. The CBEFF biometric organization identifier assigned to German Institute for Standardization (Deutsches Institut fur Normung E.V.-DIN). The CBEFF biometric organization identifier assigned to Green Bit Americas Inc. The CBEFF biometric organization identifier assigned to Griaule Tecnologia LTDA. The CBEFF biometric organization identifier assigned to Guardware Systems, Ltd. The CBEFF biometric organization identifier assigned to Hitachi, LTD. The CBEFF biometric organization identifier assigned to HumanScan GmbH. The CBEFF biometric organization identifier assigned to id3 Semiconductors. The CBEFF biometric organization identifier assigned to Identix Corporation. The CBEFF biometric organization identifier assigned to Identix, Inc. see page 457) see page 457) The CBEFF biometric organization identifier assigned to Image Ware Systems, Inc. The CBEFF biometric organization identifier assigned to INCITS Technical Committee M1 Biometrics. The CBEFF biometric organization identifier assigned to Infineon Technologies, AG. The CBEFF biometric organization identifier assigned to Innovatrics. see page The CBEFF biometric organization identifier assigned to International Biometric Group. The CBEFF biometric organization identifier assigned to InvestorsHelpers, Inc. The CBEFF biometric organization identifier assigned to Iridian Technologies, Inc. The CBEFF biometric organization identifier assigned to ISO/IEC JTC 1 SC 27 - IT Security techniques.
FEDERAL_OFFICE_FOR_INFORMATION_SECURITY ( see page 456) FINGERPRINT_CARDS ( FUJITSU ( see page 456) see page 456)
GERMAN_INSTITUTE_FOR_STANDARDIZATION ( see page 456) GREEN_BIT_AMERICAS ( GRIAULE_TECNOLOGIA ( GUARDWARE_SYSTEMS ( HITACHI ( see page 456) see page 456) see page 457) see page 456) see page 456) see page 456)
HUMANSCAN (
ID3_SEMICONDUCTORS ( IDENTIX ( see page 457) see page 457)
IDENTIX_2 (
IMAGE_WARE_SYSTEMS (
INCITS_TC_M1_BIOMETRICS (
INFINEON_TECHNOLOGIES ( INNOVATRICS ( see page 457)
see page 457)
INTERNATIONAL_BIOMETRIC_GROUP ( 457) INVESTORSHELPERS ( see page 457)
IRIDIAN_TECHNOLOGIES (
see page 458)
ISO_IEC_JTC_1_SC_27_IT_SECURITY_TECHNIQUES ( see page 458) ISO_IEC_JTC_1_SC_37_BIOMETRICS ( JANUS_ASSOCIATES ( see page 458) see page 458)
see page 458) The CBEFF biometric organization identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics. The CBEFF biometric organization identifier assigned to JANUS Associates, Inc. The CBEFF biometric organization identifier assigned to LG Electronics USA, Inc.
LG_ELECTRONICS_USA (
451
8.1 Java Reference
LOGICO_SMARTCARD_SOLUTIONS ( LUMIDIGM ( MOTOROLA ( see page 458) see page 458)
see page 458)
The CBEFF biometric organization identifier assigned to LOGICO Smartcard Solutions, AG. The CBEFF biometric organization identifier assigned to Lumidigm. The CBEFF biometric organization identifier assigned to Motorola.
NEC_SOLUTIONS_AMERICA ( NEUROTECHNOLOGIJA ( NIST ( see page 459)
see page 458)
The CBEFF biometric organization identifier assigned to NEC Solutions America, Inc. The CBEFF biometric organization identifier assigned to Neurotechnologija. The CBEFF biometric organization identifier assigned to National Institute of Standards and Technology (NIST). The CBEFF biometric organization identifier assigned to NITGEN. The CBEFF biometric organization identifier which is not allowed to be used by any of the biometric organizations. The CBEFF biometric organization identifier assigned to OmniPerception Limited. The CBEFF biometric organization identifier assigned to Precise Biometrics, AB. The CBEFF biometric organization identifier for private use (not uniquely assigned by IBIA).
see page 458)
NITGEN (
NOT_FOR_USE (
OMNIPERCEPTION (
PRECISE_BIOMETRICS ( PRIVATE ( see page 459)
RECOGNITION_SYSTEMS ( SAFLINK ( see page 459)
see page 459)
The CBEFF biometric organization identifier assigned to Recognition Systems, Inc. The CBEFF biometric organization identifier assigned to SAFLINK Corporation. The CBEFF biometric organization identifier assigned to Sagem Morpho. The CBEFF biometric organization identifier assigned to SecuGen Corporation. The CBEFF biometric organization identifier assigned to Secure Design. The CBEFF biometric organization identifier assigned to Silex Technology, Inc. The CBEFF biometric organization identifier assigned to Sonda Technologies. The CBEFF biometric organization identifier assigned to StarTek Engineering, Inc. The CBEFF biometric organization identifier assigned to Suprema, Inc. The CBEFF biometric organization identifier reserved for testing. The CBEFF biometric organization identifier reserved for testing.
SAGEM_MORPHO ( SECUGEN (
see page 459)
SECURE_DESIGN (
SILEX_TECHNOLOGY (
SONDA_TECHNOLOGIES ( STARTEK_ENGINEERING ( SUPREMA ( TESTING_1 ( TESTING_2 ( see page 460) see page 460) see page 460)
THALES_IDENITFICATION ( ULTRA_SCAN ( UPEK (
see page 460)
The CBEFF biometric organization identifier assigned to Thales Idenitfication. The CBEFF biometric organization identifier assigned to Ultra-Scan Corporation. The CBEFF biometric organization identifier assigned to UPEK, Inc. The CBEFF biometric organization identifier assigned to Validity, Inc. The CBEFF biometric organization identifier assigned to Veridicom, Inc. 452
see page 460)
VALIDITY (
VERIDICOM (
8.1 Java Reference VERIDT ( VIISAGE ( see page 461) see page 461)
The CBEFF biometric organization identifier assigned to Veridt. The CBEFF biometric organization identifier assigned to Viisage. The CBEFF biometric organization identifier assigned to Warwick Warp Ltd. The CBEFF biometric organization identifier assigned to XTec,Incorporated.
WARWICK_WARP ( XTEC (
see page 461)
see page 461)
8.1.2.1.48.1 CBEFFBiometricOrganizations Fields

8.1.2.1.48.1.1 CBEFFBiometricOrganizations._123ID Field
The CBEFF biometric organization identifier assigned to 123ID, Inc. Java public static final int _123ID = 0x0038;
8.1.2.1.48.1.2 CBEFFBiometricOrganizations.A_4_VISION Field

The CBEFF biometric organization identifier assigned to A 4 Vision, S.A. Java public static final int A_4_VISION = 0x0010;
8.1.2.1.48.1.3 CBEFFBiometricOrganizations.ACSYS_BIOMETRICS Field

The CBEFF biometric organization identifier assigned to AcSys Biometrics Corp. Java public static final int ACSYS_BIOMETRICS = 0x0022;
8.1.2.1.48.1.4 CBEFFBiometricOrganizations.ACTIVCARD Field

The CBEFF biometric organization identifier assigned to ActivCard, Inc. Java public static final int ACTIVCARD = 0x0020;
8.1.2.1.48.1.5 CBEFFBiometricOrganizations.ANTHEUS_TECHNOLOGY Field

The CBEFF biometric organization identifier assigned to Antheus Technology. Java public static final int ANTHEUS_TECHNOLOGY = 0x0032;
8.1.2.1.48.1.6 CBEFFBiometricOrganizations.AOPTIX Field

The CBEFF biometric organization identifier assigned to AOptix. Java public static final int AOPTIX = 0x0047;
8.1.2.1.48.1.7 CBEFFBiometricOrganizations.ATMEL Field

The CBEFF biometric organization identifier assigned to Atmel. Java public static final int ATMEL = 0x0041;
8.1.2.1.48.1.8 CBEFFBiometricOrganizations.AURORA_WIRELESS_TECHNOLOGIES Field

The CBEFF biometric organization identifier assigned to Aurora Wireless Technologies, Inc.
453
public static final int AURORA_WIRELESS_TECHNOLOGIES = 0x0014;
8.1.2.1.48.1.9 CBEFFBiometricOrganizations.AUTHEN_TEC Field

The CBEFF biometric organization identifier assigned to Authen Tec. Java public static final int AUTHEN_TEC = 0x0042;
8.1.2.1.48.1.10 CBEFFBiometricOrganizations.AWARE Field

The CBEFF biometric organization identifier assigned to Aware, Inc. Java public static final int AWARE = 0x003B;
8.1.2.1.48.1.11 CBEFFBiometricOrganizations.BIO_WISE Field

The CBEFF biometric organization identifier assigned to Bio Wise, NV. Java public static final int BIO_WISE = 0x0024;
8.1.2.1.48.1.12 CBEFFBiometricOrganizations.BIOKEY_INTERNATIONAL Field

The CBEFF biometric organization identifier assigned to BIO-key International. Java public static final int BIOKEY_INTERNATIONAL = 0x0030;
8.1.2.1.48.1.13 CBEFFBiometricOrganizations.BIOKEY_INTERNATIONAL_2 Field

The CBEFF biometric organization identifier assigned to Bio-Key International. Java public static final int BIOKEY_INTERNATIONAL_2 = 0x0039;
8.1.2.1.48.1.14 CBEFFBiometricOrganizations.BIOLINK_TECHNOLOGIES_INTERNATIONAL Field

The CBEFF biometric organization identifier assigned to BioLink Technologies International, Inc. Java public static final int BIOLINK_TECHNOLOGIES_INTERNATIONAL = 0x001F;
8.1.2.1.48.1.15 CBEFFBiometricOrganizations.BIOLOGICA_SISTEMAS Field

The CBEFF biometric organization identifier assigned to BioLogica Sistemas Ltda. Java public static final int BIOLOGICA_SISTEMAS = 0x004C;
8.1.2.1.48.1.16 CBEFFBiometricOrganizations.BIOSCRYPT Field

The CBEFF biometric organization identifier assigned to Bioscrypt, Inc. Java public static final int BIOSCRYPT = 0x0002;
8.1.2.1.48.1.17 CBEFFBiometricOrganizations.BIOVISION Field

The CBEFF biometric organization identifier assigned to Biovision, Inc. Java public static final int BIOVISION = 0x0045; 454
8.1 Java Reference
8.1.2.1.48.1.18 CBEFFBiometricOrganizations.COGENT_SYSTEMS Field

The CBEFF biometric organization identifier assigned to Cogent Systems, Inc. Java public static final int COGENT_SYSTEMS = 0x0017;
8.1.2.1.48.1.19 CBEFFBiometricOrganizations.CROSS_MATCH_TECHNOLOGIES Field

The CBEFF biometric organization identifier assigned to Cross Match Technologies, Inc. Java public static final int CROSS_MATCH_TECHNOLOGIES = 0x0018;
8.1.2.1.48.1.20 CBEFFBiometricOrganizations.CRYPTO_METRICS Field

The CBEFF biometric organization identifier assigned to CryptoMetrics. Java public static final int CRYPTO_METRICS = 0x002F;
8.1.2.1.48.1.21 CBEFFBiometricOrganizations.CYBER_SIGN Field

The CBEFF biometric organization identifier assigned to Cyber SIGN, Inc. Java public static final int CYBER_SIGN = 0x0007;
8.1.2.1.48.1.22 CBEFFBiometricOrganizations.DERMALOG_IDENTIFICATION_SYSTEMS Field

The CBEFF biometric organization identifier assigned to DERMALOG Identification Systems, GmbH. Java public static final int DERMALOG_IDENTIFICATION_SYSTEMS = 0x000D;
8.1.2.1.48.1.23 CBEFFBiometricOrganizations.DIGENT Field

The CBEFF biometric organization identifier assigned to Digent Co., Ltd. Java public static final int DIGENT = 0x0048;
8.1.2.1.48.1.24 CBEFFBiometricOrganizations.DIGITALPERSONA Field

The CBEFF biometric organization identifier assigned to DigitalPersona, Inc. Java public static final int DIGITALPERSONA = 0x0033;
8.1.2.1.48.1.25 CBEFFBiometricOrganizations.EAST_SHORE_TECHNOLOGIES Field

The CBEFF biometric organization identifier assigned to East Shore Technologies. Java public static final int EAST_SHORE_TECHNOLOGIES = 0x0036;
8.1.2.1.48.1.26 CBEFFBiometricOrganizations.EASTERN_GOLDEN_FINGER_TECHNOLOGY_BEIJING Field

The CBEFF biometric organization identifier assigned to Eastern Golden Finger Technology Beijing Co., Ltd. Java public static final int EASTERN_GOLDEN_FINGER_TECHNOLOGY_BEIJING = 0x004A;
8.1.2.1.48.1.27 CBEFFBiometricOrganizations.ECRYP Field

The CBEFF biometric organization identifier assigned to eCryp, Inc. 455
public static final int ECRYP = 0x0008;
8.1.2.1.48.1.28 CBEFFBiometricOrganizations.FEDERAL_OFFICE_FOR_INFORMATION_SECURITY Field

The CBEFF biometric organization identifier assigned to Federal Office for Information Security (BSI). Java public static final int FEDERAL_OFFICE_FOR_INFORMATION_SECURITY = 0x004B;
8.1.2.1.48.1.29 CBEFFBiometricOrganizations.FINGERPRINT_CARDS Field

The CBEFF biometric organization identifier assigned to Fingerprint Cards AB. Java public static final int FINGERPRINT_CARDS = 0x0009;
8.1.2.1.48.1.30 CBEFFBiometricOrganizations.FUJITSU Field

The CBEFF biometric organization identifier assigned to Fujitsu Ltd. Java public static final int FUJITSU = 0x0046;
8.1.2.1.48.1.31 CBEFFBiometricOrganizations.GERMAN_INSTITUTE_FOR_STANDARDIZATION Field

The CBEFF biometric organization identifier assigned to German Institute for Standardization (Deutsches Institut fur Normung E.V.-DIN). Java public static final int GERMAN_INSTITUTE_FOR_STANDARDIZATION = 0x001A;
8.1.2.1.48.1.32 CBEFFBiometricOrganizations.GREEN_BIT_AMERICAS Field

The CBEFF biometric organization identifier assigned to Green Bit Americas Inc. Java public static final int GREEN_BIT_AMERICAS = 0x0040;
8.1.2.1.48.1.33 CBEFFBiometricOrganizations.GRIAULE_TECNOLOGIA Field

The CBEFF biometric organization identifier assigned to Griaule Tecnologia LTDA. Java public static final int GRIAULE_TECNOLOGIA = 0x003A;
8.1.2.1.48.1.34 CBEFFBiometricOrganizations.GUARDWARE_SYSTEMS Field

The CBEFF biometric organization identifier assigned to Guardware Systems, Ltd. Java public static final int GUARDWARE_SYSTEMS = 0x0026;
8.1.2.1.48.1.35 CBEFFBiometricOrganizations.HITACHI Field

The CBEFF biometric organization identifier assigned to Hitachi, LTD. Java public static final int HITACHI = 0x0037;
8.1.2.1.48.1.36 CBEFFBiometricOrganizations.HUMANSCAN Field

The CBEFF biometric organization identifier assigned to HumanScan GmbH.
456
public static final int HUMANSCAN = 0x0021;
8.1.2.1.48.1.37 CBEFFBiometricOrganizations.ID3_SEMICONDUCTORS Field

The CBEFF biometric organization identifier assigned to id3 Semiconductors. Java public static final int ID3_SEMICONDUCTORS = 0x003F;
8.1.2.1.48.1.38 CBEFFBiometricOrganizations.IDENTIX Field

The CBEFF biometric organization identifier assigned to Identix Corporation. Java public static final int IDENTIX = 0x0003;
8.1.2.1.48.1.39 CBEFFBiometricOrganizations.IDENTIX_2 Field

The CBEFF biometric organization identifier assigned to Identix, Inc. Java public static final int IDENTIX_2 = 0x000C;
8.1.2.1.48.1.40 CBEFFBiometricOrganizations.IMAGE_WARE_SYSTEMS Field

The CBEFF biometric organization identifier assigned to Image Ware Systems, Inc. Java public static final int IMAGE_WARE_SYSTEMS = 0x0043;
8.1.2.1.48.1.41 CBEFFBiometricOrganizations.INCITS_TC_M1_BIOMETRICS Field

The CBEFF biometric organization identifier assigned to INCITS Technical Committee M1 - Biometrics. Java public static final int INCITS_TC_M1_BIOMETRICS = 0x001B;
8.1.2.1.48.1.42 CBEFFBiometricOrganizations.INFINEON_TECHNOLOGIES Field

The CBEFF biometric organization identifier assigned to Infineon Technologies, AG. Java public static final int INFINEON_TECHNOLOGIES = 0x0004;
8.1.2.1.48.1.43 CBEFFBiometricOrganizations.INNOVATRICS Field

The CBEFF biometric organization identifier assigned to Innovatrics. Java public static final int INNOVATRICS = 0x0035;
8.1.2.1.48.1.44 CBEFFBiometricOrganizations.INTERNATIONAL_BIOMETRIC_GROUP Field

The CBEFF biometric organization identifier assigned to International Biometric Group. Java public static final int INTERNATIONAL_BIOMETRIC_GROUP = 0x0016;
8.1.2.1.48.1.45 CBEFFBiometricOrganizations.INVESTORSHELPERS Field

The CBEFF biometric organization identifier assigned to InvestorsHelpers, Inc. Java public static final int INVESTORSHELPERS = 0x0027; 457
8.1 Java Reference
8.1.2.1.48.1.46 CBEFFBiometricOrganizations.IRIDIAN_TECHNOLOGIES Field

The CBEFF biometric organization identifier assigned to Iridian Technologies, Inc. Java public static final int IRIDIAN_TECHNOLOGIES = 0x0005;
8.1.2.1.48.1.47 CBEFFBiometricOrganizations.ISO_IEC_JTC_1_SC_27_IT_SECURITY_TECHNIQUES Field

The CBEFF biometric organization identifier assigned to ISO/IEC JTC 1 SC 27 - IT Security techniques. Java public static final int ISO_IEC_JTC_1_SC_27_IT_SECURITY_TECHNIQUES = 0x0102;
8.1.2.1.48.1.48 CBEFFBiometricOrganizations.ISO_IEC_JTC_1_SC_37_BIOMETRICS Field

The CBEFF biometric organization identifier assigned to ISO/IEC JTC 1 SC 37 - Biometrics. Java public static final int ISO_IEC_JTC_1_SC_37_BIOMETRICS = 0x0101;
8.1.2.1.48.1.49 CBEFFBiometricOrganizations.JANUS_ASSOCIATES Field

The CBEFF biometric organization identifier assigned to JANUS Associates, Inc. Java public static final int JANUS_ASSOCIATES = 0x002C;
8.1.2.1.48.1.50 CBEFFBiometricOrganizations.LG_ELECTRONICS_USA Field

The CBEFF biometric organization identifier assigned to LG Electronics USA, Inc. Java public static final int LG_ELECTRONICS_USA = 0x002A;
8.1.2.1.48.1.51 CBEFFBiometricOrganizations.LOGICO_SMARTCARD_SOLUTIONS Field

The CBEFF biometric organization identifier assigned to LOGICO Smartcard Solutions, AG. Java public static final int LOGICO_SMARTCARD_SOLUTIONS = 0x000E;
8.1.2.1.48.1.52 CBEFFBiometricOrganizations.LUMIDIGM Field

The CBEFF biometric organization identifier assigned to Lumidigm. Java public static final int LUMIDIGM = 0x0025;
8.1.2.1.48.1.53 CBEFFBiometricOrganizations.MOTOROLA Field

The CBEFF biometric organization identifier assigned to Motorola. Java public static final int MOTOROLA = 0x002E;
8.1.2.1.48.1.54 CBEFFBiometricOrganizations.NEC_SOLUTIONS_AMERICA Field

The CBEFF biometric organization identifier assigned to NEC Solutions America, Inc. Java public static final int NEC_SOLUTIONS_AMERICA = 0x0011;
8.1.2.1.48.1.55 CBEFFBiometricOrganizations.NEUROTECHNOLOGIJA Field

The CBEFF biometric organization identifier assigned to Neurotechnologija. 458
public static final int NEUROTECHNOLOGIJA = 0x0031;
8.1.2.1.48.1.56 CBEFFBiometricOrganizations.NIST Field

The CBEFF biometric organization identifier assigned to National Institute of Standards and Technology (NIST). Java public static final int NIST = 0x000F;
8.1.2.1.48.1.57 CBEFFBiometricOrganizations.NITGEN Field

The CBEFF biometric organization identifier assigned to NITGEN. Java public static final int NITGEN = 0x001C;
8.1.2.1.48.1.58 CBEFFBiometricOrganizations.NOT_FOR_USE Field

The CBEFF biometric organization identifier which is not allowed to be used by any of the biometric organizations. Java public static final int NOT_FOR_USE = 0xFFFF;
8.1.2.1.48.1.59 CBEFFBiometricOrganizations.OMNIPERCEPTION Field

The CBEFF biometric organization identifier assigned to OmniPerception Limited. Java public static final int OMNIPERCEPTION = 0x002D;
8.1.2.1.48.1.60 CBEFFBiometricOrganizations.PRECISE_BIOMETRICS Field

The CBEFF biometric organization identifier assigned to Precise Biometrics, AB. Java public static final int PRECISE_BIOMETRICS = 0x000B;
8.1.2.1.48.1.61 CBEFFBiometricOrganizations.PRIVATE Field

The CBEFF biometric organization identifier for private use (not uniquely assigned by IBIA). Java public static final int PRIVATE = 0xFEFE;
8.1.2.1.48.1.62 CBEFFBiometricOrganizations.RECOGNITION_SYSTEMS Field

The CBEFF biometric organization identifier assigned to Recognition Systems, Inc. Java public static final int RECOGNITION_SYSTEMS = 0x0019;
8.1.2.1.48.1.63 CBEFFBiometricOrganizations.SAFLINK Field

The CBEFF biometric organization identifier assigned to SAFLINK Corporation. Java public static final int SAFLINK = 0x0001;
8.1.2.1.48.1.64 CBEFFBiometricOrganizations.SAGEM_MORPHO Field

The CBEFF biometric organization identifier assigned to Sagem Morpho. Java public static final int SAGEM_MORPHO = 0x001D; 459
8.1 Java Reference
8.1.2.1.48.1.65 CBEFFBiometricOrganizations.SECUGEN Field

The CBEFF biometric organization identifier assigned to SecuGen Corporation. Java public static final int SECUGEN = 0x000A;
8.1.2.1.48.1.66 CBEFFBiometricOrganizations.SECURE_DESIGN Field

The CBEFF biometric organization identifier assigned to Secure Design. Java public static final int SECURE_DESIGN = 0x003D;
8.1.2.1.48.1.67 CBEFFBiometricOrganizations.SILEX_TECHNOLOGY Field

The CBEFF biometric organization identifier assigned to Silex Technology, Inc. Java public static final int SILEX_TECHNOLOGY = 0x0023;
8.1.2.1.48.1.68 CBEFFBiometricOrganizations.SONDA_TECHNOLOGIES Field

The CBEFF biometric organization identifier assigned to Sonda Technologies. Java public static final int SONDA_TECHNOLOGIES = 0x003C;
8.1.2.1.48.1.69 CBEFFBiometricOrganizations.STARTEK_ENGINEERING Field

The CBEFF biometric organization identifier assigned to StarTek Engineering, Inc. Java public static final int STARTEK_ENGINEERING = 0x002B;
8.1.2.1.48.1.70 CBEFFBiometricOrganizations.SUPREMA Field

The CBEFF biometric organization identifier assigned to Suprema, Inc. Java public static final int SUPREMA = 0x0044;
8.1.2.1.48.1.71 CBEFFBiometricOrganizations.TESTING_1 Field

The CBEFF biometric organization identifier reserved for testing. Java public static final int TESTING_1 = 0xFFF0;
8.1.2.1.48.1.72 CBEFFBiometricOrganizations.TESTING_2 Field

The CBEFF biometric organization identifier reserved for testing. Java public static final int TESTING_2 = 0xFFFE;
8.1.2.1.48.1.73 CBEFFBiometricOrganizations.THALES_IDENITFICATION Field

The CBEFF biometric organization identifier assigned to Thales Idenitfication. Java public static final int THALES_IDENITFICATION = 0x0015;
8.1.2.1.48.1.74 CBEFFBiometricOrganizations.ULTRA_SCAN Field

The CBEFF biometric organization identifier assigned to Ultra-Scan Corporation. 460
public static final int ULTRA_SCAN = 0x0013;
8.1.2.1.48.1.75 CBEFFBiometricOrganizations.UPEK Field

The CBEFF biometric organization identifier assigned to UPEK, Inc. Java public static final int UPEK = 0x0012;
8.1.2.1.48.1.76 CBEFFBiometricOrganizations.VALIDITY Field

The CBEFF biometric organization identifier assigned to Validity, Inc. Java public static final int VALIDITY = 0x0028;
8.1.2.1.48.1.77 CBEFFBiometricOrganizations.VERIDICOM Field

The CBEFF biometric organization identifier assigned to Veridicom, Inc. Java public static final int VERIDICOM = 0x0006;
8.1.2.1.48.1.78 CBEFFBiometricOrganizations.VERIDT Field

The CBEFF biometric organization identifier assigned to Veridt. Java public static final int VERIDT = 0x003E;
8.1.2.1.48.1.79 CBEFFBiometricOrganizations.VIISAGE Field

The CBEFF biometric organization identifier assigned to Viisage. Java public static final int VIISAGE = 0x0029;
8.1.2.1.48.1.80 CBEFFBiometricOrganizations.WARWICK_WARP Field

The CBEFF biometric organization identifier assigned to Warwick Warp Ltd. Java public static final int WARWICK_WARP = 0x0049;
8.1.2.1.48.1.81 CBEFFBiometricOrganizations.XTEC Field

The CBEFF biometric organization identifier assigned to XTec,Incorporated. Java public static final int XTEC = 0x0034;
8.1.2.1.49 FCRecord Class

Contains functionality for managing face records by ANSI INCITS 385-2004, ISO/IEC 19794-5:2005 standards ( 214). Java public final class FCRecord extends NObject implements Cloneable; File FCRecord.java see page
461
8.1 Java Reference Methods Name FCRecord ( FCRecord Classes Name FaceImageCollection ( 464) FCRecord Fields Name see page 462)
Description Initializes a new instance of the FCRecord class.
Description see page Collection of FCRecords.
Description
FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY Process first face image only. ( see page 466) MAX_FACE_IMAGE_COUNT ( FCRecord Methods Name calculateSize ( getStandard ( nativeTypeOf ( see page 466) see page 466) see page 467) see page 466) getFaceImages ( Description Calculates the size of a FCRecord with particular parameters. Gets particular face images from the FCRecord. Gets the FCRecord standard. Retrieves a function that retrieves NType object for the enclosing type. see page 466) Maximum number of faces in FCRecord.
8.1.2.1.49.1 FCRecord Constructor

8.1.2.1.49.1.1 FCRecord.FCRecord Constructor (BDIFStandard)
Initializes a new instance of the FCRecord class. Java public FCRecord(BDIFStandard standard); Parameters Parameters BDIFStandard standard Description One of BDIFStandard values. This parameter is reserved, must be zero.
8.1.2.1.49.1.2 FCRecord.FCRecord Constructor (ByteBuffer, BDIFStandard)

Initializes a new instance of the FCRecord class. Java public FCRecord(ByteBuffer buffer, BDIFStandard standard); Parameters Parameters ByteBuffer buffer BDIFStandard standard Description ByteBuffer containing the FCRecord. One of BDIFStandard values. This parameter is reserved, must be zero.
8.1.2.1.49.1.3 FCRecord.FCRecord Constructor (ByteBuffer, int, BDIFStandard)

Initializes a new instance of the FCRecord class. Java public FCRecord(ByteBuffer buffer, int flags, BDIFStandard standard);
462
8.1 Java Reference Parameters Parameters ByteBuffer buffer int flags
Description ByteBuffer containing the FCRecord. Bitwise combination of zero or more flags that controls behavior of the constructor. The following flags are supported: FlagProcessFirstFaceImageOnly, FlagSkipFeaturePoints. One of BDIFStandard values. This parameter is reserved, must be zero.
BDIFStandard standard
8.1.2.1.49.1.4 FCRecord.FCRecord Constructor (FCRecord, int, BDIFStandard)

Initializes a new instance of the FCRecord class. Java public FCRecord(FCRecord srcRecord, int flags, BDIFStandard standard); Parameters Parameters FCRecord srcRecord int flags Description FCRecord object. Bitwise combination of zero or more flags that controls behavior of the constructor. The following flags are supported: FlagProcessFirstFaceImageOnly, FlagSkipFeaturePoints. One of BDIFStandard values.
8.1.2.1.49.1.5 FCRecord.FCRecord Constructor (NImage, FCRFaceImageType, FCRImageDataType, BDIFStandard)

Initializes a new instance of the FCRecord class. Java public FCRecord(NImage nImage, FCRFaceImageType faceImageType, FCRImageDataType imageDataType, BDIFStandard standard); Parameters Parameters NImage nImage FCRFaceImageType faceImageType FCRImageDataType imageDataType BDIFStandard standard Description A NImage object. One of {@link FCRFaceImageType} values. One of {@link FCRImageDataType} values. One of BDIFStandard values.
8.1.2.1.49.1.6 FCRecord.FCRecord Constructor (NImage, FCRFaceImageType, FCRImageDataType, int, BDIFStandard)

Initializes a new instance of the FCRecord class. Java public FCRecord(NImage nImage, FCRFaceImageType faceImageType, FCRImageDataType imageDataType, int flags, BDIFStandard standard); Parameters Parameters NImage nImage FCRFaceImageType faceImageType FCRImageDataType imageDataType Description A NImage object. One of {@link FCRFaceImageType} values. One of {@link FCRImageDataType} values.
463
8.1 Java Reference int flags
Bitwise combination of zero or more flags that controls behavior of the constructor. The following flags are supported: FlagProcessFirstFaceImageOnly, FlagSkipFeaturePoints. One of BDIFStandard values.
8.1.2.1.49.1.7 FCRecord.FCRecord Constructor (int, BDIFStandard)

Initializes a new instance of the FCRecord class. Java public FCRecord(int flags, BDIFStandard standard); Parameters Parameters int flags Description Bitwise combination of zero or more flags that controls behavior of the constructor. The following flags are supported: FlagProcessFirstFaceImageOnly, FlagSkipFeaturePoints. One of BDIFStandard values.
8.1.2.1.49.2 FCRecord Classes

8.1.2.1.49.2.1 FCRecord.FaceImageCollection Class
Collection of FCRecords. Java public final class FaceImageCollection extends NObjectCollection<FCRFaceImage>; File FCRecord.java FaceImageCollection Methods Name add ( see page 464) Description Adds face image to the FCRecord ( see page 461).
8.1.2.1.49.2.1.1 FaceImageCollection Methods 8.1.2.1.49.2.1.1.1 add Method 8.1.2.1.49.2.1.1.1.1 FCRecord.FaceImageCollection.add Method (FCRFaceImageType, FCRImageDataType, NImage)
Adds face image to the FCRecord ( Java public FCRFaceImage add(FCRFaceImageType faceImageType, FCRImageDataType imageDataType, NImage nImage); Parameters Parameters FCRFaceImageType faceImageType FCRImageDataType imageDataType NImage nImage Returns FCRFaceImage ( see page 467) object. 464 Description One of the FCRFaceImageType values. One of the FCRImageDataType values. An image. see page 461).
8.1 Java Reference
8.1.2.1.49.2.1.1.1.2 FCRecord.FaceImageCollection.add Method (FCRFaceImageType, FCRImageDataType, NImage, int)

Adds face image to the FCRecord ( Java public FCRFaceImage add(FCRFaceImageType faceImageType, FCRImageDataType imageDataType, NImage nImage, int flags); Parameters Parameters FCRFaceImageType faceImageType FCRImageDataType imageDataType NImage nImage int flags Returns FCRFaceImage ( see page 467) object. Description One of the FCRFaceImageType values. One of the FCRImageDataType values. An image. Bitwise combination of zero or more flags that controls behavior of the method. see page 461).
8.1.2.1.49.2.1.1.1.3 FCRecord.FaceImageCollection.add Method (FCRFaceImageType, FCRImageDataType, short, short, FCRImageColorSpace, byte, ByteBuffer)
Adds face image to the FCRecord ( Java public FCRFaceImage add(FCRFaceImageType faceImageType, FCRImageDataType imageDataType, short width, short height, FCRImageColorSpace imageColorSpace, byte vendorImageColorSpace, ByteBuffer imageData); Parameters Parameters FCRFaceImageType faceImageType FCRImageDataType imageDataType short width short height FCRImageColorSpace imageColorSpace byte vendorImageColorSpace ByteBuffer imageData Returns FCRFaceImage ( see page 467) object. Description One of the FCRFaceImageType values. One of the FCRImageDataType values. Width of the image. Height of the image. One of the FCRImageColorSpace values. Vendor image color space. ByteBuffer containing image data. see page 461).
8.1.2.1.49.2.1.1.1.4 FCRecord.FaceImageCollection.add Method (FCRFaceImageType, FCRImageDataType, short, short, FCRImageColorSpace, byte, ByteBuffer, int)
Adds face image to the FCRecord ( Java public FCRFaceImage add(FCRFaceImageType faceImageType, FCRImageDataType imageDataType, short width, short height, FCRImageColorSpace imageColorSpace, byte vendorImageColorSpace, ByteBuffer imageData, int flags); Parameters Parameters FCRFaceImageType faceImageType FCRImageDataType imageDataType Description One of the FCRFaceImageType values. One of the FCRImageDataType values. 465 see page 461).
8.1 Java Reference short width short height FCRImageColorSpace imageColorSpace byte vendorImageColorSpace ByteBuffer imageData int flags Returns FCRFaceImage ( see page 467) object.
Width of the image. Height of the image. One of the FCRImageColorSpace values. Vendor image color space. ByteBuffer containing image data. Bitwise combination of zero or more flags that controls behavior of the method.
8.1.2.1.49.3 FCRecord Fields

8.1.2.1.49.3.1 FCRecord.FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY Field
Process first face image only. Java public static final int FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY = 0x00000100;
8.1.2.1.49.3.2 FCRecord.MAX_FACE_IMAGE_COUNT Field

Maximum number of faces in FCRecord ( Java public static final int MAX_FACE_IMAGE_COUNT = Short.MAX_VALUE; see page 461).
8.1.2.1.49.4 FCRecord Methods

8.1.2.1.49.4.1 FCRecord.calculateSize Method
Calculates the size of a FCRecord ( Java public static int calculateSize(BDIFStandard standard, int[] faceImageSizes); Parameters Parameters BDIFStandard standard int[] faceImageSizes Returns Size of FCRecord ( see page 461) that should be created. Description One of the BDIFStandard values. Sizes of face images that will be stored on FCRecord ( page 461). see see page 461) with particular parameters.
8.1.2.1.49.4.2 FCRecord.getFaceImages Method

Gets particular face images from the FCRecord ( Java public FaceImageCollection getFaceImages(); Returns A FaceImageCollection ( see page 464) representing the images in the FCRecord ( see page 461). see page 461).
8.1.2.1.49.4.3 FCRecord.getStandard Method

Gets the FCRecord ( see page 461) standard. 466
public BDIFStandard getStandard(); Returns One of the BDIFStandard values.
8.1.2.1.49.4.4 FCRecord.nativeTypeOf Method

8.1.2.1.50 FCRFaceImage Class

Face image by ANSI INCITS 385-2004, ISO/IEC 19794-5:2005 standards ( Java public final class FCRFaceImage extends NObject; File FCRFaceImage.java FCRFaceImage Classes Name FeaturePointCollection ( 469) FCRFaceImage Fields Name FLAG_SKIP_FEATURE_POINTS ( see page 469) MAX_FEATURE_POINT_COUNT ( see page 469) FCRFaceImage Methods Name calculateSize ( getDeviceType ( getExpression ( getEyeColor ( see page 469) see page 469) see page 470) see page 470) see page see page 470) Description Calculate size of a FCRFaceImage object with particular properties. Gets the face image capturing device type. Gets the expression of a face in a face image. Gets the eye color of face in a face image. Gets face image type. Gets facial feature points from a face image. Gets the gender of face in a face image. Gets height of a face image. Gets face image data type. Gets image data. Gets face image data type. Description Skip feature points. Maximum number of feature points in FCRFaceImage object. Description see page Collection of BDIFFaceFeaturePoints. see page 214).
getFaceImageType ( 470) getFeaturePoints ( getGender ( getHeight (
getImageColorSpace ( 471) getImageData ( getImageDataType ( 471)
467
8.1 Java Reference getPoseAnglePitch ( 471)
see page see
Gets the face pitch angle in a face image. Gets the face pitch raw angle in a face image.
getPoseAnglePitchRaw ( page 471) getPoseAngleRoll ( getPoseAngleRollRaw ( 472)
see page 471) Gets the face roll angle in a face image. see page Gets the face roll raw angle in a face image. Gets the face pitch angle uncertainty in a face image. Gets the face pitch raw angle uncertainty in a face image. Gets the face roll angle uncertainty in a face image. Gets the face roll raw angle uncertainty in a face image.
getPoseAngleUncertaintyPitch ( see page 472) getPoseAngleUncertaintyPitchRaw ( see page 472) getPoseAngleUncertaintyRoll ( see page 472) getPoseAngleUncertaintyRollRaw ( see page 472) getPoseAngleYaw ( getPoseAngleYawRaw ( 473) getProperties ( getQuality ( getSourceType (
see page 472) Gets face pose yaw angle in a face image. see page Gets the face pose yaw raw angle in a face image. Gets facial properties of a face in a face image. Gets the face image quality. Gets or sets face image source type. Gets vendor specific expression of a face in a face image.
see page 473)
getVendorExpression ( 473)
getVendorImageColorSpace ( page 473) getVendorSourceType ( 474) getWidth ( nativeTypeOf (
see Gets vendor specific color space of a face image.
see page Gets vendor specific face image source type. Gets width of a face image. Retrieves a function that retrieves NType object for the enclosing type. Gets the face yaw angle uncertainty in a face image. Gets the face yaw raw angle uncertainty in a face image. Sets the face image capturing device type. Sets the expression of a face in a face image. Sets the eye color of face in a face image. Sets the gender of face in a face image. Gets image data. Sets face pose angle in a face image. Sets the face pose pitch angle in a face image. Sets the face pitch raw angle in a face image. see
poseAngleUncertaintyYaw ( page 474)
poseAngleUncertaintyYawRaw ( see page 474) setDeviceType ( setExpression ( setEyeColor ( setGender ( setImageData ( setPoseAngle ( see page 474) see page 475) see page 475) see page 475) see page 476) see page 476) see page see
setPoseAnglePitch ( 476)
setPoseAnglePitchRaw ( page 476) setPoseAngleRaw ( setPoseAngleRoll (
see page 477) Sets face pose raw angle in a face image. see page 477) Sets the face roll angle in a face image. see page see Sets the face roll raw angle in a face image. Sets face pose angle uncertainty in a face image. Sets face pose angle uncertainty in a face image.
setPoseAngleRollRaw ( 477)
setPoseAngleUncertainty ( page 477)
setPoseAngleUncertaintyRaw ( see page 477) setPoseAngleYaw ( setPoseAngleYawRaw ( 478)
see page 478) Sets face pose yaw angle in a face image. see page Sets the face pose yaw raw angle in a face image.
468
8.1 Java Reference setProperties ( setQuality ( toNImage ( setSourceType (
Sets facial properties of a face in a face image. Sets the face image quality. Gets or sets face image source type. Converts face image to NImage.
8.1.2.1.50.1 FCRFaceImage Classes

8.1.2.1.50.1.1 FCRFaceImage.FeaturePointCollection Class
Collection of BDIFFaceFeaturePoints. Java public final class FeaturePointCollection extends NStructureCollection<BDIFFaceFeaturePoint, BDIFFaceFeaturePointData>; File FCRFaceImage.java
8.1.2.1.50.2 FCRFaceImage Fields

8.1.2.1.50.2.1 FCRFaceImage.FLAG_SKIP_FEATURE_POINTS Field
Skip feature points. Java public static final int FLAG_SKIP_FEATURE_POINTS = 0x00010000;
8.1.2.1.50.2.2 FCRFaceImage.MAX_FEATURE_POINT_COUNT Field

Maximum number of feature points in FCRFaceImage ( Java public static final int MAX_FEATURE_POINT_COUNT = Short.MAX_VALUE; see page 467) object.
8.1.2.1.50.3 FCRFaceImage Methods

8.1.2.1.50.3.1 FCRFaceImage.calculateSize Method
Calculate size of a FCRFaceImage ( Java public static int calculateSize(BDIFStandard standard, int featurePointCount, int imageDataLength); Parameters Parameters BDIFStandard standard int featurePointCount int imageDataLength Returns The size of FCRFaceImage ( see page 467) object. Description One of the BDIFStandard values. Facial feature points count. Face image data length. see page 467) object with particular properties.
8.1.2.1.50.3.2 FCRFaceImage.getDeviceType Method

Gets the face image capturing device type.
469
8.1 Java Reference Java public short getDeviceType(); Returns The face image capturing device type.
8.1.2.1.50.3.3 FCRFaceImage.getExpression Method

Gets the expression of a face in a face image. Java public BDIFFaceExpression getExpression(); Returns One of the BDIFFaceExpression values.
8.1.2.1.50.3.4 FCRFaceImage.getEyeColor Method

Gets the eye color of face in a face image. Java public BDIFEyeColor getEyeColor(); Returns One of the BDIFEyeColor values.
8.1.2.1.50.3.5 FCRFaceImage.getFaceImageType Method

Gets face image type. Java public FCRFaceImageType getFaceImageType(); Returns One of the FCRFaceImageType values.
8.1.2.1.50.3.6 FCRFaceImage.getFeaturePoints Method

Gets facial feature points from a face image. Java public FeaturePointCollection getFeaturePoints(); Returns Facial feature points from a face image.
8.1.2.1.50.3.7 FCRFaceImage.getGender Method

Gets the gender of face in a face image. Java public BDIFGender getGender(); Returns One of the BDIFGender values.
8.1.2.1.50.3.8 FCRFaceImage.getHeight Method

Gets height of a face image.
470
8.1 Java Reference Java public short getHeight(); Returns Height of a face image.
8.1.2.1.50.3.9 FCRFaceImage.getImageColorSpace Method

Gets face image data type. Java public FCRImageColorSpace getImageColorSpace(); Returns One of the FCRImageColorSpace values.
8.1.2.1.50.3.10 FCRFaceImage.getImageData Method

Gets image data. Java public ByteBuffer getImageData(); Returns ByteBuffer that contains image data.
8.1.2.1.50.3.11 FCRFaceImage.getImageDataType Method

Gets face image data type. Java public FCRImageDataType getImageDataType(); Returns One of the FCRImageDataType values.
8.1.2.1.50.3.12 FCRFaceImage.getPoseAnglePitch Method

Gets the face pitch angle in a face image. Java public double getPoseAnglePitch(); Returns The pitch angle of face pose in a FCRFaceImage ( see page 467).
8.1.2.1.50.3.13 FCRFaceImage.getPoseAnglePitchRaw Method

Gets the face pitch raw angle in a face image. Java public byte getPoseAnglePitchRaw(); Returns The face pitch raw angle in a face image.
8.1.2.1.50.3.14 FCRFaceImage.getPoseAngleRoll Method

Gets the face roll angle in a face image.
471
public double getPoseAngleRoll(); Returns The roll angle of face pose in a FCRFaceImage ( see page 467).
8.1.2.1.50.3.15 FCRFaceImage.getPoseAngleRollRaw Method

Gets the face roll raw angle in a face image. Java public byte getPoseAngleRollRaw(); Returns The face roll raw angle in a face image.
8.1.2.1.50.3.16 FCRFaceImage.getPoseAngleUncertaintyPitch Method

Gets the face pitch angle uncertainty in a face image. Java public double getPoseAngleUncertaintyPitch(); Returns The pitch angle uncertainty of face pose in a FCRFaceImage ( see page 467).
8.1.2.1.50.3.17 FCRFaceImage.getPoseAngleUncertaintyPitchRaw Method

Gets the face pitch raw angle uncertainty in a face image. Java public byte getPoseAngleUncertaintyPitchRaw(); Returns The face pitch raw angle uncertainty in a face image.
8.1.2.1.50.3.18 FCRFaceImage.getPoseAngleUncertaintyRoll Method

Gets the face roll angle uncertainty in a face image. Java public double getPoseAngleUncertaintyRoll(); Returns The roll angle uncertainty of face pose in a FCRFaceImage ( see page 467).
8.1.2.1.50.3.19 FCRFaceImage.getPoseAngleUncertaintyRollRaw Method

Gets the face roll raw angle uncertainty in a face image. Java public byte getPoseAngleUncertaintyRollRaw(); Returns The face roll raw angle uncertainty in a face image.
8.1.2.1.50.3.20 FCRFaceImage.getPoseAngleYaw Method

Gets face pose yaw angle in a face image.
472
public double getPoseAngleYaw(); Returns Face pose yaw angle in a face image.
8.1.2.1.50.3.21 FCRFaceImage.getPoseAngleYawRaw Method

Gets the face pose yaw raw angle in a face image. Java public byte getPoseAngleYawRaw(); Returns Face pose yaw raw angle in a face image.
8.1.2.1.50.3.22 FCRFaceImage.getProperties Method

Gets facial properties of a face in a face image. Java public EnumSet<BDIFFaceProperty> getProperties(); Returns Facial properties of a face in a face image.
8.1.2.1.50.3.23 FCRFaceImage.getQuality Method

Gets the face image quality. Java public short getQuality(); Returns The face image quality.
8.1.2.1.50.3.24 FCRFaceImage.getSourceType Method

Gets or sets face image source type. Java public BDIFImageSourceType getSourceType(); Returns The face image source type.
8.1.2.1.50.3.25 FCRFaceImage.getVendorExpression Method

Gets vendor specific expression of a face in a face image. Java public short getVendorExpression(); Returns Vendor specific expression of a face in a face image.
8.1.2.1.50.3.26 FCRFaceImage.getVendorImageColorSpace Method

Gets vendor specific color space of a face image.
473
public byte getVendorImageColorSpace(); Returns Vendor specific color space of a face image.
8.1.2.1.50.3.27 FCRFaceImage.getVendorSourceType Method

Gets vendor specific face image source type. Java public byte getVendorSourceType(); Returns Vendor specific face image source type.
8.1.2.1.50.3.28 FCRFaceImage.getWidth Method

Gets width of a face image. Java public short getWidth(); Returns Width of a face image.
8.1.2.1.50.3.29 FCRFaceImage.nativeTypeOf Method

8.1.2.1.50.3.30 FCRFaceImage.poseAngleUncertaintyYaw Method

Gets the face yaw angle uncertainty in a face image. Java public double poseAngleUncertaintyYaw(); Returns The yaw angle uncertainty of face pose in a FCRFaceImage ( see page 467).
8.1.2.1.50.3.31 FCRFaceImage.poseAngleUncertaintyYawRaw Method

Gets the face yaw raw angle uncertainty in a face image. Java public byte poseAngleUncertaintyYawRaw(); Returns The face yaw raw angle uncertainty in a face image.
8.1.2.1.50.3.32 FCRFaceImage.setDeviceType Method

Sets the face image capturing device type.
474
public void setDeviceType(short value); Parameters Parameters short value Description The face image capturing device type.
8.1.2.1.50.3.33 setExpression Method 8.1.2.1.50.3.33.1 FCRFaceImage.setExpression Method (BDIFFaceExpression)

Sets the expression of a face in a face image. Java public void setExpression(BDIFFaceExpression value); Parameters Parameters BDIFFaceExpression value Description One of the BDIFFaceExpression values.
8.1.2.1.50.3.33.2 FCRFaceImage.setExpression Method (BDIFFaceExpression, short)

Sets vendor specific expression of a face in a face image. Java public void setExpression(BDIFFaceExpression value, short vendorValue); Parameters Parameters BDIFFaceExpression value short vendorValue Description One of the BDIFFaceExpression values. Vendor value.
8.1.2.1.50.3.34 FCRFaceImage.setEyeColor Method

Sets the eye color of face in a face image. Java public void setEyeColor(BDIFEyeColor value); Parameters Parameters BDIFEyeColor value Description One of the BDIFGender values.
8.1.2.1.50.3.35 FCRFaceImage.setGender Method

Sets the gender of face in a face image. Java public void setGender(BDIFGender value); Parameters Parameters BDIFGender value Description One of the BDIFGender values.
8.1.2.1.50.3.36 setImageData Method
475
8.1 Java Reference
8.1.2.1.50.3.36.1 FCRFaceImage.setImageData Method (ByteBuffer)

Gets image data. Java public void setImageData(ByteBuffer value); Parameters Parameters ByteBuffer value Description ByteBuffer that contains image data.
8.1.2.1.50.3.36.2 FCRFaceImage.setImageData Method (ByteBuffer, boolean)

Gets image data. Java public void setImageData(ByteBuffer value, boolean copy); Parameters Parameters ByteBuffer value boolean copy Description ByteBuffer that contains image data. Defines if the ByteBuffer should be copied inside the object.
8.1.2.1.50.3.37 FCRFaceImage.setPoseAngle Method

Sets face pose angle in a face image. Java public void setPoseAngle(double yaw, double pitch, double roll); Parameters Parameters double yaw double pitch double roll Description The face pose yaw angle. The face pose pitch angle. The face pose roll angle.
8.1.2.1.50.3.38 FCRFaceImage.setPoseAnglePitch Method

Sets the face pose pitch angle in a face image. Java public void setPoseAnglePitch(double value); Parameters Parameters double value Description The pitch angle of face pose in a FCRFaceImage ( page 467). see
8.1.2.1.50.3.39 FCRFaceImage.setPoseAnglePitchRaw Method

Sets the face pitch raw angle in a face image. Java public void setPoseAnglePitchRaw(byte value); Parameters Parameters byte value Description The face pitch raw angle in a face image.
476
8.1 Java Reference
8.1.2.1.50.3.40 FCRFaceImage.setPoseAngleRaw Method

Sets face pose raw angle in a face image. Java public void setPoseAngleRaw(byte yaw, byte pitch, byte roll); Parameters Parameters byte yaw byte pitch byte roll Description The yaw raw angle of face pose in a FCRFaceImage ( page 467). The pitch raw angle of face pose in a FCRFaceImage ( page 467). The roll raw angle of face pose in a FCRFaceImage ( page 467). see see see
8.1.2.1.50.3.41 FCRFaceImage.setPoseAngleRoll Method

Sets the face roll angle in a face image. Java public void setPoseAngleRoll(double value); Parameters Parameters double value Description The pitch angle of face pose in a FCRFaceImage ( page 467). see
8.1.2.1.50.3.42 FCRFaceImage.setPoseAngleRollRaw Method

Sets the face roll raw angle in a face image. Java public void setPoseAngleRollRaw(byte value); Parameters Parameters byte value Description The face roll raw angle in a face image.
8.1.2.1.50.3.43 FCRFaceImage.setPoseAngleUncertainty Method

Sets face pose angle uncertainty in a face image. Java public void setPoseAngleUncertainty(double yaw, double pitch, double roll); Parameters Parameters double yaw double pitch double roll Description The face pose yaw angle uncertainty. The face pose pitch angle uncertainty. The face pose roll angle uncertainty.
8.1.2.1.50.3.44 FCRFaceImage.setPoseAngleUncertaintyRaw Method

Sets face pose angle uncertainty in a face image. Java public void setPoseAngleUncertaintyRaw(byte yaw, byte pitch, byte roll);
477
8.1 Java Reference Parameters Parameters byte yaw byte pitch byte roll
Description The yaw raw angle of face pose in a FCRFaceImage ( page 467). The pitch raw angle of face pose in a FCRFaceImage ( page 467). The roll raw angle of face pose in a FCRFaceImage ( page 467). see see see
8.1.2.1.50.3.45 FCRFaceImage.setPoseAngleYaw Method

Sets face pose yaw angle in a face image. Java public void setPoseAngleYaw(double value); Parameters Parameters double value Description Face pose yaw angle in a face image.
8.1.2.1.50.3.46 FCRFaceImage.setPoseAngleYawRaw Method

Sets the face pose yaw raw angle in a face image. Java public void setPoseAngleYawRaw(byte value); Parameters Parameters byte value Description Face pose yaw raw angle in a face image.
8.1.2.1.50.3.47 FCRFaceImage.setProperties Method

Sets facial properties of a face in a face image. Java public void setProperties(EnumSet<BDIFFaceProperty> value); Parameters Parameters EnumSet<BDIFFaceProperty> value Description Facial properties of a face in a face image.
8.1.2.1.50.3.48 FCRFaceImage.setQuality Method

Sets the face image quality. Java public void setQuality(short value); Parameters Parameters short value Description The face image quality.
8.1.2.1.50.3.49 setSourceType Method 8.1.2.1.50.3.49.1 FCRFaceImage.setSourceType Method (BDIFImageSourceType)

Gets or sets face image source type. 478
public void setSourceType(BDIFImageSourceType value); Parameters Parameters BDIFImageSourceType value Description The face image source type.
8.1.2.1.50.3.49.2 FCRFaceImage.setSourceType Method (BDIFImageSourceType, byte)

Sets face image source type. Java public void setSourceType(BDIFImageSourceType value, byte vendorValue); Parameters Parameters BDIFImageSourceType value byte vendorValue Description One of the BDIFImageSourceType values. Vendor value.
8.1.2.1.50.3.50 toNImage Method 8.1.2.1.50.3.50.1 FCRFaceImage.toNImage Method ()

Converts face image to NImage. Java public NImage toNImage(); Returns A NImage object.
8.1.2.1.50.3.50.2 FCRFaceImage.toNImage Method (int)

Converts face image to NImage. Java public NImage toNImage(int flags); Parameters Parameters int flags Returns A NImage object. Description Bitwise combination of zero or more flags that controls behavior of the constructor.
8.1.2.1.51 FIRecord Class

Provides functionality for managing FIRecord objects. Java public final class FIRecord extends NObject implements Cloneable; File FIRecord.java
479
8.1 Java Reference Methods Name FIRecord ( FIRecord Classes Name FingerCollection ( see page 480)
Description Initializes a new instance of the FIRecord class.
Description see page 483) see page Manages the FIRecord finger collection objects. Manages the FIRecord finger view collection objects.
FingerViewCollection ( 485) FIRecord Fields Name
Description
FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY Process first face image only. ( see page 485) MAX_FACE_IMAGE_COUNT ( FIRecord Methods Name calculateSize ( see page 485) see calculateSizeWithFingers ( page 485) getCaptureDeviceId ( 486) getCBEFFProductId ( 486) getFingers ( getFingerViews ( Description Calculates size of the FIRecord object with particular properties. Calculates the size of the FIRecord which contains fingerprints. Gets the capture device of FIRecord object id. Gets CBEFF product id. Gets fingers collection of FIRecord object. Gets fingers collection of FIRecord object. Gets the horizontal image resolution of the FIRecord object. Gets the horizontal scan resolution of the FIRecord object. Gets the image acquisition level. Gets the image compression algorithm of the FIRecord object. Gets the vertical image resolution of the FIRecord object. Gets scale units of the FIRecord object. Gets the FIRecord standard. Gets the vertical image resolution of the FIRecord object. Gets the vertical scan resolution of the FIRecord object. Retrieves a function that retrieves NType object for the enclosing type. Sets the capture device of FIRecord object id. Sets CBEFF product id. see page 485) Maximum number of faces in FIRecord.
see page see page
see page 486) see page 486) see see see
getHorzImageResolution ( page 486) getHorzScanResolution ( page 486) getImageAcquisitionLevel ( page 487)
getImageCompressionAlgorithm ( see page 487) getPixelDepth ( getScaleUnits ( getStandard ( see page 487) see page 487) see page 487) see see
getVertImageResolution ( page 487) getVertScanResolution ( page 488) nativeTypeOf ( setCaptureDeviceId ( 488) setCBEFFProductId ( 488)
8.1.2.1.51.1 FIRecord Constructor

8.1.2.1.51.1.1 FIRecord.FIRecord Constructor (ByteBuffer, BDIFStandard)
Initializes a new instance of the FIRecord class.
480
public FIRecord(ByteBuffer buffer, BDIFStandard standard); Parameters Parameters ByteBuffer buffer BDIFStandard standard Description ByteBuffer containing the FIRecord. Standard used in FIRecord.
8.1.2.1.51.1.2 FIRecord.FIRecord Constructor (ByteBuffer, int, BDIFStandard)

Initializes a new instance of the FIRecord class. Java public FIRecord(ByteBuffer buffer, int flags, BDIFStandard standard); Parameters Parameters ByteBuffer buffer int flags BDIFStandard standard Description ByteBuffer containing the FIRecord. Flags used in FIRecord. Standard used in FIRecord.
8.1.2.1.51.1.3 FIRecord.FIRecord Constructor (FIRecord, BDIFStandard)

Initializes a new instance of the FIRecord class. Java public FIRecord(FIRecord srcRecord, BDIFStandard standard); Parameters Parameters FIRecord srcRecord BDIFStandard standard Description The source of FIRecord. Standard used in FIRecord.
8.1.2.1.51.1.4 FIRecord.FIRecord Constructor (FIRecord, int, BDIFStandard)

Initializes a new instance of the FIRecord class. Java public FIRecord(FIRecord srcRecord, int flags, BDIFStandard standard); Parameters Parameters FIRecord srcRecord int flags Description The source of FIRecord. Flags used in FIRecord.The following flags are supported: FlagProcessFirstFingerOnly, FlagProcessFirstFingerViewOnly. Standard used in FIRecord.
8.1.2.1.51.1.5 FIRecord.FIRecord Constructor (NImage, short, BDIFScaleUnits, short, short, byte, FIRImageCompressionAlgorithm, BDIFFPPosition, BDIFStandard)
Initializes a new instance of the FIRecord class. Java public FIRecord(NImage nImage, short imageAcquisitionLevel, BDIFScaleUnits scaleUnits, short horzScanResolution, short vertScanResolution, byte pixelDepth, FIRImageCompressionAlgorithm imageCompressionAlgorithm, BDIFFPPosition fingerPosition, BDIFStandard standard); 481
8.1 Java Reference Parameters Parameters NImage nImage short imageAcquisitionLevel BDIFScaleUnits scaleUnits short horzScanResolution short vertScanResolution byte pixelDepth FIRImageCompressionAlgorithm imageCompressionAlgorithm BDIFFPPosition fingerPosition BDIFStandard standard
Description Variable of NImage type. Image acquisition level. Scale units of FIRecord object. Horizontal scan resolution of FIRecord object. Vertical scan resolution of FIRecord object. Pixel depth of FIRecord object. Image compression algorithm of FIRecord object. Finger position. Standard used in FIRecord.
8.1.2.1.51.1.6 FIRecord.FIRecord Constructor (NImage, short, BDIFScaleUnits, short, short, byte, FIRImageCompressionAlgorithm, BDIFFPPosition, int, BDIFStandard)
Initializes a new instance of the FIRecord class. Java public FIRecord(NImage nImage, short imageAcquisitionLevel, BDIFScaleUnits scaleUnits, short horzScanResolution, short vertScanResolution, byte pixelDepth, FIRImageCompressionAlgorithm imageCompressionAlgorithm, BDIFFPPosition fingerPosition, int flags, BDIFStandard standard); Parameters Parameters NImage nImage short imageAcquisitionLevel BDIFScaleUnits scaleUnits short horzScanResolution short vertScanResolution byte pixelDepth BDIFFPPosition fingerPosition int flags BDIFStandard standard imageCompressionAlgorithmImage Description Variable of NImage type. Image acquisition level. Scale units of FIRecord object. Horizontal scan resolution of FIRecord object. Vertical scan resolution of FIRecord object. Pixel depth of FIRecord object. Finger position. Flags used in FIRecord. Standard used in FIRecord. compression algorithm of FIRecord object.
8.1.2.1.51.1.7 FIRecord.FIRecord Constructor (short, BDIFScaleUnits, short, short, short, short, byte, FIRImageCompressionAlgorithm, BDIFStandard)
Initializes a new instance of the FIRecord class. Java public FIRecord(short imageAcquisitionLevel, BDIFScaleUnits scaleUnits, short horzScanResolution, short vertScanResolution, short horzImageResolution, short vertImageResolution, byte pixelDepth, FIRImageCompressionAlgorithm imageCompressionAlgorithm, BDIFStandard standard); Parameters Parameters short imageAcquisitionLevel BDIFScaleUnits scaleUnits short horzScanResolution short vertScanResolution short horzImageResolution Description Image acquisition level. Scale units of FIRecord object. Horizontal scan resolution of FIRecord object. Vertical scan resolution of FIRecord object. Horizontal image resolution of FIRecord object. 482
8.1 Java Reference short vertImageResolution byte pixelDepth FIRImageCompressionAlgorithm imageCompressionAlgorithm BDIFStandard standard
Vertical image resolution of FIRecord object. Pixel depth of FIRecord object. Image compression algorithm of FIRecord object. Standard used in FIRecord.
8.1.2.1.51.1.8 FIRecord.FIRecord Constructor (short, BDIFScaleUnits, short, short, short, short, byte, FIRImageCompressionAlgorithm, int, BDIFStandard)
Initializes a new instance of the FIRecord class. Java public FIRecord(short imageAcquisitionLevel, BDIFScaleUnits scaleUnits, short horzScanResolution, short vertScanResolution, short horzImageResolution, short vertImageResolution, byte pixelDepth, FIRImageCompressionAlgorithm imageCompressionAlgorithm, int flags, BDIFStandard standard); Parameters Parameters short imageAcquisitionLevel BDIFScaleUnits scaleUnits short horzScanResolution short vertScanResolution short horzImageResolution short vertImageResolution byte pixelDepth FIRImageCompressionAlgorithm imageCompressionAlgorithm int flags BDIFStandard standard Description Image acquisition level. Scale units of FIRecord object. Horizontal scan resolution of FIRecord object. Vertical scan resolution of FIRecord object. Horizontal image resolution of FIRecord object. Vertical image resolution of FIRecord object. Pixel depth of FIRecord object. Image compression algorithm of FIRecord object. Flags used in FIRecord. Standard used in FIRecord.
8.1.2.1.51.2 FIRecord Classes

8.1.2.1.51.2.1 FIRecord.FingerCollection Class
Manages the FIRecord ( Java public final class FingerCollection extends NObjectCollection<FIRFinger>; File FIRecord.java FingerCollection Methods Name add ( see page 483) Description Adds an object to the end of the fingers collection. see page 479) finger collection objects.
8.1.2.1.51.2.1.1 FingerCollection Methods 8.1.2.1.51.2.1.1.1 add Method 8.1.2.1.51.2.1.1.1.1 FIRecord.FingerCollection.add Method (BDIFFPPosition)
Adds an object to the end of the fingers collection.
483
public FIRFinger add(BDIFFPPosition fingerPosition); Parameters Parameters BDIFFPPosition fingerPosition Returns A reference to FIRFinger ( see page 488) object that references the newly created empty FIRFinger ( object in the FIRecord ( see page 479) fingers collection. see page 488) Description Finger position.
8.1.2.1.51.2.1.1.1.2 FIRecord.FingerCollection.add Method (BDIFFPPosition, NImage)

Adds an object to the end of the fingers collection. Java public FIRFinger add(BDIFFPPosition fingerPosition, NImage nImage); Parameters Parameters BDIFFPPosition fingerPosition NImage nImage Returns A reference to FIRFinger ( see page 488) object that references the newly created empty FIRFinger ( object in the FIRecord ( see page 479) fingers collection. see page 488) Description Finger position. An object of NImage type.
8.1.2.1.51.2.1.1.1.3 FIRecord.FingerCollection.add Method (BDIFFPPosition, NImage, int)

Adds an object to the end of the fingers collection. Java public FIRFinger add(BDIFFPPosition fingerPosition, NImage nImage, int flags); Parameters Parameters BDIFFPPosition fingerPosition NImage nImage int flags Returns A reference to FIRFinger ( see page 488) object that references the newly created empty FIRFinger ( object in the FIRecord ( see page 479) fingers collection. see page 488) Description Finger position. An object of NImage type. Flags used in FIRecord ( see page 479).
8.1.2.1.51.2.1.1.1.4 FIRecord.FingerCollection.add Method (BDIFFPPosition, int)

Adds an object to the end of the fingers collection. Java public FIRFinger add(BDIFFPPosition fingerPosition, int flags); Parameters Parameters BDIFFPPosition fingerPosition int flags Description Finger position. Flags used in FIRecord ( see page 479).
484
A reference to FIRFinger ( see page 488) object that references the newly created empty FIRFinger ( object in the FIRecord ( see page 479) fingers collection.
see page 488)
8.1.2.1.51.2.2 FIRecord.FingerViewCollection Class

Manages the FIRecord ( Java public final class FingerViewCollection extends NObjectCollection<FIRFingerView>; File FIRecord.java see page 479) finger view collection objects.
8.1.2.1.51.3 FIRecord Fields

8.1.2.1.51.3.1 FIRecord.FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY Field
8.1.2.1.51.3.2 FIRecord.MAX_FACE_IMAGE_COUNT Field

Maximum number of faces in FIRecord ( Java public static final int MAX_FACE_IMAGE_COUNT = Short.MAX_VALUE; see page 479).
8.1.2.1.51.4 FIRecord Methods

8.1.2.1.51.4.1 FIRecord.calculateSize Method
Calculates size of the FIRecord ( Java public static int calculateSize(BDIFStandard standard, int[] fingerViewSizes); Parameters Parameters BDIFStandard standard int[] fingerViewSizes Returns The size of the FIRecord ( see page 479). Description Standard used in FIRecord ( see page 479). see Sizes of finger views that will be stored on FIRecord ( page 479). see page 479) object with particular properties.
8.1.2.1.51.4.2 FIRecord.calculateSizeWithFingers Method

Calculates the size of the FIRecord ( Java public static int calculateSizeWithFingers(BDIFStandard standard, int[] fingerSizes); Parameters Parameters BDIFStandard standard Description Standard used in FIRecord ( see page 479). 485 see page 479) which contains fingerprints.
8.1 Java Reference int[] fingerSizes Returns The size of the FIRecord (
com.neurotec.biometrics.standards see page
Sizes of finger that will be stored on FIRecord ( 479).
see page 479).
8.1.2.1.51.4.3 FIRecord.getCaptureDeviceId Method

Gets the capture device of FIRecord ( Java public short getCaptureDeviceId(); Returns The capture device of FIRecord ( see page 479) object id. see page 479) object id.
8.1.2.1.51.4.4 FIRecord.getCBEFFProductId Method

Gets CBEFF product id. Java public int getCBEFFProductId(); Returns The cbeff product id.
8.1.2.1.51.4.5 FIRecord.getFingers Method

Gets fingers collection of FIRecord ( Java public FingerCollection getFingers(); Returns Fingers collection of FIRecord ( see page 479) object. see page 479) object.
8.1.2.1.51.4.6 FIRecord.getFingerViews Method

Gets fingers collection of FIRecord ( Java public FingerViewCollection getFingerViews(); Returns Fingers collection of FIRecord ( see page 479) object. see page 479) object.
8.1.2.1.51.4.7 FIRecord.getHorzImageResolution Method

Gets the horizontal image resolution of the FIRecord ( Java public short getHorzImageResolution(); Returns The horizontal image resolution of the FIRecord ( see page 479) object. see page 479) object.
8.1.2.1.51.4.8 FIRecord.getHorzScanResolution Method

Gets the horizontal scan resolution of the FIRecord ( see page 479) object.
486
public short getHorzScanResolution(); Returns The horizontal scan resolution of the FIRecord ( see page 479) object.
8.1.2.1.51.4.9 FIRecord.getImageAcquisitionLevel Method

Gets the image acquisition level. Java public short getImageAcquisitionLevel(); Returns The image acquisition level.
8.1.2.1.51.4.10 FIRecord.getImageCompressionAlgorithm Method

Gets the image compression algorithm of the FIRecord ( Java public FIRImageCompressionAlgorithm getImageCompressionAlgorithm(); Returns The image compression algorithm of the FIRecord ( see page 479) object. see page 479) object.
8.1.2.1.51.4.11 FIRecord.getPixelDepth Method

Gets the vertical image resolution of the FIRecord ( Java public byte getPixelDepth(); Returns The vertical image resolution of the FIRecord ( see page 479) object. see page 479) object.
8.1.2.1.51.4.12 FIRecord.getScaleUnits Method

Gets scale units of the FIRecord ( Java public BDIFScaleUnits getScaleUnits(); Returns Scale units of the FIRecord ( see page 479) object. see page 479) object.
8.1.2.1.51.4.13 FIRecord.getStandard Method

Gets the FIRecord ( Java public BDIFStandard getStandard(); Returns One of the BDIFStandard values. see page 479) standard.
8.1.2.1.51.4.14 FIRecord.getVertImageResolution Method

Gets the vertical image resolution of the FIRecord ( see page 479) object.
487
public short getVertImageResolution(); Returns The vertical image resolution of the FIRecord ( see page 479) object.
8.1.2.1.51.4.15 FIRecord.getVertScanResolution Method

Gets the vertical scan resolution of the FIRecord ( Java public short getVertScanResolution(); Returns The vertical scan resolution of the FIRecord ( see page 479) object. see page 479) object.
8.1.2.1.51.4.16 FIRecord.nativeTypeOf Method

8.1.2.1.51.4.17 FIRecord.setCaptureDeviceId Method

Sets the capture device of FIRecord ( Java public void setCaptureDeviceId(short value); Parameters Parameters short value Description The capture device of FIRecord ( see page 479) object id. see page 479) object id.
8.1.2.1.51.4.18 FIRecord.setCBEFFProductId Method

Sets CBEFF product id. Java public void setCBEFFProductId(int value); Parameters Parameters int value Description The cbeff product id.
8.1.2.1.52 FIRFinger Class

Provides functionality for working with the FIRFinger objects. Java public final class FIRFinger extends NObject; File FIRFinger.java
488
8.1 Java Reference FIRFinger Classes Name FingerViewCollection ( 489) FIRFinger Fields Name
Description see page Class for working with FingerViewCollection objects.
Description
FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY The flag used to indicate to process only the first finger ( see page 490) view in the FIRFinger finger views collection. MAX_FINGER_VIEW_COUNT ( FIRFinger Methods Name calculateSize ( getFingerViews ( getPosition ( nativeTypeOf ( setPosition ( see page 491) see page 491) see page 491) see page 491) Description Calculates size of the FIRFinger object. Returns a collection of finger view objects. Gets position of the FIRFingerView ( FIRFinger object. Sets position of the FIRFingerView ( FIRFinger object. see page 492) object in the see page 491) A maximum number of finger views used in finger views collection of FIRFinger object.
Retrieves a function that retrieves NType object for the enclosing type. see page 492) object in the
see page 492)
8.1.2.1.52.1 FIRFinger Classes

8.1.2.1.52.1.1 FIRFinger.FingerViewCollection Class
Class for working with FingerViewCollection objects. Java public final class FingerViewCollection extends NObjectCollection<FIRFingerView>; File FIRFinger.java FingerViewCollection Methods Name add ( see page 489) Description Adds an object to the end of the finger view collection.
8.1.2.1.52.1.1.1 FingerViewCollection Methods 8.1.2.1.52.1.1.1.1 add Method 8.1.2.1.52.1.1.1.1.1 FIRFinger.FingerViewCollection.add Method (NImage)
Adds an object to the end of the finger view collection. Java public FIRFingerView add(NImage nImage); Parameters Parameters NImage nImage Returns The handle to the added finger view in the FIRFinger ( see page 488). Description An image.
489
8.1 Java Reference
8.1.2.1.52.1.1.1.1.2 FIRFinger.FingerViewCollection.add Method (NImage, int)

Adds an object to the end of the finger view collection. Java public FIRFingerView add(NImage nImage, int flags); Parameters Parameters NImage nImage int flags Returns The handle to the added finger view in the FIRFinger ( see page 488). Description An image. Bitwise combination of zero or more flags that controls behavior of the function.
8.1.2.1.52.1.1.1.1.3 FIRFinger.FingerViewCollection.add Method (short, short, ByteBuffer)

Adds an object to the end of the finger view collection. Java public FIRFingerView add(short horzLineLength, short vertLineLength, ByteBuffer imageData); Parameters Parameters short horzLineLength short vertLineLength ByteBuffer imageData Returns The handle to the added finger view in the FIRFinger ( see page 488). Description Length of the horizontal finger view line Length of the vertical finger view line. Memory buffer containing image data.
8.1.2.1.52.1.1.1.1.4 FIRFinger.FingerViewCollection.add Method (short, short, ByteBuffer, int)

Adds an object to the end of the finger view collection. Java public FIRFingerView add(short horzLineLength, short vertLineLength, ByteBuffer imageData, int flags); Parameters Parameters short horzLineLength short vertLineLength ByteBuffer imageData int flags Returns The handle to the added finger view in the FIRFinger ( see page 488). Description Length of the horizontal finger view line Length of the vertical finger view line. Memory buffer containing image data. Bitwise combination of zero or more flags that controls behavior of the function.
8.1.2.1.52.2 FIRFinger Fields

8.1.2.1.52.2.1 FIRFinger.FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY Field
The flag used to indicate to process only the first finger view in the FIRFinger ( see page 488) finger views collection.
490
public static final int FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY = 0x00001000;
8.1.2.1.52.2.2 FIRFinger.MAX_FINGER_VIEW_COUNT Field

A maximum number of finger views used in finger views collection of FIRFinger ( Java public static final int MAX_FINGER_VIEW_COUNT = 255; see page 488) object.
8.1.2.1.52.3 FIRFinger Methods

8.1.2.1.52.3.1 FIRFinger.calculateSize Method
Calculates size of the FIRFinger ( Java public static int calculateSize(BDIFStandard standard, int[] fingerViewSizes); Parameters Parameters BDIFStandard standard int[] fingerViewSizes Returns Size of the FIRFinger ( see page 488). Description Standard to use in the method. An array of sizes of finger views that will be stored on FCRecord ( see page 461). see page 488) object.
8.1.2.1.52.3.2 FIRFinger.getFingerViews Method

Returns a collection of finger view objects. Java public FingerViewCollection getFingerViews(); Returns Collection of finger view objects.
8.1.2.1.52.3.3 FIRFinger.getPosition Method

Gets position of the FIRFingerView ( Java public BDIFFPPosition getPosition(); Returns Position of the FIRFingerView ( see page 492) object in the FIRFinger ( see page 488) object. see page 492) object in the FIRFinger ( see page 488) object.
8.1.2.1.52.3.4 FIRFinger.nativeTypeOf Method

491
8.1 Java Reference
8.1.2.1.52.3.5 FIRFinger.setPosition Method

Sets position of the FIRFingerView ( Java public void setPosition(BDIFFPPosition value); Parameters Parameters BDIFFPPosition value Description Position of the FIRFingerView ( see page 492) object in the FIRFinger ( see page 488) object. see page 492) object in the FIRFinger ( see page 488) object.
8.1.2.1.53 FIRFingerView Class

Class for working with the FIRFingerView objects. Java public final class FIRFingerView extends NObject; File FIRFingerView.java FIRFingerView Methods Name calculateSize ( see page 492) see page getHorzLineLength ( 493) getImageData ( getImageQuality ( Description Calculates size of the FIRFingerView object with particular properties. Gets horizontal line length. Gets image data. Gets image quality value. Gets the impression type. Gets the FIRFingerView position value. Gets the FIRFingerView object views count. Gets a number of the FIRFingerView object views. Retrieves a function that retrieves NType object for the enclosing type. Sets image data. Sets image quality value. Sets the impression type. Converts the FIRFingerView object to the NImage.
getImpressionType ( 493) getPosition ( getVertLineLength ( getViewCount ( getViewNumber ( nativeTypeOf ( setImageData ( setImageQuality (
see page 493) see page 494) see page 494) see page 494) see page 495) see page see page 494)
see page 493) Gets vertical line length.
setImpressionType ( 495) toNImage (
see page 495)
8.1.2.1.53.1 FIRFingerView Methods

8.1.2.1.53.1.1 FIRFingerView.calculateSize Method
Calculates size of the FIRFingerView ( Java public static int calculateSize(BDIFStandard standard, int imageDataLength); Parameters Parameters BDIFStandard standard Description BDIFStandard used by this method for calculating the size of the FIRFingerView ( see page 492) object. 492 see page 492) object with particular properties.
8.1 Java Reference int imageDataLength Returns The size of the FIRFingerView (
Finger view image data length.
see page 492) with such properties.
8.1.2.1.53.1.2 FIRFingerView.getHorzLineLength Method

Gets horizontal line length. Java public short getHorzLineLength(); Returns The horizontal line length.
8.1.2.1.53.1.3 FIRFingerView.getImageData Method

Gets image data. Java public ByteBuffer getImageData(); Returns Bytebuffer that contains image data.
8.1.2.1.53.1.4 FIRFingerView.getImageQuality Method

Gets image quality value. Java public byte getImageQuality(); Returns The image quality value.
8.1.2.1.53.1.5 FIRFingerView.getImpressionType Method

Gets the impression type. Java public BDIFFPImpressionType getImpressionType(); Returns The impression type.
8.1.2.1.53.1.6 FIRFingerView.getPosition Method

Gets the FIRFingerView ( Java public BDIFFPPosition getPosition(); Returns FIRFingerView ( see page 492) position value. see page 492) position value.
8.1.2.1.53.1.7 FIRFingerView.getVertLineLength Method

Gets vertical line length.
493
public short getVertLineLength(); Returns The vertical line length.
8.1.2.1.53.1.8 FIRFingerView.getViewCount Method

Gets the FIRFingerView ( Java public int getViewCount(); Returns FIRFingerView ( see page 492) object views count. see page 492) object views count.
8.1.2.1.53.1.9 FIRFingerView.getViewNumber Method

Gets a number of the FIRFingerView ( Java public int getViewNumber(); Returns FIRFingerView ( see page 492) object view number. see page 492) object views.
8.1.2.1.53.1.10 FIRFingerView.nativeTypeOf Method

8.1.2.1.53.1.11 setImageData Method 8.1.2.1.53.1.11.1 FIRFingerView.setImageData Method (ByteBuffer)

Sets image data. Java public void setImageData(ByteBuffer value); Parameters Parameters ByteBuffer value Description ByteBuffer that contains image data.
8.1.2.1.53.1.11.2 FIRFingerView.setImageData Method (ByteBuffer, boolean)

Sets image data. Java public void setImageData(ByteBuffer value, boolean copy); Parameters Parameters ByteBuffer value Description ByteBuffer that contains image data. 494
8.1 Java Reference boolean copy
Defines if the ByteBuffer should be copied inside the object.
8.1.2.1.53.1.12 FIRFingerView.setImageQuality Method

Sets image quality value. Java public void setImageQuality(byte value); Parameters Parameters byte value Description The image quality value.
8.1.2.1.53.1.13 FIRFingerView.setImpressionType Method

Sets the impression type. Java public void setImpressionType(BDIFFPImpressionType value); Parameters Parameters BDIFFPImpressionType value Description The impression type
8.1.2.1.53.1.14 toNImage Method 8.1.2.1.53.1.14.1 FIRFingerView.toNImage Method ()

Converts the FIRFingerView ( Java public NImage toNImage(); Returns Reference to the NImage object. This reference receives the newly created NImage handle. see page 492) object to the NImage.
8.1.2.1.53.1.14.2 FIRFingerView.toNImage Method (int)

Converts FIRFingerView ( Java public NImage toNImage(int flags); Parameters Parameters int flags Returns Reference to the NImage object. This reference receives the newly created NImage handle. Description Bitwise combination of zero or more flags that controls behavior of the constructor. see page 492) object to the NImage.
8.1.2.1.54 FMCard Class

Provides functionality for converting ISO/IEC 19794-2:2005 card format standard templates to and from Neurotechnology Finger Records (NFRecords). Java public final class FMCard; 495
8.1 Java Reference File FMCard.java FMCard Fields Name
Description Default maximal minutia count for enrollment. Default maximal minutia count for verification. Default minimal minutia count for enrollment. Default maximal minutia count for verification.
DEFAULT_MAX_ENROLL_MC ( see page 496) DEFAULT_MAX_VERIFY_MC ( see page 496) DEFAULT_MIN_ENROLL_MC ( see page 496) DEFAULT_MIN_VERIFY_MC ( see page 496) FMCard Methods Name nativeTypeOf ( see page 497) see see see readCompactSizeMinutiae ( page 497) readNormalSizeMinutiae ( page 498) writeCompactSizeMinutiae ( page 499) writeNormalSizeMinutiae ( page 500)
Description Retrieves a function that retrieves NType object for the enclosing type. Reads compact size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Reads normal size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Converts the NFRecord ( see page 110) to compact size ISO/IEC 19794-2:2005 card format standard template and writes it to memory buffer. Converts NFRecord ( see page 110) to normal size ISO/IEC 19794-2:2005 card format standard template and writes it to memory buffer.
see
8.1.2.1.54.1 FMCard Fields

8.1.2.1.54.1.1 FMCard.DEFAULT_MAX_ENROLL_MC Field
Default maximal minutia count for enrollment. Java public static final int DEFAULT_MAX_ENROLL_MC = 60;
8.1.2.1.54.1.2 FMCard.DEFAULT_MAX_VERIFY_MC Field

Default maximal minutia count for verification. Java public static final int DEFAULT_MAX_VERIFY_MC = 60;
8.1.2.1.54.1.3 FMCard.DEFAULT_MIN_ENROLL_MC Field

Default minimal minutia count for enrollment. Java public static final int DEFAULT_MIN_ENROLL_MC = 16;
8.1.2.1.54.1.4 FMCard.DEFAULT_MIN_VERIFY_MC Field

Default maximal minutia count for verification. Java public static final int DEFAULT_MIN_VERIFY_MC = 12;
8.1.2.1.54.2 FMCard Methods

496
8.1 Java Reference
8.1.2.1.54.2.1 FMCard.nativeTypeOf Method

8.1.2.1.54.2.2 readCompactSizeMinutiae Method 8.1.2.1.54.2.2.1 FMCard.readCompactSizeMinutiae Method (ByteBuffer, FMCMinutiaOrder)

Reads compact size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Java public static NFRecord readCompactSizeMinutiae(ByteBuffer buffer, FMCMinutiaOrder order); Parameters Parameters ByteBuffer buffer FMCMinutiaOrder order Returns The NFRecord ( see page 110) object. Description Byte array that contains minutiae. Order in which minutiae are in the memory buffer.
8.1.2.1.54.2.2.2 FMCard.readCompactSizeMinutiae Method (ByteBuffer, FMCMinutiaOrder, int)

Reads compact size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Java public static NFRecord readCompactSizeMinutiae(ByteBuffer buffer, FMCMinutiaOrder order, int flags); Parameters Parameters ByteBuffer buffer FMCMinutiaOrder order int flags Returns The NFRecord ( see page 110) object. Description Byte array that contains minutiae. Order in which minutiae are in the memory buffer. Reserved, must be zero.
8.1.2.1.54.2.2.3 FMCard.readCompactSizeMinutiae Method (byte[], FMCMinutiaOrder)

Reads compact size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Java public static NFRecord readCompactSizeMinutiae(byte[] buffer, FMCMinutiaOrder order); Parameters Parameters byte[] buffer Description Byte array that contains minutiae.
497
8.1 Java Reference FMCMinutiaOrder order Returns The NFRecord ( see page 110) object.
Order in which minutiae are in the memory buffer.
8.1.2.1.54.2.3 readNormalSizeMinutiae Method 8.1.2.1.54.2.3.1 FMCard.readNormalSizeMinutiae Method (ByteBuffer, FMCMinutiaOrder)

Reads normal size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Java public static NFRecord readNormalSizeMinutiae(ByteBuffer buffer, FMCMinutiaOrder order); Parameters Parameters ByteBuffer buffer FMCMinutiaOrder order Returns The NFRecord ( see page 110) object. Description Byte array that contains minutiae. Order in which minutiae are in the memory buffer.
8.1.2.1.54.2.3.2 FMCard.readNormalSizeMinutiae Method (ByteBuffer, FMCMinutiaOrder, int)

Reads normal size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Java public static NFRecord readNormalSizeMinutiae(ByteBuffer buffer, FMCMinutiaOrder order, int flags); Parameters Parameters ByteBuffer buffer FMCMinutiaOrder order int flags Returns The NFRecord ( see page 110) object. Description Byte array that contains minutiae. Order in which minutiae are in the memory buffer. Reserved, must be zero.
8.1.2.1.54.2.3.3 FMCard.readNormalSizeMinutiae Method (byte[], FMCMinutiaOrder)

Reads normal size ISO/IEC 19794-2:2005 card format standard template from byte array and converts it to NFRecord ( see page 110). Java public static NFRecord readNormalSizeMinutiae(byte[] buffer, FMCMinutiaOrder order); Parameters Parameters byte[] buffer FMCMinutiaOrder order Returns The NFRecord ( see page 110) object. Description Byte array that contains minutiae. Order in which minutiae are in the memory buffer.
498
8.1 Java Reference
8.1.2.1.54.2.4 writeCompactSizeMinutiae Method 8.1.2.1.54.2.4.1 FMCard.writeCompactSizeMinutiae Method (NFRecord, FMCMinutiaOrder)

Converts the NFRecord ( it to memory buffer. Java public static ByteBuffer writeCompactSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order); Parameters Parameters NFRecord nfRecord FMCMinutiaOrder order Returns Byte array with minutiae. If the FMCMinutiaOrder is specified in FMCard.writeNormalSizeMinutiae ( see page 500), it needs to define which sort will be used (ascending or descending). The minutiae sorting using FMCMinutiaOrder.POLAR example: ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.POLAR, FMCMinutiaOrder.ASCENDING)); or ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.POLAR, FMCMinutiaOrder.DESCENDING)); Only for FMCMinutiaOrder.NONE and FMCMinutiaOrder.X_OR_Y_COORDINATE_EXTENSION sorting is not needed: ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.NONE)); ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.X_OR_Y_COORDINATE_EXTENSION)); Description The NFRecord ( see page 110) object. Order in which minutiae are in the memory buffer. see page 110) to compact size ISO/IEC 19794-2:2005 card format standard template and writes
8.1.2.1.54.2.4.2 FMCard.writeCompactSizeMinutiae Method (NFRecord, FMCMinutiaOrder, ByteBuffer)

Converts the NFRecord ( it to memory buffer. Java public static int writeCompactSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order, ByteBuffer buffer); Parameters Parameters NFRecord nfRecord FMCMinutiaOrder order ByteBuffer buffer Returns Byte array size. Description The NFRecord ( see page 110) object. Order in which minutiae are in the memory buffer. Byte array to which the template is written. see page 110) to compact size ISO/IEC 19794-2:2005 card format standard template and writes
8.1.2.1.54.2.4.3 FMCard.writeCompactSizeMinutiae Method (NFRecord, FMCMinutiaOrder, ByteBuffer, int)

Converts the NFRecord ( it to memory buffer. Java public static int writeCompactSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order, ByteBuffer buffer, int flags); Parameters Parameters NFRecord nfRecord Description The NFRecord ( see page 110) object. 499 see page 110) to compact size ISO/IEC 19794-2:2005 card format standard template and writes
8.1 Java Reference FMCMinutiaOrder order ByteBuffer buffer int flags Returns Byte array size.
Order in which minutiae are in the memory buffer. Byte array to which the template is written. Reserved, must be zero.
8.1.2.1.54.2.4.4 FMCard.writeCompactSizeMinutiae Method (NFRecord, FMCMinutiaOrder, int)

Converts the NFRecord ( it to memory buffer. Java public static ByteBuffer writeCompactSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order, int flags); Parameters Parameters NFRecord nfRecord FMCMinutiaOrder order int flags Returns Byte array with minutiae. If the FMCMinutiaOrder is specified in FMCard.writeNormalSizeMinutiae ( see page 500), it needs to define which sort will be used (ascending or descending). The minutiae sorting using FMCMinutiaOrder.POLAR example: ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.POLAR, FMCMinutiaOrder.ASCENDING)); or ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.POLAR, FMCMinutiaOrder.DESCENDING)); Only for FMCMinutiaOrder.NONE and FMCMinutiaOrder.X_OR_Y_COORDINATE_EXTENSION sorting is not needed: ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.NONE)); ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae ( see page 500)(nfrecord, EnumSet.of(FMCMinutiaOrder.X_OR_Y_COORDINATE_EXTENSION)); Description The NFRecord ( see page 110) object. Order in which minutiae are in the memory buffer. Reserved, must be zero. see page 110) to compact size ISO/IEC 19794-2:2005 card format standard template and writes
8.1.2.1.54.2.5 writeNormalSizeMinutiae Method 8.1.2.1.54.2.5.1 FMCard.writeNormalSizeMinutiae Method (NFRecord, FMCMinutiaOrder)

Converts NFRecord ( memory buffer. Java public static ByteBuffer writeNormalSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order); Parameters Parameters NFRecord nfRecord FMCMinutiaOrder order Returns Byte array with minutiae. If the FMCMinutiaOrder is specified in FMCard.writeNormalSizeMinutiae, it needs to define which sort will be used (ascending or descending). The minutiae sorting using FMCMinutiaOrder.POLAR example: ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae(nfrecord, EnumSet.of(FMCMinutiaOrder.POLAR, FMCMinutiaOrder.ASCENDING)); or ByteBuffer fmcard = FMCard.writeNormalSizeMinutiae(nfrecord, EnumSet.of(FMCMinutiaOrder.POLAR, FMCMinutiaOrder.DESCENDING)); Only for FMCMinutiaOrder.NONE and FMCMinutiaOrder.X_OR_Y_COORDINATE_EXTENSION sorting is not needed: ByteBuffer fmcard = 500 Description The NFRecord ( see page 110) object. Order in which minutiae are in the memory buffer. see page 110) to normal size ISO/IEC 19794-2:2005 card format standard template and writes it to
8.1 Java Reference
com.neurotec.biometrics.standards =
FMCard.writeNormalSizeMinutiae(nfrecord, EnumSet.of(FMCMinutiaOrder.NONE)); ByteBuffer fmcard FMCard.writeNormalSizeMinutiae(nfrecord, EnumSet.of(FMCMinutiaOrder.X_OR_Y_COORDINATE_EXTENSION));
8.1.2.1.54.2.5.2 FMCard.writeNormalSizeMinutiae Method (NFRecord, FMCMinutiaOrder, ByteBuffer)

Converts the NFRecord ( to byte array. Java public static int writeNormalSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order, ByteBuffer buffer); Parameters Parameters NFRecord nfRecord FMCMinutiaOrder order ByteBuffer buffer Returns Byte array size. Description The NFRecord ( see page 110) object. Order in which minutiae are in the memory buffer. Byte array to which the template is written. see page 110) to normal size ISO/IEC 19794-2:2005 card format standard template and writes it
8.1.2.1.54.2.5.3 FMCard.writeNormalSizeMinutiae Method (NFRecord, FMCMinutiaOrder, ByteBuffer, int)

Converts the NFRecord ( to byte array. Java public static int writeNormalSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order, ByteBuffer buffer, int flags); Parameters Parameters NFRecord nfRecord FMCMinutiaOrder order ByteBuffer buffer int flags Returns Byte array size. Description The NFRecord ( see page 110) object. Order in which minutiae are in the memory buffer. Byte array to which the template is written. Reserved, must be zero. see page 110) to normal size ISO/IEC 19794-2:2005 card format standard template and writes it
8.1.2.1.54.2.5.4 FMCard.writeNormalSizeMinutiae Method (NFRecord, FMCMinutiaOrder, int)

Converts the NFRecord ( to byte array. Java public static ByteBuffer writeNormalSizeMinutiae(NFRecord nfRecord, FMCMinutiaOrder order, int flags); Parameters Parameters NFRecord nfRecord FMCMinutiaOrder order int flags Returns Byte array with minutiae. Description The NFRecord ( see page 110) object. Order in which minutiae are in the memory buffer. Reserved, must be zero. see page 110) to normal size ISO/IEC 19794-2:2005 card format standard template and writes it
501
8.1 Java Reference
8.1.2.1.55 FMCBDTTags Class

Provides constants for ISO/IEC 7816-11:2004 Biometric data template. Java public final class FMCBDTTags; File FMCBDTTags.java FMCBDTTags Fields Name CELL_QUALITY_DATA ( page 502) CORE_POINT_DATA ( 502) DELTA_POINT_DATA ( 502) see see page Description Tag for storing cell quality data in ISO/IEC 7816-11:2004 Biometric data template. Tag for storing core point data in ISO/IEC 7816-11:2004 Biometric data template.
see page Tag for storing delta point data in ISO/IEC 7816-11:2004 Biometric data template. see Tag for storing finger minutiae data in ISO/IEC 7816-11:2004 Biometric data template. Tag for storing ridge count data in ISO/IEC 7816-11:2004 Biometric data template.
FINGER_MINUTIAE_DATA ( page 502) RIDGE_COUNT_DATA ( page 502) see
8.1.2.1.55.1 FMCBDTTags Fields

8.1.2.1.55.1.1 FMCBDTTags.CELL_QUALITY_DATA Field
Tag for storing cell quality data in ISO/IEC 7816-11:2004 Biometric data template. Java public static final int CELL_QUALITY_DATA = 0x94;
8.1.2.1.55.1.2 FMCBDTTags.CORE_POINT_DATA Field

Tag for storing core point data in ISO/IEC 7816-11:2004 Biometric data template. Java public static final int CORE_POINT_DATA = 0x92;
8.1.2.1.55.1.3 FMCBDTTags.DELTA_POINT_DATA Field

Tag for storing delta point data in ISO/IEC 7816-11:2004 Biometric data template. Java public static final int DELTA_POINT_DATA = 0x93;
8.1.2.1.55.1.4 FMCBDTTags.FINGER_MINUTIAE_DATA Field

Tag for storing finger minutiae data in ISO/IEC 7816-11:2004 Biometric data template. Java public static final int FINGER_MINUTIAE_DATA = 0x90;
8.1.2.1.55.1.5 FMCBDTTags.RIDGE_COUNT_DATA Field

Tag for storing ridge count data in ISO/IEC 7816-11:2004 Biometric data template. Java public static final int RIDGE_COUNT_DATA = 0x91;
502
8.1 Java Reference
8.1.2.1.56 FMCBITBHTBAPTTags Class

Provides constants for ISO/IEC 7816-11:2004 Biometric algorithm parameters template in Biometric header template in Biometric information template. Java public final class FMCBITBHTBAPTTags; File FMCBITBHTBAPTTags.java FMCBITBHTBAPTTags Fields Name Description
FEATURE_HANDLING_INDICATOR Tag for storing FMCFeatureHandling value in ISO/IEC 7816-11:2004 ( see page 503) Biometric algorithm parameters template in Biometric header template in Biometric information template. MINUTIAE_ORDER ( 503) see page Tag for storing FMCMinutiaOrder value in ISO/IEC 7816-11:2004 Biometric algorithm parameters template in Biometric header template in Biometric information template. Tag for storing minimal and maximal number of minutiae in ISO/IEC 7816-11:2004 Biometric algorithm parameters template in Biometric header template in Biometric information template.
NUMBER_OF_MINUTIAE ( page 503)
see
8.1.2.1.56.1 FMCBITBHTBAPTTags Fields

8.1.2.1.56.1.1 FMCBITBHTBAPTTags.FEATURE_HANDLING_INDICATOR Field
Tag for storing FMCFeatureHandling value in ISO/IEC 7816-11:2004 Biometric algorithm parameters template in Biometric header template in Biometric information template. Java public static final int FEATURE_HANDLING_INDICATOR = 0x83;
8.1.2.1.56.1.2 FMCBITBHTBAPTTags.MINUTIAE_ORDER Field

Tag for storing FMCMinutiaOrder value in ISO/IEC 7816-11:2004 Biometric algorithm parameters template in Biometric header template in Biometric information template. Java public static final int MINUTIAE_ORDER = 0x82;
8.1.2.1.56.1.3 FMCBITBHTBAPTTags.NUMBER_OF_MINUTIAE Field

Tag for storing minimal and maximal number of minutiae in ISO/IEC 7816-11:2004 Biometric algorithm parameters template in Biometric header template in Biometric information template. Java public static final int NUMBER_OF_MINUTIAE = 0x81;
8.1.2.1.57 FMRCore Class

Core structure of ANSI/INCIST 378 2004 standard template. Java public final class FMRCore; File FMRCore.java
503
8.1 Java Reference Methods Name FMRCore ( FMRCore Fields Name angle ( x( y( FMRCore Methods Name getAngle ( see page 505) getAnsiAngle ( getIsoAngle ( setAngle ( setAnsiAngle ( setIsoAngle ( see page 505) see page 505) see page 505) see page 504)
Description Initializes a new instance of the FMRCore class.
Description The angle of the core. The x-coordinate of the core. The y-coordinate of the core.
Description Gets the angle ( Gets raw angle ( Gets raw angle ( Sets the angle ( Sets raw angle ( Sets raw angle ( see page 505) of the core. see page 505) of core by ANSI. see page 505) of core by ISO. see page 505) of the core. see page 505) of core by ANSI. see page 505) of core by ISO. see page 505) see page 506) see page 506) see page 506)
see page 506)
8.1.2.1.57.1 FMRCore Constructor

8.1.2.1.57.1.1 FMRCore.FMRCore Constructor ()
Initializes a new instance of the FMRCore class. Java public FMRCore();
8.1.2.1.57.1.2 FMRCore.FMRCore Constructor (short, short)

Initializes a new instance of the FMRCore class. Java public FMRCore(short x, short y); Parameters Parameters short x short y Description The x ( The y ( see page 505) - coordinate of the core. see page 505) - coordinate of the core.
8.1.2.1.57.1.3 FMRCore.FMRCore Constructor (short, short, double, BDIFStandard)

Initializes a new instance of the FMRCore class. Java public FMRCore(short x, short y, double angle, BDIFStandard standard); Parameters Parameters short x short y double angle BDIFStandard standard Description The x ( The y ( see page 505) - coordinate of the core. see page 505) - coordinate of the core. see page 505) of the core.
The angle (
One of the BDIFStandard values.
504
8.1 Java Reference
8.1.2.1.57.1.4 FMRCore.FMRCore Constructor (short, short, int)

Initializes a new instance of the FMRCore class. Java public FMRCore(short x, short y, int angle); Parameters Parameters short x short y int angle Description The x ( The y ( see page 505) - coordinate of the core. see page 505) - coordinate of the core. see page 505) of the core.
The angle (
8.1.2.1.57.2 FMRCore Fields

8.1.2.1.57.2.1 FMRCore.angle Field
The angle of the core. Java public int angle;
8.1.2.1.57.2.2 FMRCore.x Field

The x-coordinate of the core. Java public short x;
8.1.2.1.57.2.3 FMRCore.y Field

The y-coordinate of the core. Java public short y;
8.1.2.1.57.3 FMRCore Methods

8.1.2.1.57.3.1 FMRCore.getAngle Method
Gets the angle ( Java public double getAngle(BDIFStandard standard); Parameters Parameters BDIFStandard standard Returns The angle ( see page 505) of the core. Description One of the BDIFStandard values. see page 505) of the core.
8.1.2.1.57.3.2 FMRCore.getAnsiAngle Method

Gets raw angle ( Java public double getAnsiAngle(); see page 505) of core by ANSI.
505
8.1 Java Reference Returns Raw angle (
see page 505) of core by ANSI.
8.1.2.1.57.3.3 FMRCore.getIsoAngle Method

Gets raw angle ( Java public double getIsoAngle(); Returns Raw angle ( see page 505) of core by ISO. see page 505) of core by ISO.
8.1.2.1.57.3.4 FMRCore.setAngle Method

Sets the angle ( Java public void setAngle(double value, BDIFStandard standard); Parameters Parameters double value BDIFStandard standard Description Angle of core. One of the BDIFStandard values. see page 505) of the core.
8.1.2.1.57.3.5 FMRCore.setAnsiAngle Method

Sets raw angle ( Java public void setAnsiAngle(double value); Parameters Parameters angle Description Raw angle ( see page 505) of core by ANSI. see page 505) of core by ANSI.
8.1.2.1.57.3.6 FMRCore.setIsoAngle Method

Sets raw angle ( Java public void setIsoAngle(double value); Parameters Parameters angle Description Raw angle ( see page 505) of core by ISO. see page 505) of core by ISO.
8.1.2.1.58 FMRDelta Class

Delta structure of ANSI/INCIST 378 2004 standard template. Java public final class FMRDelta; File FMRDelta.java
506
8.1 Java Reference Methods Name FMRDelta ( FMRDelta Fields Name angle1 ( angle2 ( angle3 ( x( y( FMRDelta Methods Name getAngle1 ( getAngle2 ( getAngle3 ( see page 509) see page 509) see page 509) see page 508) see page 508) see page 508) see page 507)
Description Initializes a new instance of the FMRDelta class.
Description The first angle of the delta. The second angle of the delta. The third angle of the delta. X coordinate of the delta. Y coordinate of the delta.
Description Gets first angle of this FMRDelta. Gets second angle of this FMRDelta. Gets third angle of this FMRDelta. Gets first angle of this FMRDelta. Gets second angle of this FMRDelta. Gets third angle of this FMRDelta. Gets first angle of this FMRDelta. Gets second angle of this FMRDelta. Gets third angle of this FMRDelta. Sets first angle of this FMRDelta. Sets second angle of this FMRDelta. Sets third angle of this FMRDelta. Sets first angle of this FMRDelta. Sets second angle of this FMRDelta. Sets third angle of this FMRDelta. Sets first angle of this FMRDelta. Sets second angle of this FMRDelta. Sets third angle of this FMRDelta.
getAnsiAngle1 ( getAnsiAngle2 ( getAnsiAngle3 ( getIsoAngle1 ( getIsoAngle2 ( getIsoAngle3 ( setAngle1 ( setAngle2 ( setAngle3 (
see page 510) see page 511) see page 511) see page 511) see page 511) see page 511) see page 512) see page 512) see page 512)
setAnsiAngle1 ( setAnsiAngle2 ( setAnsiAngle3 ( setIsoAngle1 ( setIsoAngle2 ( setIsoAngle3 (
8.1.2.1.58.1 FMRDelta Constructor

8.1.2.1.58.1.1 FMRDelta.FMRDelta Constructor ()
Initializes a new instance of the FMRDelta class. Java public FMRDelta();
8.1.2.1.58.1.2 FMRDelta.FMRDelta Constructor (short, short)

Initializes a new instance of the FMRDelta class. Java public FMRDelta(short x, short y); Parameters Parameters short x short y Description The x ( The y ( see page 508) - coordinate of the core. see page 509) - coordinate of the core. 507
8.1 Java Reference
8.1.2.1.58.1.3 FMRDelta.FMRDelta Constructor (short, short, double, double, double, BDIFStandard)

Initializes a new instance of the FMRDelta class. Java public FMRDelta(short x, short y, double angle1, double angle2, double angle3, BDIFStandard standard); Parameters Parameters short x short y double angle1 double angle2 double angle3 BDIFStandard standard Description The x ( The y ( see page 508) - coordinate of the core. see page 509) - coordinate of the core.
The first angle of the delta. The second angle of the delta. The third angle of the delta. One of BDIFStandard values.
8.1.2.1.58.1.4 FMRDelta.FMRDelta Constructor (short, short, int, int, int)

Initializes a new instance of the FMRDelta class. Java public FMRDelta(short x, short y, int angle1, int angle2, int angle3); Parameters Parameters short x short y int angle1 int angle2 int angle3 Description The x ( The y ( see page 508) - coordinate of the core. see page 509) - coordinate of the core.
The first angle of the delta. The second angle of the delta. The third angle of the delta.
8.1.2.1.58.2 FMRDelta Fields

8.1.2.1.58.2.1 FMRDelta.angle1 Field
The first angle of the delta. Java public int angle1;

The second angle of the delta. Java public int angle2;

The third angle of the delta. Java public int angle3;
8.1.2.1.58.2.4 FMRDelta.x Field

X coordinate of the delta.
508
8.1 Java Reference Java public short x;
8.1.2.1.58.2.5 FMRDelta.y Field

Y coordinate of the delta. Java public short y;
8.1.2.1.58.3 FMRDelta Methods

8.1.2.1.58.3.1 FMRDelta.getAngle1 Method
Gets first angle of this FMRDelta ( Java public double getAngle1(BDIFStandard standard); Parameters Parameters BDIFStandard standard Returns The first angle of the delta. Description One of the BDIFStandard values. see page 506).

Gets second angle of this FMRDelta ( Java public double getAngle2(BDIFStandard standard); Parameters Parameters BDIFStandard standard Returns The second angle of the delta. Description One of the BDIFStandard values. see page 506).

Gets third angle of this FMRDelta ( Java public double getAngle3(BDIFStandard standard); Parameters Parameters BDIFStandard standard Returns The third angle of the delta. Description One of the BDIFStandard values. see page 506).
8.1.2.1.58.3.4 FMRDelta.getAnsiAngle1 Method

Gets first angle of this FMRDelta ( see page 506).
509
8.1 Java Reference Java public double getAnsiAngle1(); Returns First angle of this FMRDelta (
see page 506).

Gets second angle of this FMRDelta ( Java public double getAnsiAngle2(); Returns Second angle of this FMRDelta ( see page 506). see page 506).

Gets third angle of this FMRDelta ( Java public double getAnsiAngle3(); Returns Third angle of this FMRDelta ( see page 506). see page 506).
8.1.2.1.58.3.7 FMRDelta.getIsoAngle1 Method

Gets first angle of this FMRDelta ( Java public double getIsoAngle1(); Returns First angle of this FMRDelta ( see page 506). see page 506).

Gets second angle of this FMRDelta ( Java public double getIsoAngle2(); Returns Second angle of this FMRDelta ( see page 506). see page 506).

Gets third angle of this FMRDelta ( Java public double getIsoAngle3(); Returns Third angle of this FMRDelta ( see page 506). see page 506).
8.1.2.1.58.3.10 FMRDelta.setAngle1 Method

Sets first angle of this FMRDelta ( see page 506).
510
public void setAngle1(double value, BDIFStandard standard); Parameters Parameters double value BDIFStandard standard Description The first angle of the delta. One of the BDIFStandard values.

Sets second angle of this FMRDelta ( Java public void setAngle2(double value, BDIFStandard standard); Parameters Parameters double value BDIFStandard standard Description The second angle of the delta. One of the BDIFStandard values. see page 506).

Sets third angle of this FMRDelta ( Java public void setAngle3(double value, BDIFStandard standard); Parameters Parameters double value BDIFStandard standard Description The third angle of the delta. One of the BDIFStandard values. see page 506).
8.1.2.1.58.3.13 FMRDelta.setAnsiAngle1 Method

Sets first angle of this FMRDelta ( Java public void setAnsiAngle1(double value); Parameters Parameters angle Description First angle of this FMRDelta ( see page 506). see page 506).

Sets second angle of this FMRDelta ( Java public void setAnsiAngle2(double value); Parameters Parameters angle Description Second angle of this FMRDelta ( see page 506). see page 506).

Sets third angle of this FMRDelta ( see page 506).
511
public void setAnsiAngle3(double value); Parameters Parameters angle Description Third angle of this FMRDelta ( see page 506).
8.1.2.1.58.3.16 FMRDelta.setIsoAngle1 Method

Sets first angle of this FMRDelta ( Java public void setIsoAngle1(double value); Parameters Parameters angle Description First angle of this FMRDelta ( see page 506). see page 506).

Sets second angle of this FMRDelta ( Java public void setIsoAngle2(double value); Parameters Parameters angle Description Second angle of this FMRDelta ( see page 506). see page 506).

Sets third angle of this FMRDelta ( Java public void setIsoAngle3(double value); Parameters Parameters angle Description Third angle of this FMRDelta ( see page 506). see page 506).
8.1.2.1.59 FMRecord Class

Provides functionality for loading, editing, saving and converting ANSI INCITS 378-2004 and ISO/IEC 19794-2:2005 record format standard templates (FMRecords) to and/or from Neurotechnology Fingers Templates (NFTemplates) and Neurotechnology Templates (NTemplates). Java public final class FMRecord extends NObject implements Cloneable; File FMRecord.java Methods Name FMRecord ( see page 513) Description Initializes a new instance of the FMRecord class.
512
8.1 Java Reference FMRecord Classes Name FingerCollection (
Description see page 516) see page Manages the FMRecord finger collection objects. Manages the FMRecord finger view collection objects.
FingerViewCollection ( 517) FMRecord Fields Name
Description
FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY Process first face image only. ( see page 517) MAX_FACE_IMAGE_COUNT ( FMRecord Methods Name calculateSize ( see page 517) see Description Calculates size of the FMRecord with BDIFStandard and sizes of each finger view specified. Calculates the size of the FMRecord which contains fingerprints. Gets the capture Equipment Compliance from FMRecord object. Gets the capture equipment id from FMRecord object. Gets CBEFF product id. Gets the collection of FMRFinger ( see page 521). see page 524). see page 517) Maximum number of faces in FMRecord.
calculateSizeWithFingers ( page 518)
getCaptureEquipmentCompliance ( see page 518) getCaptureEquipmentId ( page 518) getCBEFFProductId ( 518) getFingers ( getFingerViews ( getResolutionX ( getResolutionY ( getSizeX ( getSizeY ( see
see page
Gets the collection of FMRFingerView (
Gets the horizontal resolution of scanned image from FMRecord. Gets the vertical resolution of scanned image from FMRecord. Gets the horizontal size of scanned image from FMRecord object. Gets the vertical size of scanned image from FMRecord object. Gets the FMRecord standard. Retrieves a function that retrieves NType object for the enclosing type. Sets the capture Equipment Compliance from FMRecord object. Gets the capture equipment id from FMRecord object. Sets CBEFF product id. Creates NFTemplate ( Creates NTemplate ( see page 130) object from FMRecord. see page 210) object from FMRecord.
getStandard ( nativeTypeOf (
setCaptureEquipmentCompliance ( see page 520) setCaptureEquipmentId ( page 520) setCBEFFProductId ( 520) toNFTemplate ( toNTemplate ( see
see page
8.1.2.1.59.1 FMRecord Constructor

8.1.2.1.59.1.1 FMRecord.FMRecord Constructor (ByteBuffer, BDIFStandard)
Initializes a new instance of the FMRecord class. Java public FMRecord(ByteBuffer buffer, BDIFStandard standard); Parameters Parameters ByteBuffer buffer Description ByteBuffer containing the FMRecord.
513
8.1 Java Reference BDIFStandard standard
Standard used in FMRecord.
8.1.2.1.59.1.2 FMRecord.FMRecord Constructor (ByteBuffer, int, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(ByteBuffer buffer, int flags, BDIFStandard standard); Parameters Parameters ByteBuffer buffer int flags BDIFStandard standard Description ByteBuffer containing the FMRecord. Flags used in FMRecord. Standard used in FMRecord.
8.1.2.1.59.1.3 FMRecord.FMRecord Constructor (FMRecord, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(FMRecord srcRecord, BDIFStandard standard); Parameters Parameters FMRecord srcRecord BDIFStandard standard Description The FMRecord object. Specifies the standard of the FMRecord.
8.1.2.1.59.1.4 FMRecord.FMRecord Constructor (FMRecord, int, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(FMRecord srcRecord, int flags, BDIFStandard standard); Parameters Parameters FMRecord srcRecord int flags Description The FMRecord object. Flags used in FMRecord.The following flags are supported: FlagProcessFirstFingerOnly, FlagProcessFirstFingerViewOnly. Specifies the standard of the FMRecord.
8.1.2.1.59.1.5 FMRecord.FMRecord Constructor (NFRecord, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(NFRecord nfRecord, BDIFStandard standard); Parameters Parameters NFRecord nfRecord BDIFStandard standard Description The NFRecord ( see page 110) object. Specifies the standard of the FMRecord.
8.1.2.1.59.1.6 FMRecord.FMRecord Constructor (NFRecord, int, BDIFStandard)

Initializes a new instance of the FMRecord class.
514
public FMRecord(NFRecord nfRecord, int flags, BDIFStandard standard); Parameters Parameters NFRecord nfRecord int flags Description The NFRecord ( see page 110) object. Flags used in FMRecord.The following flags are supported: FlagProcessFirstFingerOnly, FlagProcessFirstFingerViewOnly. Specifies the standard of the FMRecord.
8.1.2.1.59.1.7 FMRecord.FMRecord Constructor (NFTemplate, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(NFTemplate nfTemplate, BDIFStandard standard); Parameters Parameters NFTemplate nfTemplate BDIFStandard standard Description The NFTemplate ( see page 130) object. Specifies the standard of the FMRecord.
8.1.2.1.59.1.8 FMRecord.FMRecord Constructor (NFTemplate, int, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(NFTemplate nfTemplate, int flags, BDIFStandard standard); Parameters Parameters NFTemplate nfTemplate int flags Description The NFTemplate ( see page 130) object. Flags used in FMRecord.The following flags are supported: FlagProcessFirstFingerOnly, FlagProcessFirstFingerViewOnly. Specifies the standard of the FMRecord.
8.1.2.1.59.1.9 FMRecord.FMRecord Constructor (short, short, short, short, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(short sizeX, short sizeY, short resolutionX, short resolutionY, BDIFStandard standard); Parameters Parameters short sizeX short sizeY short resolutionX short resolutionY BDIFStandard standard Description Specifies horizontal size of fingerprint image. Specifies vertical size of fingerprint image. Specifies horizontal resolution in pixels per centimeter of fingerprint image. Specifies vertical resolution in pixels per centimeter of fingerprint image. Standard used in FMRecord.
515
8.1 Java Reference
8.1.2.1.59.1.10 FMRecord.FMRecord Constructor (short, short, short, short, int, BDIFStandard)

Initializes a new instance of the FMRecord class. Java public FMRecord(short sizeX, short sizeY, short resolutionX, short resolutionY, int flags, BDIFStandard standard); Parameters Parameters short sizeX short sizeY short resolutionX short resolutionY int flags BDIFStandard standard Description Specifies horizontal size of fingerprint image. Specifies vertical size of fingerprint image. Specifies horizontal resolution in pixels per centimeter of fingerprint image. Specifies vertical resolution in pixels per centimeter of fingerprint image. Flags used in FMRecord. Standard used in FMRecord.
8.1.2.1.59.2 FMRecord Classes

8.1.2.1.59.2.1 FMRecord.FingerCollection Class
Manages the FMRecord ( Java public final class FingerCollection extends NObjectCollection<FMRFinger>; File FMRecord.java FingerCollection Methods Name add ( see page 516) Description Adds an object to the end of the fingers collection. see page 512) finger collection objects.
8.1.2.1.59.2.1.1 FingerCollection Methods 8.1.2.1.59.2.1.1.1 add Method 8.1.2.1.59.2.1.1.1.1 FMRecord.FingerCollection.add Method (BDIFFPPosition)
Adds an object to the end of the fingers collection. Java public FMRFinger add(BDIFFPPosition fingerPosition); Parameters Parameters BDIFFPPosition fingerPosition Returns A reference to FMRFinger ( see page 521) object that references the newly created empty FMRFinger ( object in the FMRecord ( see page 512) fingers collection. see page 521) Description Finger position.
8
8.1.2.1.59.2.1.1.1.2 FMRecord.FingerCollection.add Method (BDIFFPPosition, int)
Adds an object to the end of the fingers collection. 516
public FMRFinger add(BDIFFPPosition fingerPosition, int flags); Parameters Parameters BDIFFPPosition fingerPosition int flags Returns A reference to FMRFinger ( see page 521) object that references the newly created empty FMRFinger ( object in the FMRecord ( see page 512) fingers collection. see page 521) Description Finger position. Flags used in FMRecord ( see page 512).
8.1.2.1.59.2.2 FMRecord.FingerViewCollection Class

Manages the FMRecord ( Java public final class FingerViewCollection extends NObjectCollection<FMRFingerView>; File FMRecord.java see page 512) finger view collection objects.
8.1.2.1.59.3 FMRecord Fields

8.1.2.1.59.3.1 FMRecord.FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY Field
8.1.2.1.59.3.2 FMRecord.MAX_FACE_IMAGE_COUNT Field

Maximum number of faces in FMRecord ( Java public static final int MAX_FACE_IMAGE_COUNT = Short.MAX_VALUE; see page 512).
8.1.2.1.59.4 FMRecord Methods

8.1.2.1.59.4.1 FMRecord.calculateSize Method
Calculates size of the FMRecord ( Java public static int calculateSize(BDIFStandard standard, int[] fingerViewSizes); Parameters Parameters BDIFStandard standard int[] fingerViewSizes Returns The packed size of the FMRecord ( see page 512) object. Description Standard of the FMRecord ( finger views will be stored. see page 512) in which the see page 512) with BDIFStandard and sizes of each finger view specified.
Array of Sizes of the finger views that will be stored on the FMRecord ( see page 512).
517
8.1 Java Reference
8.1.2.1.59.4.2 FMRecord.calculateSizeWithFingers Method

Calculates the size of the FMRecord ( Java public static int calculateSizeWithFingers(BDIFStandard standard, int[] fingerSizes); Parameters Parameters BDIFStandard standard int[] fingerSizes Returns The size of the FMRecord ( see page 512). Description Standard used in FMRecord ( see page 512). see page Sizes of finger that will be stored on FMRecord ( 512). see page 512) which contains fingerprints.
8.1.2.1.59.4.3 FMRecord.getCaptureEquipmentCompliance Method

Gets the capture Equipment Compliance from FMRecord ( Java public FMRCaptureEquipmentCompliance getCaptureEquipmentCompliance(); Returns The capture Equipment Compliance. see page 512) object.
8.1.2.1.59.4.4 FMRecord.getCaptureEquipmentId Method

Gets the capture equipment id from FMRecord ( Java public short getCaptureEquipmentId(); Returns The capture equipment id from FMRecord ( see page 512) object. see page 512) object.
8.1.2.1.59.4.5 FMRecord.getCBEFFProductId Method

Gets CBEFF product id. Java public int getCBEFFProductId(); Returns The cbeff product id.
8.1.2.1.59.4.6 FMRecord.getFingers Method

Gets the collection of FMRFinger ( Java public FingerCollection getFingers(); Returns Fingers collection of FMRFinger ( see page 521) object. see page 521).
8.1.2.1.59.4.7 FMRecord.getFingerViews Method

Gets the collection of FMRFingerView ( see page 524).
518
public FingerViewCollection getFingerViews(); Returns Fingers collection of FMRFingerView ( see page 524) object.
8.1.2.1.59.4.8 FMRecord.getResolutionX Method

Gets the horizontal resolution of scanned image from FMRecord ( Java public short getResolutionX(); Returns The horizontal resolution in pixels per centimeter of scanned image. see page 512).
8.1.2.1.59.4.9 FMRecord.getResolutionY Method

Gets the vertical resolution of scanned image from FMRecord ( Java public short getResolutionY(); Returns The vertical resolution in pixels per centimeter of scanned image. see page 512).
8.1.2.1.59.4.10 FMRecord.getSizeX Method

Gets the horizontal size of scanned image from FMRecord ( Java public short getSizeX(); Returns The horizontal size of scanned image. see page 512) object.
8.1.2.1.59.4.11 FMRecord.getSizeY Method

Gets the vertical size of scanned image from FMRecord ( Java public short getSizeY(); Returns The vertical size of scanned image. see page 512) object.
8.1.2.1.59.4.12 FMRecord.getStandard Method

Gets the FMRecord ( Java public BDIFStandard getStandard(); Returns One of the BDIFStandard values. see page 512) standard.
8.1.2.1.59.4.13 FMRecord.nativeTypeOf Method

519
8.1.2.1.59.4.14 FMRecord.setCaptureEquipmentCompliance Method

Sets the capture Equipment Compliance from FMRecord ( Java public void setCaptureEquipmentCompliance(FMRCaptureEquipmentCompliance value); Parameters Parameters FMRCaptureEquipmentCompliance value Description The capture Equipment Compliance. see page 512) object.
8.1.2.1.59.4.15 FMRecord.setCaptureEquipmentId Method

Gets the capture equipment id from FMRecord ( Java public void setCaptureEquipmentId(short value); Parameters Parameters short value Description The capture equipment id from FMRecord ( object. see page 512) see page 512) object.
8.1.2.1.59.4.16 FMRecord.setCBEFFProductId Method

Sets CBEFF product id. Java public void setCBEFFProductId(int value); Parameters Parameters int value Description The cbeff product id.
8.1.2.1.59.4.17 toNFTemplate Method 8.1.2.1.59.4.17.1 FMRecord.toNFTemplate Method ()

Creates NFTemplate ( Java public NFTemplate toNFTemplate(); Returns The NFTemplate ( see page 130) object. see page 130) object from FMRecord ( see page 512).
8.1.2.1.59.4.17.2 FMRecord.toNFTemplate Method (int)

Creates NFTemplate ( Java public NFTemplate toNFTemplate(int flags); see page 130) object from FMRecord ( see page 512).
520
8.1 Java Reference Parameters Parameters int flags Returns The NFTemplate (
Description Bitwise combination of zero or more flags that controls behavior of the constructor.
8.1.2.1.59.4.18 toNTemplate Method 8.1.2.1.59.4.18.1 FMRecord.toNTemplate Method ()

Creates NTemplate ( Java public NTemplate toNTemplate(); Returns The NTemplate ( see page 210) object. see page 210) object from FMRecord ( see page 512).
8.1.2.1.59.4.18.2 FMRecord.toNTemplate Method (int)

Creates NTemplate ( Java public NTemplate toNTemplate(int flags); Parameters Parameters int flags Returns The NTemplate ( see page 210) object. Description Bitwise combination of zero or more flags that controls behavior of the constructor. see page 210) object from FMRecord ( see page 512).
8.1.2.1.60 FMRFinger Class

Library for working with FMRFinger class object. Java public final class FMRFinger extends NObject; File FMRFinger.java FMRFinger Classes Name FingerViewCollection ( 522) FMRFinger Fields Name Description see page Description Represents FMRFinger class FingerView collection.
FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY The flag used to indicate to process only the first finger ( see page 523) view in finger views collection. MAX_FINGER_VIEW_COUNT ( see page 523) A maximum number of finger views used in finger views of the FMRFinger object.
521
8.1 Java Reference FMRFinger Methods Name calculateSize ( getFingerViews ( getPosition ( nativeTypeOf ( setPosition (
Description see page 523) see page 523) see page 523) see page 523) see page 524) Calculates size of the FMRFinger object with particular properties. Returns a collection of finger view objects. Gets position of the finger. Retrieves a function that retrieves NType object for the enclosing type. Sets position of the finger.
8.1.2.1.60.1 FMRFinger Classes

8.1.2.1.60.1.1 FMRFinger.FingerViewCollection Class
Represents FMRFinger ( Java public final class FingerViewCollection extends NObjectCollection<FMRFingerView>; File FMRFinger.java FingerViewCollection Methods Name add ( see page 522) Description Adds an object to the end of the fingers collection. see page 521) class FingerView collection.
8.1.2.1.60.1.1.1 FingerViewCollection Methods 8.1.2.1.60.1.1.1.1 add Method 8.1.2.1.60.1.1.1.1.1 FMRFinger.FingerViewCollection.add Method ()

Adds an object to the end of the fingers collection. Java public FMRFingerView add(); Returns FMRFingerView ( see page 524) object.
8.1.2.1.60.1.1.1.1.2 FMRFinger.FingerViewCollection.add Method (int)

Adds an object to the end of the fingers collection. Java public FMRFingerView add(int flags); Parameters Parameters int flags Returns FMRFingerView ( see page 524) object. Description Bitwise combination of zero or more flags that controls behavior of the function.
8.1.2.1.60.2 FMRFinger Fields
522
8.1 Java Reference
8.1.2.1.60.2.1 FMRFinger.FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY Field

The flag used to indicate to process only the first finger view in finger views collection. Java public static final int FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY = 0x00001000;
8.1.2.1.60.2.2 FMRFinger.MAX_FINGER_VIEW_COUNT Field

A maximum number of finger views used in finger views of the FMRFinger ( Java public static final int MAX_FINGER_VIEW_COUNT = 16; see page 521) object.
8.1.2.1.60.3 FMRFinger Methods

8.1.2.1.60.3.1 FMRFinger.calculateSize Method
Calculates size of the FMRFinger ( Java public static int calculateSize(BDIFStandard standard, int[] fingerViewSizes); Parameters Parameters BDIFStandard standard int[] fingerViewSizes Returns The size of FMRFinger ( see page 521). Description Standard to use in the method. Sizes of FMRFingerView ( see page 524). see page 521) object with particular properties.
8.1.2.1.60.3.2 FMRFinger.getFingerViews Method

Returns a collection of finger view objects. Java public FingerViewCollection getFingerViews(); Returns Collection of finger view objects.
8.1.2.1.60.3.3 FMRFinger.getPosition Method

Gets position of the finger. Java public BDIFFPPosition getPosition(); Returns Position of the finger.
8.1.2.1.60.3.4 FMRFinger.nativeTypeOf Method

Retrieves a function that retrieves NType object for the enclosing type. Java public static NType nativeTypeOf(); Returns The function that retrieves NType object for the enclosing type. 523
8.1 Java Reference
8.1.2.1.60.3.5 FMRFinger.setPosition Method

Sets position of the finger. Java public void setPosition(BDIFFPPosition value); Parameters Parameters BDIFFPPosition value Description Position of the finger.
8.1.2.1.61 FMRFingerView Class

Provides functionality for editing and converting ANSI INCITS 378-2004 and ISO/ IEC 19794-2:2005 record format standard templates finger views (FmrFingerViews) to Neurotechnology Finger Records (NFRecords). Java public final class FMRFingerView extends NObject; File FMRFingerView.java FMRFingerView Classes Name CoreCollection ( DeltaCollection ( MinutiaCollection ( see page 525) see page 525) see page 525) Description Represents the FMRCore ( see page 503) collection. see page 506). see page 110). see page 110). see page 106). Represents the collection of the FMRDelta ( Represents the collection of NFMinutia (
MinutiaEightNeighborsCollection ( see page 526) MinutiaFourNeighborsCollection ( see page 526) FMRFingerView Fields Name
Represents the collection of NFMinutiaNeighbor ( Represents the collection of NFMinutiaNeighbor (
Description
FLAG_PROCESS_ALL_EXTENDED_DATA For internal use. ( see page 526) FLAG_SKIP_NEUROTEC_FIELDS ( page 526) FLAG_SKIP_RIDGE_COUNTS ( page 526) see see see see The flag indicating whether fields of Neurotechnology should be skipped while loading or saving FMRFingerView. The flag indicating whether ridge counts should be skipped while loading or saving FMRFingerView. The flag indicating whether singular points (cores and deltas) should be skipped while loading or saving FMRFingerView. The flag indicating whether fields of Neurotechnology should be used while loading or saving FMRFingerView. The maximum number of cores a FMRFingerView can contain. The maximum number of deltas a FMRFingerView can contain. The maximum value for x and y coordinates of a minutia, core or delta in a FMRFingerView. The maximum number of minutiae a FMRFingerView can contain.
FLAG_SKIP_SINGULAR_POINTS ( page 526) FLAG_USE_NEUROTEC_FIELDS ( page 526) MAX_CORE_COUNT ( MAX_DELTA_COUNT ( MAX_DIMENSION (
MAX_MINUTIA_COUNT ( FMRFingerView Methods Name getCores ( getDeltas ( see page 527) see page 527)
Description Gets cores collection. Gets deltas collection. Gets fingerprint quality. 524
getFingerQuality (
see page 527)
8.1 Java Reference getImpressionType ( 528) getMaxSize (
see page
Gets the impression type of the finger record. Retrieves the maximal size of a FMRFingerView in stored FMRecord ( see page 512) containing the specified number of minutiae, cores and deltas and specified ridge counts. Gets minutiae collection.
see page 528)
getMinutiae (
getMinutiaeEightNeighbors ( page 529) getMinutiaeFourNeighbors ( page 529) getPosition ( see page 529) getViewCount ( getViewNumber (
Gets minutia eight neighbors collection. Gets minutia four neighbors collection. Gets the FMRFingerView position value. Retrieves the view number of items in the FMRFingerView. Gets a number of the FIRFingerView ( see page 492) object views. Gets a value indicating whether FMRecord ( see page 512) finger view has ridge counts to eight neighbor of each minutia. Gets a value indicating whether FMRecord ( see page 512) finger view has ridge counts to four neighbor of each minutia. Retrieves a function that retrieves NType object for the enclosing type. Sets fingerprint quality. Gets a value indicating whether FMRecord ( see page 512) finger view has ridge counts to eight neighbor of each minutia. Gets a value indicating whether FMRecord ( see page 512) finger view has ridge counts to four neighbor of each minutia. Sets the impression type of the finger record. Creates NFRecord ( see page 110) object from FMRFingerView.
isHasEightNeighborRidgeCounts ( see page 530) isHasFourNeighborRidgeCounts ( see page 530) nativeTypeOf ( see page 530) see page 530) setFingerQuality (
setHasEightNeighborRidgeCounts ( see page 531) setHasFourNeighborRidgeCounts ( see page 531) setImpressionType ( 531) toNFRecord ( see page
see page 531)
8.1.2.1.61.1 FMRFingerView Classes

8.1.2.1.61.1.1 FMRFingerView.CoreCollection Class
Represents the FMRCore ( Java public final class CoreCollection extends NStructureCollection<FMRCore, FMRCoreData>; File FMRFingerView.java see page 503) collection.
8.1.2.1.61.1.2 FMRFingerView.DeltaCollection Class

Represents the collection of the FMRDelta ( Java public final class DeltaCollection extends NStructureCollection<FMRDelta, FMRDeltaData>; File FMRFingerView.java see page 506).
8.1.2.1.61.1.3 FMRFingerView.MinutiaCollection Class

Represents the collection of NFMinutia ( Java public final class MinutiaCollection extends NStructureCollection<FMRMinutia, FMRMinutiaData>; see page 106).
525
8.1 Java Reference File FMRFingerView.java
8.1.2.1.61.1.4 FMRFingerView.MinutiaEightNeighborsCollection Class

Represents the collection of NFMinutiaNeighbor ( Java public final class MinutiaEightNeighborsCollection extends NStructureArrayCollection<BDIFFPMinutiaNeighbor, BDIFFPMinutiaNeighborData, FMRMinutia>; File FMRFingerView.java see page 110).
8.1.2.1.61.1.5 FMRFingerView.MinutiaFourNeighborsCollection Class

Represents the collection of NFMinutiaNeighbor ( Java public final class MinutiaFourNeighborsCollection extends NStructureArrayCollection<BDIFFPMinutiaNeighbor, BDIFFPMinutiaNeighborData, FMRMinutia>; File FMRFingerView.java see page 110).
8.1.2.1.61.2 FMRFingerView Fields

8.1.2.1.61.2.1 FMRFingerView.FLAG_PROCESS_ALL_EXTENDED_DATA Field
For internal use. Java public static final int FLAG_PROCESS_ALL_EXTENDED_DATA = 0x01000000;
8.1.2.1.61.2.2 FMRFingerView.FLAG_SKIP_NEUROTEC_FIELDS Field

The flag indicating whether fields of Neurotechnology should be skipped while loading or saving FMRFingerView ( page 524). Java public static final int FLAG_SKIP_NEUROTEC_FIELDS = 0x40000000; see
8.1.2.1.61.2.3 FMRFingerView.FLAG_SKIP_RIDGE_COUNTS Field

The flag indicating whether ridge counts should be skipped while loading or saving FMRFingerView ( Java public static final int FLAG_SKIP_RIDGE_COUNTS = NFRecord.FLAG_SKIP_RIDGE_COUNTS; see page 524).
8.1.2.1.61.2.4 FMRFingerView.FLAG_SKIP_SINGULAR_POINTS Field

The flag indicating whether singular points (cores and deltas) should be skipped while loading or saving FMRFingerView ( see page 524). Java public static final int FLAG_SKIP_SINGULAR_POINTS = NFRecord.FLAG_SKIP_SINGULAR_POINTS;
8.1.2.1.61.2.5 FMRFingerView.FLAG_USE_NEUROTEC_FIELDS Field

The flag indicating whether fields of Neurotechnology should be used while loading or saving FMRFingerView ( 524). see page
526
public static final int FLAG_USE_NEUROTEC_FIELDS = 0x80000000;
8.1.2.1.61.2.6 FMRFingerView.MAX_CORE_COUNT Field

The maximum number of cores a FMRFingerView ( Java public static final int MAX_CORE_COUNT = 15; see page 524) can contain.
8.1.2.1.61.2.7 FMRFingerView.MAX_DELTA_COUNT Field

The maximum number of deltas a FMRFingerView ( Java public static final int MAX_DELTA_COUNT = 15; see page 524) can contain.
8.1.2.1.61.2.8 FMRFingerView.MAX_DIMENSION Field

The maximum value for x and y coordinates of a minutia, core or delta in a FMRFingerView ( Java public static final int MAX_DIMENSION = 16383; see page 524).
8.1.2.1.61.2.9 FMRFingerView.MAX_MINUTIA_COUNT Field

The maximum number of minutiae a FMRFingerView ( Java public static final int MAX_MINUTIA_COUNT = 255; see page 524) can contain.
8.1.2.1.61.3 FMRFingerView Methods

8.1.2.1.61.3.1 FMRFingerView.getCores Method
Gets cores collection. Java public CoreCollection getCores(); Returns The FMRFingerView.CoreCollection ( see page 525) collection.
8.1.2.1.61.3.2 FMRFingerView.getDeltas Method

Gets deltas collection. Java public DeltaCollection getDeltas(); Returns The FMRFingerView.DeltaCollection ( see page 525) collection.
8.1.2.1.61.3.3 FMRFingerView.getFingerQuality Method

Gets fingerprint quality. Java public short getFingerQuality(); Returns The fingerprint quality. 527
8.1 Java Reference
8.1.2.1.61.3.4 FMRFingerView.getImpressionType Method

Gets the impression type of the finger record. Java public BDIFFPImpressionType getImpressionType(); Returns The impression type.
8.1.2.1.61.3.5 getMaxSize Method 8.1.2.1.61.3.5.1 FMRFingerView.getMaxSize Method (BDIFStandard, int, boolean, boolean, int, int, int, int)
Retrieves the maximal size of a FMRFingerView ( see page 524) in stored FMRecord ( specified number of minutiae, cores and deltas and specified ridge counts. Java public static int getMaxSize(BDIFStandard standard, int minutiaCount, boolean hasFourNeighborRidgeCounts, boolean hasEightNeighborRidgeCounts, int coreWithAngleCount, int coreCount, int deltaWithAngleCount, int deltaCount); Parameters Parameters BDIFStandard standard int minutiaCount boolean hasFourNeighborRidgeCounts boolean hasEightNeighborRidgeCounts int coreWithAngleCount int coreCount int deltaWithAngleCount int deltaCount Returns The maximal size of a FMRFingerView ( see page 524). The number of deltas. The number of cores. Description BDIFStandard value. The number of minutiae. Indicates whether FMRecord ( see page 512) finger view has "four neighbor ridge counts". Indicates whether FMRecord ( see page 512) finger view has "eight neighbor ridge counts". see page 512) containing the
8.1.2.1.61.3.5.2 FMRFingerView.getMaxSize Method (BDIFStandard, int, boolean, boolean, int, int, int, int, boolean, boolean, int, int)
Retrieves the maximal size of a FMRFingerView ( see page 524) in stored FMRecord ( specified number of minutiae, cores and deltas and specified ridge counts. Java public static int getMaxSize(BDIFStandard standard, int minutiaCount, boolean hasFourNeighborRidgeCounts, boolean hasEightNeighborRidgeCounts, int coreWithAngleCount, int coreCount, int deltaWithAngleCount, int deltaCount, boolean hasNeurotecCurvatures, boolean hasNeurotecGs, int neurotecBOWidth, int neurotecBOHeight); Parameters Parameters BDIFStandard standard int minutiaCount boolean hasFourNeighborRidgeCounts Description BDIFStandard value. The number of minutiae. Indicates whether FMRecord ( see page 512) finger view has "four neighbor ridge counts". see page 512) containing the
528
8.1 Java Reference boolean hasEightNeighborRidgeCounts int coreWithAngleCount int coreCount int deltaWithAngleCount int deltaCount boolean hasNeurotecCurvatures boolean hasNeurotecGs int neurotecBOWidth int neurotecBOHeight Returns The maximal size of a FMRFingerView (
Indicates whether FMRecord ( see page 512) finger view has "eight neighbor ridge counts". The number of cores. The number of deltas. An attribute that indicates if finger has Neurotec curvatures. An attribute that indicates if finger has Neurotec GS. Width. Height.
see page 524).
8.1.2.1.61.3.6 FMRFingerView.getMinutiae Method

Gets minutiae collection. Java public MinutiaCollection getMinutiae(); Returns A FMRFingerView.MinutiaCollection ( see page 525) that contains minutiae.
8.1.2.1.61.3.7 FMRFingerView.getMinutiaeEightNeighbors Method

Gets minutia eight neighbors collection. Java public MinutiaEightNeighborsCollection getMinutiaeEightNeighbors(); Returns A FMRFingerView.MinutiaEightNeighborsCollection ( see page 526) that contains minutiae of eight neighbors.
8.1.2.1.61.3.8 FMRFingerView.getMinutiaeFourNeighbors Method

Gets minutia four neighbors collection. Java public MinutiaFourNeighborsCollection getMinutiaeFourNeighbors(); Returns A FMRFingerView.MinutiaFourNeighborsCollection ( see page 526) that contains minutiae of four neighbors.
8.1.2.1.61.3.9 FMRFingerView.getPosition Method

Gets the FMRFingerView ( Java public BDIFFPPosition getPosition(); Returns FMRFingerView ( see page 524) position value. see page 524) position value.
8.1.2.1.61.3.10 FMRFingerView.getViewCount Method

Retrieves the view number of items in the FMRFingerView ( see page 524).
529
8.1 Java Reference Java public int getViewCount(); Returns
The number of the items in the FMRFingerView (
see page 524).
8.1.2.1.61.3.11 FMRFingerView.getViewNumber Method

Gets a number of the FIRFingerView ( Java public int getViewNumber(); Returns FIRFingerView ( see page 492) object view number. see page 492) object views.
8.1.2.1.61.3.12 FMRFingerView.isHasEightNeighborRidgeCounts Method

Gets a value indicating whether FMRecord ( Java public boolean isHasEightNeighborRidgeCounts(); Returns true if FMRecord ( false . see page 512) finger view has ridge counts to eight neighbors of each minutia; otherwise, see page 512) finger view has ridge counts to eight neighbor of each minutia.
8.1.2.1.61.3.13 FMRFingerView.isHasFourNeighborRidgeCounts Method

Gets a value indicating whether FMRecord ( Java public boolean isHasFourNeighborRidgeCounts(); Returns true if FMRecord ( false . see page 512) finger view has ridge counts to four neighbors of each minutia; otherwise, see page 512) finger view has ridge counts to four neighbor of each minutia.
8.1.2.1.61.3.14 FMRFingerView.nativeTypeOf Method

8.1.2.1.61.3.15 FMRFingerView.setFingerQuality Method

Sets fingerprint quality.
530
public void setFingerQuality(short value); Parameters Parameters short value Description The fingerprint quality.
8.1.2.1.61.3.16 FMRFingerView.setHasEightNeighborRidgeCounts Method

Gets a value indicating whether FMRecord ( Java public void setHasEightNeighborRidgeCounts(boolean value); Parameters Parameters boolean value Description see page 512) finger view has ridge counts to eight neighbor of each minutia.
8.1.2.1.61.3.17 FMRFingerView.setHasFourNeighborRidgeCounts Method

Gets a value indicating whether FMRecord ( Java public void setHasFourNeighborRidgeCounts(boolean value); Parameters Parameters boolean value Description see page 512) finger view has ridge counts to four neighbor of each minutia.
8.1.2.1.61.3.18 FMRFingerView.setImpressionType Method

Sets the impression type of the finger record. Java public void setImpressionType(BDIFFPImpressionType value); Parameters Parameters BDIFFPImpressionType value Description The impression type
8.1.2.1.61.3.19 toNFRecord Method 8.1.2.1.61.3.19.1 FMRFingerView.toNFRecord Method ()

Creates NFRecord ( Java public NFRecord toNFRecord(); Returns NFRecord ( see page 110) object. see page 110) object from FMRFingerView ( see page 524).
8.1.2.1.61.3.19.2 FMRFingerView.toNFRecord Method (int)

Creates NFRecord ( Java public NFRecord toNFRecord(int flags); see page 110) object from FMRFingerView ( see page 524).
531
8.1 Java Reference Parameters Parameters int flags Returns NFRecord ( see page 110) object.
8.1.2.1.62 FMRMinutia Class

Minutiae structure of ANSI/INCIST 378 2004 standard template. Java public final class FMRMinutia; File FMRMinutia.java Methods Name FMRMinutia ( FMRMinutia Fields Name angle ( quality ( type ( x( y( see page 534) see page 534) see page 534) Description The angle of the minutia. The quality of the minutia. The type of the minutia. The x coordinate of the minutia. The y coordinate of the minutia. see page 532) Description Initializes a new instance of the FMRMinutia class.
FMRMinutia Methods Name getAngle ( see page 534) see page 534) see page 535) see page 535) see page 535) getAnsiAngle ( getIsoAngle ( setAngle ( setAnsiAngle ( setIsoAngle ( Description Gets the angle ( Gets the angle ( Gets the angle ( Sets the angle ( Sets the angle ( Sets the angle ( see page 534) of the minutia. see page 534) of the minutia. see page 534) of the minutia. see page 534) of the minutia. see page 534) of the minutia. see page 534) of the minutia.
see page 535)
8.1.2.1.62.1 FMRMinutia Constructor

8.1.2.1.62.1.1 FMRMinutia.FMRMinutia Constructor ()
Initializes a new instance of the FMRMinutia class. Java public FMRMinutia();
8.1.2.1.62.1.2 FMRMinutia.FMRMinutia Constructor (short, short, BDIFFPMinutiaType, byte)

Initializes a new instance of the FMRMinutia class. Java public FMRMinutia(short x, short y, BDIFFPMinutiaType type, byte angle);
532
8.1 Java Reference Parameters Parameters short x short y BDIFFPMinutiaType type byte angle
Description The x ( The y ( see page 534) coordinate of the minutia. see page 534) coordinate of the minutia. see page 534) of the minutia.
One of the BDIFFPMinutiaType values. The angle (
8.1.2.1.62.1.3 FMRMinutia.FMRMinutia Constructor (short, short, BDIFFPMinutiaType, byte, byte)

Initializes a new instance of the FMRMinutia class. Java public FMRMinutia(short x, short y, BDIFFPMinutiaType type, byte angle, byte quality); Parameters Parameters short x short y BDIFFPMinutiaType type byte angle byte quality Description The x ( The y ( see page 534) coordinate of the minutia. see page 534) coordinate of the minutia. see page 534) of the minutia. see page 534) of the minutia.
One of the BDIFFPMinutiaType values. The angle ( The quality (
8.1.2.1.62.1.4 FMRMinutia.FMRMinutia Constructor (short, short, BDIFFPMinutiaType, double, BDIFStandard)

Initializes a new instance of the FMRMinutia class. Java public FMRMinutia(short x, short y, BDIFFPMinutiaType type, double angle, BDIFStandard standard); Parameters Parameters short x short y BDIFFPMinutiaType type double angle BDIFStandard standard Description The x ( The y ( see page 534) coordinate of the minutia. see page 534) coordinate of the minutia. see page 534) of the minutia.
One of the BDIFFPMinutiaType values. The angle ( One of the BDIFStandard values.
8.1.2.1.62.1.5 FMRMinutia.FMRMinutia Constructor (short, short, BDIFFPMinutiaType, double, byte, BDIFStandard)

Initializes a new instance of the FMRMinutia class. Java public FMRMinutia(short x, short y, BDIFFPMinutiaType type, double angle, byte quality, BDIFStandard standard); Parameters Parameters short x short y BDIFFPMinutiaType type double angle byte quality Description The x ( The y ( see page 534) coordinate of the minutia. see page 534) coordinate of the minutia. see page 534) of the minutia. see page 534) of the minutia.
One of the BDIFFPMinutiaType values. The angle ( The quality (
533
8.1 Java Reference BDIFStandard standard
One of the BDIFStandard values.
8.1.2.1.62.2 FMRMinutia Fields

8.1.2.1.62.2.1 FMRMinutia.angle Field
The angle of the minutia. Java public byte angle;
8.1.2.1.62.2.2 FMRMinutia.quality Field

The quality of the minutia. Java public byte quality;
8.1.2.1.62.2.3 FMRMinutia.type Field

The type of the minutia. Java public BDIFFPMinutiaType type;
8.1.2.1.62.2.4 FMRMinutia.x Field

The x coordinate of the minutia. Java public short x;
8.1.2.1.62.2.5 FMRMinutia.y Field

The y coordinate of the minutia. Java public short y;
8.1.2.1.62.3 FMRMinutia Methods

8.1.2.1.62.3.1 FMRMinutia.getAngle Method
Gets the angle ( Java public double getAngle(BDIFStandard standard); Parameters Parameters BDIFStandard standard Returns The angle ( see page 534) of the minutia. Description One of the BDIFStandard values. see page 534) of the minutia.
8.1.2.1.62.3.2 FMRMinutia.getAnsiAngle Method

Gets the angle ( Java public double getAnsiAngle(); see page 534) of the minutia.
534
8.1 Java Reference Returns The angle (
see page 534) of the minutia.
8.1.2.1.62.3.3 FMRMinutia.getIsoAngle Method

Gets the angle ( Java public double getIsoAngle(); Returns The angle ( see page 534) of the minutia. see page 534) of the minutia.
8.1.2.1.62.3.4 FMRMinutia.setAngle Method

Sets the angle ( Java public void setAngle(double value, BDIFStandard standard); Parameters Parameters double value BDIFStandard standard Description Minutia angle ( see page 534). One of the BDIFStandard values. see page 534) of the minutia.
8.1.2.1.62.3.5 FMRMinutia.setAnsiAngle Method

Sets the angle ( Java public void setAnsiAngle(double value); Parameters Parameters angle Description The angle ( see page 534) of the minutia. see page 534) of the minutia.
8.1.2.1.62.3.6 FMRMinutia.setIsoAngle Method

Sets the angle ( Java public void setIsoAngle(double value); Parameters Parameters angle Description The angle ( see page 534) of the minutia. see page 534) of the minutia.
8.1.2.1.63 IIRecord Class

Contains functions for managing iris records. Java public final class IIRecord extends NObject implements Cloneable; File IIRecord.java
535
8.1 Java Reference Methods Name IIRecord ( IIRecord Classes Name IrisCollection ( see page 537)
Description Initializes a new instance of the IIRecord class.
Description see page 539) see page Provides methods and properties for adding new IIRecords to the IrisCollection. Provides methods and properties for adding new iris images to the IrisImageCollection.
IrisImageCollection ( 540) IIRecord Fields Name
Description see A maximum number of irises used in irises colletion of IIRIris ( 547) object. see page
MAX_IRIS_IMAGE_COUNT ( page 541) IIRecord Methods Name calculateSize ( see page 541) getCaptureDeviceId ( 541) getCBEFFProductId ( 541)
Description Calculates size of the IIRecord object with particular properties. Gets the id of the capture device of the IIRecord object. Gets the CBEFF product id of the IIRecord object. Gets the unique device identifier of the IIRecord. Gets the image transformation of the IIRecord object. Gets the image format of an IIRecord object. Gets the image transformation of the IIRecord object. see see page see page see
getDeviceUniqueIdentifier ( page 541) getGUID ( see page 542) getImageFormat (
see page 542)
getImageTransformation ( page 542) getIntensityDepth ( getIrisBoundaryExtraction ( page 542) getIrisDiameter ( getIrises ( see page 543)
see page 542) Gets the intensity depth of an IIRecord object. see Gets the iris boundary extraction status of the IIRecord object. Gets the iris diameter of the IIRecord object. Gets irises in the IIRecord object. Gets the horizontal iris orientation of the IIRecord object. Gets iris images in the IIRecord object. Gets the iris occlusion filling of the IIRecord object. Gets the iris occlusion processing status of the IIRecord. Gets the iris scan type of the IIRecord object. Gets the vertical iris orientation of the IIRecord object. Gets the raw image height of the IIRecord object. Gets the raw image width of the IIRecord object. Gets standard name used by the IIRecord object. Retrieves a function that retrieves NType object for the enclosing type. Gets the id of the capture device of the IIRecord object.
getIrisHorzOrientation ( 543) getIrisImages ( getIrisOcclusionFilling ( 543) getIrisOcclusions ( getIrisScanType (
see page 543) see page 543) see page see page see page
getIrisVertOrientation ( 544) getRawImageHeight ( 544) getRawImageWidth ( 544) getStandard ( nativeTypeOf (
see page 544) see page 544) see page see page
setCaptureDeviceId ( 544) setCBEFFProductId ( 545)
8
Sets the CBEFF product id of the IIRecord object.
536
8.1 Java Reference setDeviceUniqueIdentifier ( page 545) setGUID ( see page 545) setImageTransformation ( page 545) setIrisBoundaryExtraction ( page 545) setIrisDiameter ( setIrisHorzOrientation ( 546) setIrisOcclusionFilling ( 546) setIrisOcclusions ( setIrisScanType (
see
Sets the unique device identifier of the IIRecord. Sets the image transformation of the IIRecord object.
see see
Sets the image transformation of the IIRecord object. Sets the iris boundary extraction status of the IIRecord object. Sets the iris diameter of the IIRecord object. Sets the horizontal iris orientation of the IIRecord object. Sets the iris occlusion filling of the IIRecord object. Sets the iris occlusion processing status of the IIRecord. Sets the iris scan type of the IIRecord object. Sets the vertical iris orientation of the IIRecord object.
setIrisVertOrientation ( 547)
8.1.2.1.63.1 IIRecord Constructor

8.1.2.1.63.1.1 IIRecord.IIRecord Constructor (ByteBuffer, BDIFStandard)
Initializes a new instance of the IIRecord class. Java public IIRecord(ByteBuffer buffer, BDIFStandard standard); Parameters Parameters ByteBuffer buffer BDIFStandard standard Description ByteBuffer containing the IIRecord. Standard name used by an IIRecord object.
8.1.2.1.63.1.2 IIRecord.IIRecord Constructor (ByteBuffer, int, BDIFStandard)

Initializes a new instance of the IIRecord class. Java public IIRecord(ByteBuffer buffer, int flags, BDIFStandard standard); Parameters Parameters ByteBuffer buffer int flags Description ByteBuffer containing the IIRecord. Any combination of flags compatible with the IIRecord object. The following flags are supported: FlagProcessFirstIrisImageOnly. Standard name used by an IIRecord object.
8.1.2.1.63.1.3 IIRecord.IIRecord Constructor (IIRImageFormat, short, short, byte, BDIFStandard)

Initializes a new instance of the IIRecord class. Java public IIRecord(IIRImageFormat imageFormat, short rawImageWidth, short rawImageHeight, byte intensityDepth, BDIFStandard standard); Parameters Parameters IIRImageFormat imageFormat Description Eye iris image format. 537
8.1 Java Reference short rawImageWidth short rawImageHeight byte intensityDepth BDIFStandard standard
Raw image width. Raw image height. Intensity depth. Standard name used by an IIRecord object.
8.1.2.1.63.1.4 IIRecord.IIRecord Constructor (IIRImageFormat, short, short, byte, int, BDIFStandard)

Initializes a new instance of the IIRecord class. Java public IIRecord(IIRImageFormat imageFormat, short rawImageWidth, short rawImageHeight, byte intensityDepth, int flags, BDIFStandard standard); Parameters Parameters IIRImageFormat imageFormat short rawImageWidth short rawImageHeight byte intensityDepth int flags Description Eye iris image format. Raw image width. Raw image height. Intensity depth. Any combination of flags compatible with the IIRecord object. The following flags are supported: FlagProcessFirstIrisImageOnly. Standard name used by an IIRecord object.
8.1.2.1.63.1.5 IIRecord.IIRecord Constructor (IIRecord, BDIFStandard)

Initializes a new instance of the IIRecord class. Java public IIRecord(IIRecord srcRecord, BDIFStandard standard); Parameters Parameters IIRecord srcRecord BDIFStandard standard Description IIRecord object. Standard name used by an IIRecord object.
8.1.2.1.63.1.6 IIRecord.IIRecord Constructor (IIRecord, int, BDIFStandard)

Initializes a new instance of the IIRecord class. Java public IIRecord(IIRecord srcRecord, int flags, BDIFStandard standard); Parameters Parameters IIRecord srcRecord int flags Description IIRecord object. Any combination of flags compatible with the IIRecord object. The following flags are supported: FlagProcessFirstIrisImageOnly. Standard name used by an IIRecord object.
8.1.2.1.63.1.7 IIRecord.IIRecord Constructor (NImage, IIRImageFormat, BDIFEyePosition, BDIFStandard)

Initializes a new instance of the IIRecord class. Java public IIRecord(NImage nImage, IIRImageFormat imageFormat, BDIFEyePosition irisPosition, BDIFStandard standard); 538
8.1 Java Reference Parameters Parameters NImage nImage IIRImageFormat imageFormat BDIFEyePosition irisPosition BDIFStandard standard
Description NImage object. Image format. Iris position. Standard name used by an IIRecord object.
8.1.2.1.63.1.8 IIRecord.IIRecord Constructor (NImage, IIRImageFormat, BDIFEyePosition, int, BDIFStandard)

Initializes a new instance of the IIRecord class. Java public IIRecord(NImage nImage, IIRImageFormat imageFormat, BDIFEyePosition irisPosition, int flags, BDIFStandard standard); Parameters Parameters NImage nImage IIRImageFormat imageFormat BDIFEyePosition irisPosition int flags Description NImage object. Image format. Iris position. Any combination of flags compatible with the IIRecord object. The following flags are supported: FlagProcessFirstIrisImageOnly. Standard name used by an IIRecord object.
8.1.2.1.63.2 IIRecord Classes

8.1.2.1.63.2.1 IIRecord.IrisCollection Class
Provides methods and properties for adding new IIRecords to the IrisCollection. Java public final class IrisCollection extends NObjectCollection<IIRIris>; File IIRecord.java IrisCollection Methods Name add ( see page 539) Description Adds an object to the end of the IrisCollection.
8.1.2.1.63.2.1.1 IrisCollection Methods 8.1.2.1.63.2.1.1.1 add Method 8.1.2.1.63.2.1.1.1.1 IIRecord.IrisCollection.add Method (BDIFEyePosition)
Adds an object to the end of the IrisCollection ( Java public IIRIris add(BDIFEyePosition irisPosition); Parameters Parameters BDIFEyePosition irisPosition Description Position of the eye iris. 539 see page 539).
8.1 Java Reference Returns The handle to newly created object.
8.1.2.1.63.2.1.1.1.2 IIRecord.IrisCollection.add Method (BDIFEyePosition, NImage)

Adds an object to the end of the IrisCollection ( Java public IIRIris add(BDIFEyePosition irisPosition, NImage nImage); Parameters Parameters BDIFEyePosition irisPosition NImage nImage Returns The handle to newly created object. Description Position of the eye iris. An object of NImage type. see page 539).
8.1.2.1.63.2.1.1.1.3 IIRecord.IrisCollection.add Method (BDIFEyePosition, NImage, int)

Adds an object to the end of the IrisCollection ( Java public IIRIris add(BDIFEyePosition irisPosition, NImage nImage, int flags); Parameters Parameters BDIFEyePosition irisPosition NImage nImage int flags Returns The handle to newly created object. Description Position of the eye iris. An object of NImage type. Bitwise combination of zero or more flags that controls behavior of the function. see page 539).
8.1.2.1.63.2.1.1.1.4 IIRecord.IrisCollection.add Method (BDIFEyePosition, int)

Adds an object to the end of the IrisCollection ( Java public IIRIris add(BDIFEyePosition irisPosition, int flags); Parameters Parameters BDIFEyePosition irisPosition int flags Returns The handle to newly created object. Description Position of the eye iris. Bitwise combination of zero or more flags that controls behavior of the function. see page 539).
8.1.2.1.63.2.2 IIRecord.IrisImageCollection Class

Provides methods and properties for adding new iris images to the IrisImageCollection. Java public final class IrisImageCollection extends NObjectCollection<IIRIrisImage>; 540
8.1 Java Reference File IIRecord.java
8.1.2.1.63.3 IIRecord Fields

8.1.2.1.63.3.1 IIRecord.MAX_IRIS_IMAGE_COUNT Field
A maximum number of irises used in irises colletion of IIRIris ( Java public static final int MAX_IRIS_IMAGE_COUNT = 2 * IIRIris.MAX_IRIS_IMAGE_COUNT; see page 547) object.
8.1.2.1.63.4 IIRecord Methods

8.1.2.1.63.4.1 IIRecord.calculateSize Method
Calculates size of the IIRecord ( Java public static int calculateSize(BDIFStandard standard, int[] irisSizes); Parameters Parameters BDIFStandard standard int[] irisSizes Returns The size in bytes of the IIRecord ( see page 535) with such properties. Description Standard used by the IIRecord ( see page 535) object. see page Array of irises sizes to be used in the IIRecord ( 535) object. see page 535) object with particular properties.
8.1.2.1.63.4.2 IIRecord.getCaptureDeviceId Method

Gets the id of the capture device of the IIRecord ( Java public short getCaptureDeviceId(); Returns The id of the capture device of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.3 IIRecord.getCBEFFProductId Method

Gets the CBEFF product id of the IIRecord ( Java public int getCBEFFProductId(); Returns the CBEFF product id of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.4 IIRecord.getDeviceUniqueIdentifier Method

Gets the unique device identifier of the IIRecord ( Java public String getDeviceUniqueIdentifier(); see page 535).
541
The unique device identifier of the IIRecord (
8.1.2.1.63.4.5 IIRecord.getGUID Method

Gets the image transformation of the IIRecord ( Java public UUID getGUID(); Returns The image transformation used by the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.6 IIRecord.getImageFormat Method

Gets the image format of an IIRecord ( Java public IIRImageFormat getImageFormat(); Returns The image format used by the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.7 IIRecord.getImageTransformation Method

Gets the image transformation of the IIRecord ( Java public IIRImageTransformation getImageTransformation(); Returns The image transformation used by the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.8 IIRecord.getIntensityDepth Method

Gets the intensity depth of an IIRecord ( Java public byte getIntensityDepth(); Returns The the image intensity depth of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.9 IIRecord.getIrisBoundaryExtraction Method

Gets the iris boundary extraction status of the IIRecord ( Java public IIRIrisBoundary getIrisBoundaryExtraction(); Returns The iris boundary extraction status of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.10 IIRecord.getIrisDiameter Method

Gets the iris diameter of the IIRecord ( Java public short getIrisDiameter(); see page 535) object.
542
8.1 Java Reference Returns The iris diameter in the IIRecord (
8.1.2.1.63.4.11 IIRecord.getIrises Method

Gets irises in the IIRecord ( Java public IrisCollection getIrises(); Returns Iris collection of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.12 IIRecord.getIrisHorzOrientation Method

Gets the horizontal iris orientation of the IIRecord ( Java public BDIFIrisOrientation getIrisHorzOrientation(); Returns The horizontal iris orientation of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.13 IIRecord.getIrisImages Method

Gets iris images in the IIRecord ( Java public IrisImageCollection getIrisImages(); Returns Iris images collection of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.14 IIRecord.getIrisOcclusionFilling Method

Gets the iris occlusion filling of the IIRecord ( Java public IIRIrisOcclusionFilling getIrisOcclusionFilling(); Returns The iris occlusion filling value used in the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.15 IIRecord.getIrisOcclusions Method

Gets the iris occlusion processing status of the IIRecord ( Java public IIRIrisOcclusions getIrisOcclusions(); Returns The iris occlusion processing status of the IIRecord ( see page 535) object. see page 535).
8.1.2.1.63.4.16 IIRecord.getIrisScanType Method

Gets the iris scan type of the IIRecord ( Java public BDIFIrisScanType getIrisScanType(); see page 535) object.
543
8.1 Java Reference Returns The iris scan type value of the IIRecord (
see page 535).
8.1.2.1.63.4.17 IIRecord.getIrisVertOrientation Method

Gets the vertical iris orientation of the IIRecord ( Java public BDIFIrisOrientation getIrisVertOrientation(); Returns The vertical iris orientation of the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.18 IIRecord.getRawImageHeight Method

Gets the raw image height of the IIRecord ( Java public short getRawImageHeight(); Returns The the height of the raw image in the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.19 IIRecord.getRawImageWidth Method

Gets the raw image width of the IIRecord ( Java public short getRawImageWidth(); Returns The the width of the raw image in the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.20 IIRecord.getStandard Method

Gets standard name used by the IIRecord ( Java public BDIFStandard getStandard(); Returns The standard name value used in the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.21 IIRecord.nativeTypeOf Method

8.1.2.1.63.4.22 IIRecord.setCaptureDeviceId Method

Gets the id of the capture device of the IIRecord ( Java public void setCaptureDeviceId(short value); see page 535) object.
544
8.1 Java Reference Parameters Parameters short value
Description The id of the capture device of the IIRecord ( 535) object. see page
8.1.2.1.63.4.23 IIRecord.setCBEFFProductId Method

Sets the CBEFF product id of the IIRecord ( Java public void setCBEFFProductId(int value); Parameters Parameters int value Description The CBEFF product id of the IIRecord ( object. see page 535) see page 535) object.
8.1.2.1.63.4.24 IIRecord.setDeviceUniqueIdentifier Method

Sets the unique device identifier of the IIRecord ( Java public void setDeviceUniqueIdentifier(String value); Parameters Parameters String value Description The unique device identifier of the IIRecord ( 535) object. see page see page 535).
8.1.2.1.63.4.25 IIRecord.setGUID Method

Sets the image transformation of the IIRecord ( Java public void setGUID(UUID value); Parameters Parameters UUID value Description The image transformation used by the IIRecord ( 535) object. see page see page 535) object.
8.1.2.1.63.4.26 IIRecord.setImageTransformation Method

Sets the image transformation of the IIRecord ( Java public void setImageTransformation(IIRImageTransformation value); Parameters Parameters IIRImageTransformation value Description The image transformation used by the IIRecord ( 535) object. see page see page 535) object.
8.1.2.1.63.4.27 IIRecord.setIrisBoundaryExtraction Method

Sets the iris boundary extraction status of the IIRecord ( Java public void setIrisBoundaryExtraction(IIRIrisBoundary value); 545 see page 535) object.
8.1 Java Reference Parameters Parameters IIRIrisBoundary value
Description The iris boundary extraction status of the IIRecord ( page 535) object. see
8.1.2.1.63.4.28 IIRecord.setIrisDiameter Method

Sets the iris diameter of the IIRecord ( Java public void setIrisDiameter(short value); Parameters Parameters short value Description The iris diameter in the IIRecord ( see page 535) object. see page 535) object.
8.1.2.1.63.4.29 IIRecord.setIrisHorzOrientation Method

Sets the horizontal iris orientation of the IIRecord ( Java public void setIrisHorzOrientation(BDIFIrisOrientation value); Parameters Parameters BDIFIrisOrientation value Description The horizontal iris orientation of the IIRecord ( 535) object. see page see page 535) object.
8.1.2.1.63.4.30 IIRecord.setIrisOcclusionFilling Method

Sets the iris occlusion filling of the IIRecord ( Java public void setIrisOcclusionFilling(IIRIrisOcclusionFilling value); Parameters Parameters IIRIrisOcclusionFilling value Description The iris occlusion filling value used in the IIRecord ( page 535) object. see see page 535) object.
8.1.2.1.63.4.31 IIRecord.setIrisOcclusions Method

Sets the iris occlusion processing status of the IIRecord ( Java public void setIrisOcclusions(IIRIrisOcclusions value); Parameters Parameters IIRIrisOcclusions value Description The iris occlusion processing status of the IIRecord ( page 535) object. see see page 535).
8.1.2.1.63.4.32 IIRecord.setIrisScanType Method

Sets the iris scan type of the IIRecord ( Java public void setIrisScanType(BDIFIrisScanType value); see page 535) object.
546
8.1 Java Reference Parameters Parameters BDIFIrisScanType value
Description The iris scan type value of the IIRecord ( see page 535).
8.1.2.1.63.4.33 IIRecord.setIrisVertOrientation Method

Sets the vertical iris orientation of the IIRecord ( Java public void setIrisVertOrientation(BDIFIrisOrientation value); Parameters Parameters BDIFIrisOrientation value Description The vertical iris orientation of the IIRecord ( object. see page 535) see page 535) object.
8.1.2.1.64 IIRIris Class

Contains functions for managing irises images. Java public final class IIRIris extends NObject; File IIRIris.java IIRIris Classes Name IrisImageCollection ( 547) IIRIris Fields Name Description see page Description Provides methods for adding new images to collection and properties for managing the IrisImageCollection.
FLAG_PROCESS_FIRST_IRIS_IMAGE_ONLY The flag used to indicate to process only the first iris in the ( see page 549) IIRIris collection. MAX_IRIS_IMAGE_COUNT ( IIRIris Methods Name calculateSize ( getIrisImages ( getPosition ( nativeTypeOf ( setPosition ( see page 549) see page 549) see page 550) see page 550) Description Calculates size of an iris image. Gets iris image collection from the IIRIris object. Gets position of the IIRIrisImage ( object. Sets position of the IIRIrisImage ( object. see page 550) object in the IIRIris see page 549) A maximum number of irises used in irises collection of IIRIris object.
Retrieves a function that retrieves NType object for the enclosing type. see page 550) object in the IIRIris
see page 550)
8.1.2.1.64.1 IIRIris Classes

8.1.2.1.64.1.1 IIRIris.IrisImageCollection Class
Provides methods for adding new images to collection and properties for managing the IrisImageCollection. Java public final class IrisImageCollection extends NObjectCollection<IIRIrisImage>; 547
8.1 Java Reference File IIRIris.java IrisImageCollection Methods Name add ( see page 548)
Description Adds an object to the end of the IrisImage collection.
8.1.2.1.64.1.1.1 IrisImageCollection Methods 8.1.2.1.64.1.1.1.1 add Method 8.1.2.1.64.1.1.1.1.1 IIRIris.IrisImageCollection.add Method (ByteBuffer)
Adds an object to the end of the IrisImage collection. Java public IIRIrisImage add(ByteBuffer imageData); Parameters Parameters ByteBuffer imageData flags Returns Reference to the IIRIrisImage ( 550) object in the IriIris object. see page 550) object that references the newly created empty IIRIrisImage ( see page Description Memory buffer containing image data. Bitwise combination of zero or more flags that controls behavior of the function.
8.1.2.1.64.1.1.1.1.2 IIRIris.IrisImageCollection.add Method (ByteBuffer, int)

Adds an object to the end of the IrisImage collection. Java public IIRIrisImage add(ByteBuffer imageData, int flags); Parameters Parameters ByteBuffer imageData int flags Returns Reference to the IIRIrisImage ( 550) object in the IriIris object. see page 550) object that references the newly created empty IIRIrisImage ( see page Description Memory buffer containing image data. Bitwise combination of zero or more flags that controls behavior of the function.
8.1.2.1.64.1.1.1.1.3 IIRIris.IrisImageCollection.add Method (NImage)

Adds an object to the end of the IrisImage collection. Java public IIRIrisImage add(NImage nImage); Parameters Parameters NImage nImage Description An image.
548
8.1 Java Reference Returns Reference to the IIRIrisImage ( 550) object in the IriIris object.
see page 550) object that references the newly created empty IIRIrisImage (
see page
8.1.2.1.64.1.1.1.1.4 IIRIris.IrisImageCollection.add Method (NImage, int)

Adds an object to the end of the IrisImage collection. Java public IIRIrisImage add(NImage nImage, int flags); Parameters Parameters NImage nImage int flags Returns Reference to the IIRIrisImage ( 550) object in the IriIris object. see page 550) object that references the newly created empty IIRIrisImage ( see page Description An image. Bitwise combination of zero or more flags that controls behavior of the function.
8.1.2.1.64.2 IIRIris Fields

8.1.2.1.64.2.1 IIRIris.FLAG_PROCESS_FIRST_IRIS_IMAGE_ONLY Field
The flag used to indicate to process only the first iris in the IIRIris ( Java public static final int FLAG_PROCESS_FIRST_IRIS_IMAGE_ONLY = 0x00001000; see page 547) collection.
8.1.2.1.64.2.2 IIRIris.MAX_IRIS_IMAGE_COUNT Field

A maximum number of irises used in irises collection of IIRIris ( Java public static final int MAX_IRIS_IMAGE_COUNT = Short.MAX_VALUE; see page 547) object.
8.1.2.1.64.3 IIRIris Methods

8.1.2.1.64.3.1 IIRIris.calculateSize Method
Calculates size of an iris image. Java public static int calculateSize(BDIFStandard standard, int[] irisImageSizes); Parameters Parameters BDIFStandard standard int[] irisImageSizes Returns Size of the IIRIris ( see page 547). Description Standard to use in the method. An array of iris images sizes.
8.1.2.1.64.3.2 IIRIris.getIrisImages Method

Gets iris image collection from the IIRIris ( see page 547) object.
549
public IrisImageCollection getIrisImages(); Returns The iris image collection from the IIRIris ( see page 547) object.
8.1.2.1.64.3.3 IIRIris.getPosition Method

Gets position of the IIRIrisImage ( Java public BDIFFPPosition getPosition(); Returns Position of the IIRIrisImage ( see page 550) object in the IIRIris ( see page 547) object. see page 550) object in the IIRIris ( see page 547) object.
8.1.2.1.64.3.4 IIRIris.nativeTypeOf Method

8.1.2.1.64.3.5 IIRIris.setPosition Method

Sets position of the IIRIrisImage ( Java public void setPosition(BDIFFPPosition value); Parameters Parameters BDIFFPPosition value Description Position of the IIRIrisImage ( see page 550) object in the IIRIris ( see page 547) object. see page 550) object in the IIRIris ( see page 547) object.
8.1.2.1.65 IIRIrisImage Class

Provides methods and properties for managing iris images. Java public final class IIRIrisImage extends NObject; File IIRIrisImage.java IIRIrisImage Methods Name calculateSize ( getImageCount ( getImageData ( getPosition ( getQuality ( getImageNumber ( see page 551) see page 551) see page 551) Description Calculates size of an iris image with particular properties. Gets image count in the IIRIrisImage object. Gets image data. Gets eye's iris position in iris image. Gets image quality value.
see page 552) Gets image number in the IIRIrisImage object.
getRotationAngle (
see page 552) Gets iris rotation angle. 550
8.1 Java Reference getRotationAngleRaw ( 552)
see page
Gets iris rotation Raw angle. Gets iris rotation angle uncertainty. Gets iris rotation Raw angle uncertainty. Retrieves a function that retrieves NType object for the enclosing type. Sets image data. Sets image quality value. Sets iris rotation angle. Sets iris rotation Raw angle.
getRotationAngleUncertainty ( see page 552) getRotationAngleUncertaintyRaw ( see page 553) nativeTypeOf ( setImageData ( setQuality ( see page 553) see page 553) see page 553) see page
see page 553)
setRotationAngle (
setRotationAngleRaw ( 554)
setRotationAngleUncertainty ( page 554)
see Gets iris rotation angle uncertainty. Sets iris rotation Raw angle uncertainty. Converts the IIRIrisImage object to the NImage.
setRotationAngleUncertaintyRaw ( see page 554) toNImage ( see page 554)
8.1.2.1.65.1 IIRIrisImage Methods

8.1.2.1.65.1.1 IIRIrisImage.calculateSize Method
Calculates size of an iris image with particular properties. Java public static int calculateSize(BDIFStandard standard, int imageDataLength); Parameters Parameters BDIFStandard standard int imageDataLength Returns The size of the IIRIrisImage ( see page 550) with such properties. Description Standard with which the newly created IIRIrisImage ( page 550) will comply. see
Length of image data that will be used for creating the new IIRIrisImage ( see page 550) object.
8.1.2.1.65.1.2 IIRIrisImage.getImageCount Method

Gets image count in the IIRIrisImage ( Java public int getImageCount(); Returns Image count in the IIRIrisImage ( see page 550) object. see page 550) object.
8.1.2.1.65.1.3 IIRIrisImage.getImageData Method

Gets image data. Java public ByteBuffer getImageData(); Returns ByteBuffer that contains image data.
551
8.1 Java Reference
8.1.2.1.65.1.4 IIRIrisImage.getImageNumber Method

Gets image number in the IIRIrisImage ( Java public int getImageNumber(); Returns Image number in the IIRIrisImage ( see page 550) object. see page 550) object.
8.1.2.1.65.1.5 IIRIrisImage.getPosition Method

Gets eye's iris position in iris image. Java public BDIFFPPosition getPosition(); Returns Eye's iris position in iris image.
8.1.2.1.65.1.6 IIRIrisImage.getQuality Method

Gets image quality value. Java public byte getQuality(); Returns The image quality value.
8.1.2.1.65.1.7 IIRIrisImage.getRotationAngle Method

Gets iris rotation angle. Java public double getRotationAngle(); Returns The iris rotation angle.
8.1.2.1.65.1.8 IIRIrisImage.getRotationAngleRaw Method

Gets iris rotation Raw angle. Java public short getRotationAngleRaw(); Returns Iris rotation Raw angle.
8.1.2.1.65.1.9 IIRIrisImage.getRotationAngleUncertainty Method

Gets iris rotation angle uncertainty. Java public double getRotationAngleUncertainty(); Returns The iris rotation angle uncertainty.
552
8.1 Java Reference
8.1.2.1.65.1.10 IIRIrisImage.getRotationAngleUncertaintyRaw Method

Gets iris rotation Raw angle uncertainty. Java public short getRotationAngleUncertaintyRaw(); Returns Iris rotation Raw angle uncertainty.
8.1.2.1.65.1.11 IIRIrisImage.nativeTypeOf Method

8.1.2.1.65.1.12 setImageData Method 8.1.2.1.65.1.12.1 IIRIrisImage.setImageData Method (ByteBuffer)

Sets image data. Java public void setImageData(ByteBuffer value); Parameters Parameters ByteBuffer value Description ByteBuffer that contains image data.
8.1.2.1.65.1.12.2 IIRIrisImage.setImageData Method (ByteBuffer, boolean)

Sets image data. Java public void setImageData(ByteBuffer value, boolean copy); Parameters Parameters ByteBuffer value boolean copy Description ByteBuffer that contains image data. Defines if the ByteBuffer should be copied inside the object.
8.1.2.1.65.1.13 IIRIrisImage.setQuality Method

Sets image quality value. Java public void setQuality(byte value); Parameters Parameters byte value Description The image quality value.
8.1.2.1.65.1.14 IIRIrisImage.setRotationAngle Method

Sets iris rotation angle. 553
public void setRotationAngle(double value); Parameters Parameters double value Description The iris rotation angle.
8.1.2.1.65.1.15 IIRIrisImage.setRotationAngleRaw Method

Sets iris rotation Raw angle. Java public void setRotationAngleRaw(short value); Parameters Parameters short value Description Iris rotation Raw angle.
8.1.2.1.65.1.16 IIRIrisImage.setRotationAngleUncertainty Method

Gets iris rotation angle uncertainty. Java public void setRotationAngleUncertainty(double value); Parameters Parameters double value Description The iris rotation angle uncertainty.
8.1.2.1.65.1.17 IIRIrisImage.setRotationAngleUncertaintyRaw Method

Sets iris rotation Raw angle uncertainty. Java public void setRotationAngleUncertaintyRaw(short value); Parameters Parameters short value Description Iris rotation Raw angle uncertainty.
8.1.2.1.65.1.18 toNImage Method 8.1.2.1.65.1.18.1 IIRIrisImage.toNImage Method ()

Converts the IIRIrisImage ( Java public NImage toNImage(); Returns The NImage object. see page 550) object to the NImage.
8.1.2.1.65.1.18.2 IIRIrisImage.toNImage Method (int)

Converts IIRIrisImage ( Java public NImage toNImage(int flags); see page 550) object to the NImage.
554
8.1 Java Reference Parameters Parameters int flags Returns The NImage object.
com.neurotec.biometrics.tools Package
8.1.2.1.66 NBiometricStandards Class

Provides methods for retrieving library information. Java public final class NBiometricStandards; File NBiometricStandards.java NBiometricStandards Fields Name DLL_NAME ( see page 555) see page NATIVE_LIBRARY ( 555) NBiometricStandards Methods Name nativeModuleOf ( see page 555) Description Retrieves a function that retrieves NModule object for the enclosing module. Description Name of DLL containing unmanaged part of this component. The object incapsulating the native library.
8.1.2.1.66.1 NBiometricStandards Fields

8.1.2.1.66.1.1 NBiometricStandards.DLL_NAME Field
Name of DLL containing unmanaged part of this component. Java public static final String DLL_NAME = "NBiometricStandards";
8.1.2.1.66.1.2 NBiometricStandards.NATIVE_LIBRARY Field

8.1.2.1.66.2 NBiometricStandards Methods

8.1.2.1.66.2.1 NBiometricStandards.nativeModuleOf Method
555
8.1 Java Reference
8.1.3 com.neurotec.biometrics.tools Package

This package contains classes for using biometric tools. Module Java Reference ( Classes Name NBiometricTools ( NFClassifier ( NFIQ ( see page 556) see page 557) Description Provides methods for retrieving NBiometricTools Library information. Provides functionality for fingerprints classification. Provides functionality for evaluating the quality of a fingerprint image. see page 59)
see page 558)
8.1.3.1 Classes
8.1.3.1.1 NBiometricTools Class
Provides methods for retrieving NBiometricTools Library information. Java public final class NBiometricTools; File NBiometricTools.java NBiometricTools Fields Name DLL_NAME ( see page 556) see page NATIVE_LIBRARY ( 556) NBiometricTools Methods Name nativeModuleOf ( see page 557) Description Retrieves a function that retrieves NModule object for the enclosing module. Description Name of DLL containing unmanaged part of this component. The object incapsulating the native library.
8.1.3.1.1.1 NBiometricTools Fields

8.1.3.1.1.1.1 NBiometricTools.DLL_NAME Field
Name of DLL containing unmanaged part of this component. Java public static final String DLL_NAME = "NBiometricTools";
8.1.3.1.1.1.2 NBiometricTools.NATIVE_LIBRARY Field

8.1.3.1.1.2 NBiometricTools Methods

556
8.1 Java Reference
8.1.3.1.1.2.1 NBiometricTools.nativeModuleOf Method

8.1.3.1.2 NFClassifier Class

Provides functionality for fingerprints classification. Java public final class NFClassifier extends NObject; File NFClassifier.java Remarks NFClassifier can classify ( see page 558) into one of the following pattern classes: Left slant loop, Right slant loop, Scar, Tented arch, Whorl and Plain arch. If NFClassifier failed to determine pattern class Unknown pattern class is/ assigned. Methods Name NFClassifier ( NFClassifier Classes Name ClassifyResult ( NFClassifier Methods Name classify ( see page 558) see page 558) nativeTypeOf ( Description Classifies fingerprint to the NFPatternClass fingerprint class. Retrieves a function that retrieves NType object for the enclosing type. see page 557) Description Fingerprint classification result. see page 557) Description Initializes a new instance of NESegmenter.
8.1.3.1.2.1 NFClassifier.NFClassifier Constructor

Initializes a new instance of NESegmenter. Java public NFClassifier();
8.1.3.1.2.2 NFClassifier Classes

8.1.3.1.2.2.1 NFClassifier.ClassifyResult Class
Fingerprint classification result. Java public static final class ClassifyResult; File NFClassifier.java
557
8.1 Java Reference ClassifyResult Methods Name getConfidence ( getPatternClass (
Description see page 558) see page 558) Gets Value range are from 1 to 0. Good confidence corresponds to 1 and bad confidence corresponds to 0. Gets one of the NFPatternClass value.
8.1.3.1.2.2.1.1 ClassifyResult Methods 8.1.3.1.2.2.1.1.1 NFClassifier.ClassifyResult.getConfidence Method

Gets Value range are from 1 to 0. Good confidence corresponds to 1 and bad confidence corresponds to 0. Java public double getConfidence(); Returns Confidence.
8.1.3.1.2.2.1.1.2 NFClassifier.ClassifyResult.getPatternClass Method

Gets one of the NFPatternClass value. Java public NFPatternClass getPatternClass(); Returns One of the NFPatternClass value.
8.1.3.1.2.3 NFClassifier Methods

8.1.3.1.2.3.1 NFClassifier.classify Method
Classifies fingerprint to the NFPatternClass fingerprint class. Java public ClassifyResult classify(NGrayscaleImage image); Parameters Parameters NGrayscaleImage image Returns NFClassifierResult object. Description The NGrayscaleImage image.
8.1.3.1.2.3.2 NFClassifier.nativeTypeOf Method

8.1.3.1.3 NFIQ Class

Provides functionality for evaluating the quality of a fingerprint image. 558
8.1 Java Reference Java public class NFIQ; File NFIQ.java NFIQ Methods Name compute ( see page 559) nativeTypeOf (
com.neurotec.devices Package
Description Calculates the quality of a given fingerprint image. Retrieves a function that retrieves NType object for the enclosing type. see page 559)
8.1.3.1.3.1 NFIQ Methods

8.1.3.1.3.1.1 NFIQ.compute Method
Calculates the quality of a given fingerprint image. Java public static NFIQQuality compute(NGrayscaleImage image); Parameters Parameters NGrayscaleImage image Returns The quality of the fingerprint image. Description Fingerprint image.
8.1.3.1.3.1.2 NFIQ.nativeTypeOf Method

8.1.4 com.neurotec.devices Package

Provides functionality for managing devices, like cameras, fingerprint or irises scanners. Module Java Reference ( Classes Name NBiometricDevice ( NCamera ( NDevice ( NDevices ( NCaptureDevice ( NDeviceManager ( NFingerScanner ( see page 562) see page 563) see page 566) see page 573) see page 573) Description see page 560) Provides methods to retrieve information about biometric device. Provides methods for working with cameras. Provides methods for working with capture devices. Provides functionality for retrieving device information. see page 59)
see page 569) Provides functionality for managing devices. Provides information about the NDevices library. Represents fingerprints scanner. 559
8.1 Java Reference NFScanner ( NIrisScanner ( NMicrophone ( NPalmScanner (
Represents fingerprints and palmprints scanning device. Represents irises scanning device. Provides methods for working with sound recording devices (microphones). Represents palmprints scanner.
8.1.4.1 Classes
8.1.4.1.1 NBiometricDevice Class
Provides methods to retrieve information about biometric device. Java public class NBiometricDevice extends NDevice; File NBiometricDevice.java NDevice Classes Name ChildCollection ( NDevice Methods Name getChildren ( see page 566) see page 567) see page 567) getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate ( Description Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type. see page 566) Description Collection of plugged in devices.
see page 567) see page 567) see page 567) see page 567) see page 568) see page 568) see page 568) see page 568) see page 568) see page 568)
getSerialNumber (
nativeTypeOf ( NBiometricDevice Class Name cancel (
Description see page 561) Stops capturing and cancels NBiometricDevice (NFScanner ( 575) or NIrisScanner ( see page 579)). Gets device product Id. Gets device vendor Id. Checks if the device is set to detect spoof objects. Checks if the device is capable to detect spoof objects. Retrieves a function that retrieves NType object for the enclosing type. see see page
getBiometricType ( getProductId ( getVendorId (
see page 561) Gets the type of biometric device.
isSpoofDetection (
isSpoofDetectionSupported ( page 561) nativeTypeOf ( setSpoofDetection (
see page 562)
see page 562) Sets the device to detect spoof objects.
560
8.1 Java Reference
8.1.4.1.1.1 NBiometricDevice Methods

8.1.4.1.1.1.1 NBiometricDevice.cancel Method
Stops capturing and cancels NBiometricDevice ( page 579)). Java public final void cancel(); Remarks Also EndSequence method can be called which cancels device and stops sequence. see page 560) (NFScanner ( see page 575) or NIrisScanner ( see
8.1.4.1.1.1.2 NBiometricDevice.getBiometricType Method

Gets the type of biometric device. Java public final EnumSet<NBiometricType> getBiometricType(); Returns Device biometric type.
8.1.4.1.1.1.3 NBiometricDevice.getProductId Method

Gets device product Id. Java public final short getProductId(); Returns Device product Id.
8.1.4.1.1.1.4 NBiometricDevice.getVendorId Method

Gets device vendor Id. Java public final short getVendorId(); Returns Device vendor Id.
8.1.4.1.1.1.5 NBiometricDevice.isSpoofDetection Method

Checks if the device is set to detect spoof objects. Java public final boolean isSpoofDetection(); Returns true if device is used to detect spoof objects; otherwise false.
8.1.4.1.1.1.6 NBiometricDevice.isSpoofDetectionSupported Method

Checks if the device is capable to detect spoof objects. Java public final boolean isSpoofDetectionSupported(); 561
true if device is capable to detect spoof objects; otherwise false.
8.1.4.1.1.1.7 NBiometricDevice.nativeTypeOf Method

8.1.4.1.1.1.8 NBiometricDevice.setSpoofDetection Method

Sets the device to detect spoof objects. Java public final void setSpoofDetection(boolean value); Parameters Parameters boolean value Description true if device is used to detect spoof objects; otherwise false.
8.1.4.1.2 NCamera Class

Provides methods for working with cameras. Java public final class NCamera extends NCaptureDevice; File NCamera.java NDevice Classes Name ChildCollection ( NDevice Methods Name getChildren ( see page 566) see page 567) see page 567) getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate ( Description Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type. see page 566) Description Collection of plugged in devices.
getSerialNumber (
nativeTypeOf (
562
8.1 Java Reference NCaptureDevice Class Name
Description Adds user specified listener for device capturing changed event.
addCapturingChangedListener ( see page 564) getCurrentFormat ( getFormats ( isCapturing ( nativeTypeOf ( see page 565) see page 565) see page 565)
see page 564) Gets current media format of the capture device. Gets all supported formats by the capture device. Checks if the device is capturing. Retrieves a function that retrieves NType object for the enclosing type. Removes listener for device capturing changed event.
removeCapturingChangedListener ( see page 565) setCurrentFormat ( startCapturing ( stopCapturing ( NCamera Class Name getFrame ( see page 563) see page 563) nativeTypeOf ( see page 565) see page 566)
see page 565) Sets current media format for the capture device. Starts capturing. Stops capturing.
Description Gets current frame from the capture device. Retrieves a function that retrieves NType object for the enclosing type.
8.1.4.1.2.1 NCamera Methods

8.1.4.1.2.1.1 NCamera.getFrame Method
Gets current frame from the capture device. Java public final NImage getFrame(); Returns Frame image.
8.1.4.1.2.1.2 NCamera.nativeTypeOf Method

8.1.4.1.3 NCaptureDevice Class

Provides methods for working with capture devices. Java public class NCaptureDevice extends NDevice; File NCaptureDevice.java NDevice Classes Name ChildCollection ( see page 566) Description Collection of plugged in devices.
563
8.1 Java Reference NDevice Methods Name getChildren (
Description see page 566) see page 567) see page 567) Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type.
getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate (
getSerialNumber (
nativeTypeOf ( NCaptureDevice Class Name
removeCapturingChangedListener ( see page 565) setCurrentFormat ( startCapturing ( stopCapturing ( see page 565) see page 566)
8.1.4.1.3.1 NCaptureDevice Methods

8.1.4.1.3.1.1 NCaptureDevice.addCapturingChangedListener Method
Adds user specified listener for device capturing changed event. Java public final void addCapturingChangedListener(ChangeListener listener); Parameters Parameters ChangeListener listener Description User specified listener.
8.1.4.1.3.1.2 NCaptureDevice.getCurrentFormat Method

Gets current media format of the capture device. Java public NMediaFormat getCurrentFormat(); Returns Current media format of capture device.
564
8.1 Java Reference
8.1.4.1.3.1.3 NCaptureDevice.getFormats Method

Gets all supported formats by the capture device. Java public NMediaFormat getFormats(); Returns Array of supported media formats for the current capture device.
8.1.4.1.3.1.4 NCaptureDevice.isCapturing Method

Checks if the device is capturing. Java public final boolean isCapturing(); Returns boolean type value indicating if the device is capturing.
8.1.4.1.3.1.5 NCaptureDevice.nativeTypeOf Method

8.1.4.1.3.1.6 NCaptureDevice.removeCapturingChangedListener Method

Removes listener for device capturing changed event. Java public final void removeCapturingChangedListener(ChangeListener listener); Parameters Parameters ChangeListener listener Description User specified listener to remove.
8.1.4.1.3.1.7 NCaptureDevice.setCurrentFormat Method

Sets current media format for the capture device. Java public void setCurrentFormat(NMediaFormat format); Parameters Parameters NMediaFormat format Description Current media format to set.
8.1.4.1.3.1.8 NCaptureDevice.startCapturing Method

Starts capturing. Java public final void startCapturing();
565
8.1 Java Reference
8.1.4.1.3.1.9 NCaptureDevice.stopCapturing Method

Stops capturing. Java public final void stopCapturing();
8.1.4.1.4 NDevice Class

Provides functionality for retrieving device information. Java public class NDevice extends NObject; File NDevice.java NDevice Classes Name ChildCollection ( NDevice Methods Name getChildren ( see page 566) see page 567) see page 567) getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate ( Description Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type. see page 566) Description Collection of plugged in devices.
getSerialNumber (
nativeTypeOf (
8.1.4.1.4.1 NDevice Classes

8.1.4.1.4.1.1 NDevice.ChildCollection Class
Collection of plugged in devices. Java public final class ChildCollection extends NObjectReadOnlyCollection<NDevice>; File NDevice.java
8.1.4.1.4.2 NDevice Methods

8.1.4.1.4.2.1 NDevice.getChildren Method
Gets children collections of specified multimodal device.
566
public final ChildCollection getChildren(); Returns Device children collection.
8.1.4.1.4.2.2 NDevice.getDeviceType Method

Gets the type of multimodal device. Java public final EnumSet<NDeviceType> getDeviceType(); Returns Device type.
8.1.4.1.4.2.3 NDevice.getDisplayName Method

Gets device name. Java public final String getDisplayName(); Returns String containing device display name.
8.1.4.1.4.2.4 NDevice.getId Method

Gets device Id. Java public final String getId(); Returns String containing device Id.
8.1.4.1.4.2.5 NDevice.getMake Method

Gets device manufacturer. Java public final String getMake(); Returns String containing device manufacturer.
8.1.4.1.4.2.6 NDevice.getModel Method

Gets model of current biometric device. Java public final String getModel(); Returns String containing device model name.
8.1.4.1.4.2.7 NDevice.getOwner Method

Gets the device owner.
567
public final NDeviceManager getOwner(); Returns Device owner.
8.1.4.1.4.2.8 NDevice.getParent Method

Gets the parent of specified multimodal device module. Java public final NDevice getParent(); Returns Parent of multimodal device.
8.1.4.1.4.2.9 NDevice.getPlugin Method

Gets device plugin. Java public final NPlugin getPlugin(); Returns Device plugin.
8.1.4.1.4.2.10 NDevice.getSerialNumber Method

Gets serial number of current biometric device. Java public final String getSerialNumber(); Returns String containing device serial number.
8.1.4.1.4.2.11 NDevice.isAvailable Method

Checks if the device is available. Java public final boolean isAvailable(); Returns Boolean value indicating if the device is available.
8.1.4.1.4.2.12 NDevice.isPrivate Method

Checks if the device is private. Java public final boolean isPrivate(); Returns Boolean value indicating if the device is private.
8.1.4.1.4.2.13 NDevice.nativeTypeOf Method

568
8.1.4.1.5 NDeviceManager Class

Provides functionality for managing devices. Java public final class NDeviceManager extends NObject; File NDeviceManager.java Methods Name NDeviceManager ( NDeviceManager Classes Name DeviceCollection ( NDeviceManager Methods Name addDevicesChangeListener ( page 571) see Description !doc ======================================================== === Event handling ======================================================== === * Adds user specified listener for any device changes event. @param listener [in] User specified listener. getDevices ( see page 571) see page 572) Gets devices collection of the current NDeviceManager object. Gets supported device types by NDeviceManager. Checks whether NDeviceManager automatically updates devices list. Retrieves a function that retrieves NType object for the enclosing type. Refreshes plugged devices list. Removes user specified listener from any device changes event. see page 570) Description Collection of plugged in devices. Description see page 569) Initializes a new instance of the NDeviceManager class.
getDeviceTypes ( getPluginManager ( isAutoUpdate ( nativeTypeOf ( refresh (
see page 572) Gets the plugin manager.
see page 572)
removeDevicesChangeListener ( see page 572)
8.1.4.1.5.1 NDeviceManager Constructor

8.1.4.1.5.1.1 NDeviceManager.NDeviceManager Constructor ()
Initializes a new instance of the NDeviceManager class. Java public NDeviceManager();
569
8.1 Java Reference
8.1.4.1.5.1.2 NDeviceManager.NDeviceManager Constructor (EnumSet<NDeviceType>)

Initializes a new instance of the NDeviceManager class. Java public NDeviceManager(EnumSet<NDeviceType> deviceTypes); Parameters Parameters EnumSet<NDeviceType> deviceTypes Description Device types supported by NDeviceManager. If value Any is specified, new NDeviceManager will support all device types.
8.1.4.1.5.1.3 NDeviceManager.NDeviceManager Constructor (EnumSet<NDeviceType>, boolean)

Initializes a new instance of the NDeviceManager class. Java public NDeviceManager(EnumSet<NDeviceType> deviceTypes, boolean autoPlug); Parameters Parameters EnumSet<NDeviceType> deviceTypes boolean autoPlug Description Device types supported by NDeviceManager. If value Any is specified, new NDeviceManager will support all device types. Bool value for automatic devices listing. If set to true, NDeviceManager automatically plugs-in devices and adds them to a list.
8.1.4.1.5.1.4 NDeviceManager.NDeviceManager Constructor (EnumSet<NDeviceType>, boolean, boolean)

Initializes a new instance of the NDeviceManager class. Java public NDeviceManager(EnumSet<NDeviceType> deviceTypes, boolean autoPlug, boolean autoUpdate); Parameters Parameters EnumSet<NDeviceType> deviceTypes boolean autoPlug Description Device types supported by NDeviceManager. If value Any is specified, new NDeviceManager will support all device types. Bool value for automatic devices listing. If set to true, NDeviceManager automatically plugs-in devices and adds them to a list. Bool value for automatic devices update. If set to true, NDeviceManager will automatically update devices list when new device is added or removed.
boolean autoUpdate
8.1.4.1.5.2 NDeviceManager Classes

8.1.4.1.5.2.1 NDeviceManager.DeviceCollection Class
Collection of plugged in devices. Java public final class DeviceCollection extends NObjectReadOnlyCollection<NDevice>; File NDeviceManager.java
570
8.1 Java Reference DeviceCollection Methods Name get ( see page 571) see page 571) indexOf (
Description Gets NDevice ( see page 566) object specified by Id. Retrieves device's index in a collection by specified device Id.
8.1.4.1.5.2.1.1 DeviceCollection Methods 8.1.4.1.5.2.1.1.1 NDeviceManager.DeviceCollection.get Method

Gets NDevice ( Java public NDevice get(String id); Parameters Parameters Device Returns NDevice ( see page 566) object. Description identifier. see page 566) object specified by Id.
8.1.4.1.5.2.1.1.2 NDeviceManager.DeviceCollection.indexOf Method

Retrieves device's index in a collection by specified device Id. Java public int indexOf(String id); Parameters Parameters Device Returns Device index in the collection. Description identifier.
8.1.4.1.5.3 NDeviceManager Methods

8.1.4.1.5.3.1 NDeviceManager.addDevicesChangeListener Method
!doc =========================================================== =========================================================== * Adds user specified listener for any device changes event. @param listener [in] User specified listener. Java public void addDevicesChangeListener(NDevicesChangeListener listener); Event handling
8.1.4.1.5.3.2 NDeviceManager.getDevices Method

Gets devices collection of the current NDeviceManager ( Java public DeviceCollection getDevices(); Returns Device collection containing all devices of the current NDeviceManager ( see page 569). see page 569) object.
571
8.1 Java Reference
8.1.4.1.5.3.3 NDeviceManager.getDeviceTypes Method

Gets supported device types by NDeviceManager ( Java public EnumSet<NDeviceType> getDeviceTypes(); Returns Supported device types. see page 569).
8.1.4.1.5.3.4 NDeviceManager.getPluginManager Method

Gets the plugin manager. Java public static NPluginManager getPluginManager(); Returns NPluginManager object.
8.1.4.1.5.3.5 NDeviceManager.isAutoUpdate Method

Checks whether NDeviceManager ( Java public boolean isAutoUpdate(); Returns true, if NDevice ( see page 566) manager automatically updates devices list. otherwise false. see page 569) automatically updates devices list.
8.1.4.1.5.3.6 NDeviceManager.nativeTypeOf Method

8.1.4.1.5.3.7 NDeviceManager.refresh Method

Refreshes plugged devices list. Java public void refresh();
8.1.4.1.5.3.8 NDeviceManager.removeDevicesChangeListener Method

Removes user specified listener from any device changes event. Java public void removeDevicesChangeListener(NDevicesChangeListener listener); Parameters Parameters NDevicesChangeListener listener Description [in] User specified listener.
572
8.1 Java Reference
8.1.4.1.6 NDevices Class

Provides information about the NDevices library. Java public final class NDevices; File NDevices.java NDevices Fields Name DLL_NAME ( see page 573) see page NATIVE_LIBRARY ( 573) NDevices Methods Name nativeModuleOf ( see page 573) Description Retrieves a function that retrieves NModule object for the enclosing module. Description Name of DLL containing unmanaged part of this component. The object incapsulating the native library.
8.1.4.1.6.1 NDevices Fields

8.1.4.1.6.1.1 NDevices.DLL_NAME Field
Name of DLL containing unmanaged part of this component. Java public static final String DLL_NAME = "NDevices";
8.1.4.1.6.1.2 NDevices.NATIVE_LIBRARY Field

8.1.4.1.6.2 NDevices Methods

8.1.4.1.6.2.1 NDevices.nativeModuleOf Method
8.1.4.1.7 NFingerScanner Class

Represents fingerprints scanner. Java public final class NFingerScanner extends NFScanner; File NFingerScanner.java 573
8.1 Java Reference NDevice Classes Name ChildCollection ( NFScanner Class Name CaptureResult ( NDevice Methods Name getChildren (
Description see page 566) Collection of plugged in devices.
Description see page 576) Represents image capturing result.
Description see page 566) see page 567) see page 567) Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type.
getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate (
getSerialNumber (
Description see page 561) Stops capturing and cancels NBiometricDevice ( see page 560) (NFScanner ( see page 575) or NIrisScanner ( see page 579)). Gets device product Id. Gets device vendor Id. Checks if the device is set to detect spoof objects. Checks if the device is capable to detect spoof objects. Retrieves a function that retrieves NType object for the enclosing type. see
isSpoofDetection (
isSpoofDetectionSupported ( page 561) nativeTypeOf ( setSpoofDetection ( NFScanner Class Name addPreviewListener ( 577) capture (
see page 562)
Description see page Adds user specified Preview event listener. Captures fingerprint or palmprint image. Gets impression types supported by the specified device.
see page 577)
getSupportedImpressionTypes ( see page 579) getSupportedPositions ( 579) nativeTypeOf ( removePreviewListener ( page 579)
see page Gets fingerprint positions supported by the specified device. Retrieves a function that retrieves NType object for the enclosing type. Removes user specified Preview event listener.
see page 579) see
574
8.1 Java Reference NFingerScanner Class Name nativeTypeOf (
8.1.4.1.7.1 NFingerScanner Methods

8.1.4.1.7.1.1 NFingerScanner.nativeTypeOf Method
8.1.4.1.8 NFScanner Class

Represents fingerprints and palmprints scanning device. Java public class NFScanner extends NBiometricDevice; File NFScanner.java NDevice Classes Name ChildCollection ( NFScanner Class Name CaptureResult ( NDevice Methods Name getChildren ( see page 566) see page 567) see page 567) getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate ( Description Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type. see page 576) Description Represents image capturing result. see page 566) Description Collection of plugged in devices.
getSerialNumber (
nativeTypeOf (
575
8.1 Java Reference NBiometricDevice Class Name cancel ( see page 561)
Description Stops capturing and cancels NBiometricDevice ( (NFScanner or NIrisScanner ( see page 579)). Gets device product Id. Gets device vendor Id. Checks if the device is set to detect spoof objects. Checks if the device is capable to detect spoof objects. Retrieves a function that retrieves NType object for the enclosing type. see see page 560)
isSpoofDetection (
see page 562)
see page 577)
getSupportedImpressionTypes ( see page 579) getSupportedPositions ( 579) nativeTypeOf ( removePreviewListener ( page 579)
see page 579) see
8.1.4.1.8.1 NFScanner Classes

8.1.4.1.8.1.1 NFScanner.CaptureResult Class
Represents image capturing result. Java public static final class CaptureResult; File NFScanner.java CaptureResult Methods Name getImage ( getObjects ( getStatus ( see page 576) see page 577) see page 577) Description Gets NImage which was scanned by a device. Gets scanned image attributes. Gets device biometric status.
8.1.4.1.8.1.1.1 CaptureResult Methods 8.1.4.1.8.1.1.1.1 NFScanner.CaptureResult.getImage Method

Gets NImage which was scanned by a device. Java public NImage getImage(); Returns NImage type image. 576
8.1 Java Reference
8.1.4.1.8.1.1.1.2 NFScanner.CaptureResult.getObjects Method

Gets scanned image attributes. Java public NFAttributes getObjects(); Returns Image attributes.
8.1.4.1.8.1.1.1.3 NFScanner.CaptureResult.getStatus Method

Gets device biometric status. Java public NBiometricStatus getStatus(); Returns Device biometric status.
8.1.4.1.8.2 NFScanner Methods

8.1.4.1.8.2.1 NFScanner.addPreviewListener Method
Adds user specified Preview event listener. Java public final void addPreviewListener(NFScannerPreviewListener listener); Parameters Parameters NFScannerPreviewListener listener Remarks Preview event is invoked when scanning device receives fingerprint or palmprint image and can display it to user. Description User specified event listener to add.
8.1.4.1.8.2.2 capture Method 8.1.4.1.8.2.2.1 NFScanner.capture Method ()

Captures fingerprint or palmprint image. Java public NImage capture(); Returns Fingerprint or palmprint image.
8.1.4.1.8.2.2.2 NFScanner.capture Method (NFImpressionType, NFPosition)

Captures fingerprint or palmprint image. Java public final CaptureResult capture(NFImpressionType impressionType, NFPosition position); Parameters Parameters NFImpressionType impressionType Description Fingerprint impression type. 577
8.1 Java Reference NFPosition position Returns CaptureResult (
Fingerprint position value.
see page 576) object which contains information about captured image.
8.1.4.1.8.2.2.3 NFScanner.capture Method (NFImpressionType, NFPosition, NFPosition[], boolean, int, boolean)

Captures fingerprint or palmprint image. Java public final CaptureResult capture(NFImpressionType impressionType, NFPosition position, NFPosition[] missingPositions, boolean automatic, int timeoutMilliseconds, boolean returnObjects); Parameters Parameters NFImpressionType impressionType NFPosition position NFPosition[] missingPositions boolean automatic Description Fingerprint impression type. Fingerprint position value. Array of missing fingerprint positions (eg. amputated) in scanned image. Value which allows the scanner to decide about the image quality. When true is set scanning device checks image quality and decides when this image should be returned for a user. When false is set user can can control image quality and capturing process himself. In this case Preview event should be used to change device status (eg. when image quality is acceptable and scanner operator press stop scanning key, nbsOk value for NBiometricStatus can be set). Default: It is recommended to use true value. Maximum time to wait for device response (to start capturing). Bool type value which indicates whether to return scanning attributes.
int timeoutMilliseconds boolean returnObjects Returns CaptureResult (
8.1.4.1.8.2.2.4 NFScanner.capture Method (NFImpressionType, NFPosition, int)

Captures fingerprint or palmprint image. Java public final CaptureResult capture(NFImpressionType impressionType, NFPosition position, int timeoutMilliseconds); Parameters Parameters NFImpressionType impressionType NFPosition position int timeoutMilliseconds Returns CaptureResult ( see page 576) object which contains information about captured image. Description Fingerprint impression type. Fingerprint position value. Maximum time to wait for device response (to start capturing).
8
8.1.4.1.8.2.2.5 NFScanner.capture Method (int)
Captures fingerprint or palmprint image. 578
public final NImage capture(int timeoutMilliseconds); Parameters Parameters int timeoutMilliseconds Returns Fingerprint or palmprint image. Description Maximum time to wait for device response (to start capturing).
8.1.4.1.8.2.3 NFScanner.getSupportedImpressionTypes Method

Gets impression types supported by the specified device. Java public final NFImpressionType getSupportedImpressionTypes(); Returns Array of impression types supported by the current device.
8.1.4.1.8.2.4 NFScanner.getSupportedPositions Method

Gets fingerprint positions supported by the specified device. Java public final NFPosition getSupportedPositions(); Returns Array of fingerprint positions supported by the current device.
8.1.4.1.8.2.5 NFScanner.nativeTypeOf Method

8.1.4.1.8.2.6 NFScanner.removePreviewListener Method

Removes user specified Preview event listener. Java public final void removePreviewListener(NFScannerPreviewListener listener); Parameters Parameters NFScannerPreviewListener listener Remarks Preview event is invoked when scanning device receives fingerprint or palmprint image and can display it to user. Description User specified event listener to remove.
8.1.4.1.9 NIrisScanner Class

Represents irises scanning device. 579
public final class NIrisScanner extends NBiometricDevice; File NIrisScanner.java NDevice Classes Name ChildCollection ( NIrisScanner Class Name CaptureResult ( NDevice Methods Name getChildren ( see page 566) see page 567) see page 567) getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate ( Description Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type. see page 581) Description Represents image capturing result. see page 566) Description Collection of plugged in devices.
getSerialNumber (
Description see page 561) Stops capturing and cancels NBiometricDevice ( (NFScanner ( see page 575) or NIrisScanner). Gets device product Id. Gets device vendor Id. Checks if the device is set to detect spoof objects. Checks if the device is capable to detect spoof objects. Retrieves a function that retrieves NType object for the enclosing type. see see page 560)
isSpoofDetection (
isSpoofDetectionSupported ( page 561) nativeTypeOf ( setSpoofDetection ( NIrisScanner Class Name addPreviewListener ( 582) capture (
see page 562)
Description see page Adds user specified Preview event listener. Captures iris image. see page Gets iris positions supported by the device. Retrieves a function that retrieves NType object for the enclosing type.
see page 582)
getSupportedPositions ( 583) nativeTypeOf (
see page 583)
580
8.1 Java Reference removePreviewListener ( page 583)
see
Removes user specified Preview event listener.
8.1.4.1.9.1 NIrisScanner Classes

8.1.4.1.9.1.1 NIrisScanner.CaptureResult Class
Represents image capturing result. Java public static final class CaptureResult; File NIrisScanner.java Methods Name CaptureResult ( CaptureResult Methods Name getImage ( getObjects ( getStatus ( see page 581) see page 581) see page 582) Description Gets NImage which was scanned by a device. Gets scanned iris image attributes. Gets device biometric status. see page 581) Description Creates new instance of CaptureResult.
8.1.4.1.9.1.1.1 NIrisScanner.CaptureResult.CaptureResult Constructor

Creates new instance of CaptureResult. Java public CaptureResult(NImage image, NEAttributes[] objects, NBiometricStatus status); Parameters Parameters NImage image NEAttributes[] objects NBiometricStatus status Description [in] NImage type image. [in] Array which contains information about objects in scanned image. [in] Device biometric status.
8.1.4.1.9.1.1.2 CaptureResult Methods 8.1.4.1.9.1.1.2.1 NIrisScanner.CaptureResult.getImage Method

Gets NImage which was scanned by a device. Java public NImage getImage(); Returns NImage type image.
8.1.4.1.9.1.1.2.2 NIrisScanner.CaptureResult.getObjects Method

Gets scanned iris image attributes. Java public NEAttributes getObjects();
581
8.1 Java Reference Returns Image attributes.
8.1.4.1.9.1.1.2.3 NIrisScanner.CaptureResult.getStatus Method

Gets device biometric status. Java public NBiometricStatus getStatus(); Returns Device biometric status.
8.1.4.1.9.2 NIrisScanner Methods

8.1.4.1.9.2.1 NIrisScanner.addPreviewListener Method
Adds user specified Preview event listener. Java public final void addPreviewListener(NIrisScannerPreviewListener listener); Parameters Parameters NIrisScannerPreviewListener listener Remarks Preview event is invoked when scanning device receives iris image and can display it to user. Description User specified event listener to add.
8.1.4.1.9.2.2 capture Method 8.1.4.1.9.2.2.1 NIrisScanner.capture Method (NEPosition)

Captures iris image. Java public NImage capture(NEPosition position); Parameters Parameters NEPosition position Returns Captured iris image. Description Iris position value.
8.1.4.1.9.2.2.2 NIrisScanner.capture Method (NEPosition, NEPosition[], boolean, int, boolean)

Captures iris image. Java public final CaptureResult capture(NEPosition position, NEPosition[] missingPositions, boolean automatic, int timeoutMilliseconds, boolean returnObjects); Parameters Parameters NEPosition position NEPosition[] missingPositions Description Iris position value. Array of missing iris positions in scanned image. 582
8.1 Java Reference boolean automatic
Value which allows the scanner to decide about the image quality. When true is set scanning device checks image quality and decides when this image should be returned for a user. When false is set user can can control image quality and capturing process himself. In this case Preview event should be used to change device status (eg. when image quality is acceptable and scanner operator press stop scanning key, nbsOk value for NBiometricStatus can be set). Default: It is recommended to use true value. [out] Maximum time (milliseconds) to wait for device response (to start capturing). Bool type value which indicates whether to return scanning attributes.
int timeoutMilliseconds boolean returnObjects Returns CaptureResult (
8.1.4.1.9.2.2.3 NIrisScanner.capture Method (NEPosition, int)

Captures iris image. Java public final NImage capture(NEPosition position, int timeoutMilliseconds); Parameters Parameters NEPosition position int timeoutMilliseconds Returns Captured iris image. Description Iris position value. [out] Maximum time (milliseconds) to wait for device response (to start capturing).
8.1.4.1.9.2.3 NIrisScanner.getSupportedPositions Method

Gets iris positions supported by the device. Java public final NEPosition getSupportedPositions(); Returns Array of iris positions supported by the current device.
8.1.4.1.9.2.4 NIrisScanner.nativeTypeOf Method

8.1.4.1.9.2.5 NIrisScanner.removePreviewListener Method

Removes user specified Preview event listener. Java public final void removePreviewListener(NIrisScannerPreviewListener listener);
583
8.1 Java Reference Parameters Parameters NIrisScannerPreviewListener listener Remarks
Description User specified event listener to remove.
Preview event is invoked when scanning device receives iris image and can display it to user.
8.1.4.1.10 NMicrophone Class

Provides methods for working with sound recording devices (microphones). Java public final class NMicrophone extends NCaptureDevice; File NMicrophone.java NDevice Classes Name ChildCollection ( NDevice Methods Name getChildren ( see page 566) see page 567) see page 567) getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( getPlugin ( isAvailable ( isPrivate ( Description Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type. see page 566) Description Collection of plugged in devices.
getSerialNumber (
nativeTypeOf ( NCaptureDevice Class Name
removeCapturingChangedListener ( see page 565) setCurrentFormat ( startCapturing ( stopCapturing ( see page 565) see page 566)
584
8.1 Java Reference NMicrophone Class Name getSoundSample ( nativeTypeOf (
Description see page 585) Gets sound sample from the recording device. Retrieves a function that retrieves NType object for the enclosing type. see page 585)
8.1.4.1.10.1 NMicrophone Methods

8.1.4.1.10.1.1 NMicrophone.getSoundSample Method
Gets sound sample from the recording device. Java public final NSoundBuffer getSoundSample(); Returns Sound buffer object which receives sound sample from recording device.
8.1.4.1.10.1.2 NMicrophone.nativeTypeOf Method

8.1.4.1.11 NPalmScanner Class

Represents palmprints scanner. Java public final class NPalmScanner extends NFScanner; File NPalmScanner.java NDevice Classes Name ChildCollection ( NFScanner Class Name CaptureResult ( NDevice Methods Name getChildren ( see page 566) see page 567) see page 567) getDeviceType ( getDisplayName ( getId ( getMake ( getModel ( getOwner ( getParent ( Description Gets children collections of specified multimodal device. Gets the type of multimodal device. Gets device name. Gets device Id. Gets device manufacturer. Gets model of current biometric device. Gets the device owner. Gets the parent of specified multimodal device module. 585 see page 576) Description Represents image capturing result. see page 566) Description Collection of plugged in devices.
8.1 Java Reference getPlugin ( isAvailable ( isPrivate ( see page 568)
com.neurotec.images Package
Gets device plugin. Gets serial number of current biometric device. Checks if the device is available. Checks if the device is private. Retrieves a function that retrieves NType object for the enclosing type.
getSerialNumber (
see page 568)
Description see page 561) Stops capturing and cancels NBiometricDevice ( see page 560) (NFScanner ( see page 575) or NIrisScanner ( see page 579)). Gets device product Id. Gets device vendor Id. Checks if the device is set to detect spoof objects. Checks if the device is capable to detect spoof objects. Retrieves a function that retrieves NType object for the enclosing type. see
isSpoofDetection (
see page 562)
see page 577)
getSupportedImpressionTypes ( see page 579) getSupportedPositions ( 579) nativeTypeOf ( removePreviewListener ( page 579) NPalmScanner Class Name nativeTypeOf ( see page 586)
see page 579) see
Description Retrieves a function that retrieves NType object for the enclosing type.
8.1.4.1.11.1 NPalmScanner Methods

8.1.4.1.11.1.1 NPalmScanner.nativeTypeOf Method
8.1.5 com.neurotec.images Package

8
Contains classes that provide functionality for loading, saving and converting images in various formats.
586
8.1 Java Reference Module Java Reference ( Classes Name NGrayscaleImage ( NImage ( NImageFormat ( NImageInfo ( NImages ( NRGB ( PNGInfo ( NPixelFormat ( NRGBImage ( see page 589) see page 59)
Description see page 587) Provides functionality for managing 8-bit grayscale images. Provides functionality for managing images. Provides functionality for loading and saving images in format-neutral style. Retrieves the object information. Provides library registration and other additional functionality. Provides functionality for working with pixel format. Represents an RGB color. Provides functionality for managing 24-bit RGB images. Provides infromation about PNG format images.
see page 622)
see page 634)
8.1.5.1 Classes
8.1.5.1.1 NGrayscaleImage Class
Provides functionality for managing 8-bit grayscale images. Java public final class NGrayscaleImage extends NImage; File NGrayscaleImage.java NImage Classes Name PlaneCollection ( NImage Fields Name Description see page 591) Description Represents a collection of planes.
FLAG_DST_ALPHA_CHANNEL_FIRST This flag is used when Nimage should be copied using RGB Alpha ( see page 591) channel first method (ARGB color space). FLAG_DST_BOTTOM_TO_TOP ( page 591) FLAG_DST_SWAP_CHANNELS ( see page 591) see This flag is used when NImage ( see page 589) should be copied changing pixels order bottom to top (bottom lines become top and vice versa). This flag is used when NImage ( see page 589) should be copied swapping RGB channels (Eg. RGB to BRG).
FLAG_SRC_ALPHA_CHANNEL_FIRST This flag is used when Nimage should be copied using RGB Alpha ( see page 591) channel first method (ARGB color space). FLAG_SRC_BOTTOM_TO_TOP ( see page 591) FLAG_SRC_SWAP_CHANNELS ( see page 592) NImage Methods Name copy ( see page 592) Description Copies specified rectangular area of the NImage ( other NImage ( see page 589) object. see page 589) to This flag is used when NImage ( see page 589) should be copied changing pixels order bottom to top (bottom lines become top and vice versa). This flag is used when NImage ( see page 589) should be copied swapping RGB channels (Eg. RGB to BRG).
587
8.1 Java Reference copyFrom ( copyTo ( create ( crop ( see page 594)
Copies pixels to from memory buffer. Copies specified rectangular area of the NImage ( other NImage ( see page 589) object. Crops an image. Flips image diagonally. Flips image horizontally. Flips image vertically. Creates NImageWithInfo object from a byte channel. Creates NImage ( Creates NImage ( see page 589) object from data. see page 589) object from file. see page 589) to
Creates an image with specified pixel format, size and stride.
flipDiagonally ( flipHorizontally ( flipVertically ( fromChannel ( fromData ( fromFile ( fromImage (
Creates NImage ( see page 589) object from another NImage ( see page 589) object. note If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Creates NImageWithInfo object from an input stream. Creates NImageWithInfo object from memory a memory buffer. Gets height of image from NImage ( see page 589) object. Gets horizontal resolution in pixels per inch of image. Horizontal resolution equal to zero means that it is not applicable for the image. Gets size of NImage ( Gets size of NImage ( see page 589) object. see page 589) object.
fromInputStream ( fromMemory ( getHeight (
see page 608)
see page 611)
getHorzResolution ( 612) getImageSize (
getLongImageSize ( 612) getLongPlaneSize ( getLongStride ( getPixelFormat ( getPixels ( getPlanes ( getStride ( getWidth (
see page 612) Gets the plane size. Gets stride of image from NImage ( Gets NPixelFormat ( object. see page 589) object. see page 589) see page 636) of NImage (
see page 613) see page 613) see page 613) see page 613) see page 614) see page 614) see
Gets pointer to array of pixels from NImage ( Gets the collection of planes. Gets the plane size. Gets stride of image from NImage ( Gets width of image from NImage ( Creates NImage ( Gets NImage (
getPlaneSize (
see page 589) object. see page 589) object.
getVertResolution ( getWrapper (
see page 614) Gets vertical resolution in pixels per inch of image. see page 589) object wrapper.
isResolutionIsAspectRatio ( page 617) nativeTypeOf ( rotateFlip ( save ( see page 617)
see page 589) resolution aspect ratio.
see page 617)
Retrieves a function that retrieves NType object for the enclosing type. Rotates image using rotation type. Saves image to memory buffer using specified format.
see page 618) see
setHorzResolution (
see page 621) Sets horizontal resolution in pixels per inch of image. Sets NImage ( see page 589) resolution aspect ratio.
setResolutionIsAspectRatio ( page 621) setVertResolution ( toGrayscale ( toImage ( toRgb ( see page 621)
see page 621) Sets vertical resolution in pixels per inch of image. Converts NImage ( Converts NImage ( Converts NImage ( see page 589) to NGrayscaleImage. see page 589) to monochrome image. see page 589) to Rgb image. Creates an Image object.
toMonochrome (
NGrayscaleImage Class Name get ( see page 589) Description Gets the color of the specified pixel in NImage ( see page 589).
588
8.1 Java Reference nativeTypeOf ( set (
see page 589)
Retrieves a function that retrieves NType object for the enclosing type. Sets the color of the specified pixel in NImage ( see page 589).
see page 589)
8.1.5.1.1.1 NGrayscaleImage Methods

8.1.5.1.1.1.1 NGrayscaleImage.get Method
Gets the color of the specified pixel in NImage ( Java public byte get(int x, int y); Parameters Parameters int x int y Returns A color of specified pixel. Description X coordinate of the pixel. Y coordinate of the pixel. see page 589).
8.1.5.1.1.1.2 NGrayscaleImage.nativeTypeOf Method

8.1.5.1.1.1.3 NGrayscaleImage.set Method

Sets the color of the specified pixel in NImage ( Java public void set(int x, int y, byte value); Parameters Parameters int x int y byte value Description X coordinate of the pixel. Y coordinate of the pixel. the color of the specified pixel in NImage ( see page 589). see page 589).
8.1.5.1.2 NImage Class

Provides functionality for managing images. Java public class NImage extends NObject implements Cloneable; File NImage.java NImage Classes Name PlaneCollection ( see page 591) Description Represents a collection of planes.
589
8.1 Java Reference NImage Fields Name
Description
FLAG_DST_ALPHA_CHANNEL_FIRST This flag is used when Nimage should be copied using RGB Alpha ( see page 591) channel first method (ARGB color space). FLAG_DST_BOTTOM_TO_TOP ( page 591) FLAG_DST_SWAP_CHANNELS ( see page 591) see This flag is used when NImage should be copied changing pixels order bottom to top (bottom lines become top and vice versa). This flag is used when NImage should be copied swapping RGB channels (Eg. RGB to BRG).
FLAG_SRC_ALPHA_CHANNEL_FIRST This flag is used when Nimage should be copied using RGB Alpha ( see page 591) channel first method (ARGB color space). FLAG_SRC_BOTTOM_TO_TOP ( see page 591) FLAG_SRC_SWAP_CHANNELS ( see page 592) NImage Methods Name copy ( see page 592) see page 594) see page 596) see page 599) see page 600) see page 600) see page 600) see page 600) see page 600) copyFrom ( copyTo ( create ( crop ( Description Copies specified rectangular area of the NImage to other NImage object. Copies pixels to from memory buffer. Copies specified rectangular area of the NImage to other NImage object. Creates an image with specified pixel format, size and stride. Crops an image. Flips image diagonally. Flips image horizontally. Flips image vertically. Creates NImageWithInfo object from a byte channel. Creates NImage object from data. Creates NImage object from file. Creates NImage object from another NImage object. note If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Creates NImageWithInfo object from an input stream. Creates NImageWithInfo object from memory a memory buffer. Gets height of image from NImage object. Gets horizontal resolution in pixels per inch of image. Horizontal resolution equal to zero means that it is not applicable for the image. Gets size of NImage object. Gets size of NImage object. This flag is used when NImage should be copied changing pixels order bottom to top (bottom lines become top and vice versa). This flag is used when NImage should be copied swapping RGB channels (Eg. RGB to BRG).
see page 608)
see page 611)
getHorzResolution ( 612) getImageSize (
see page 612) Gets the plane size. Gets stride of image from NImage object. Gets NPixelFormat ( see page 636) of NImage object. Gets pointer to array of pixels from NImage object. Gets the collection of planes. Gets the plane size. Gets stride of image from NImage object. Gets width of image from NImage object. Creates NImage object wrapper. Gets NImage resolution aspect ratio. see
getPlaneSize (
see page 614) Gets vertical resolution in pixels per inch of image.
isResolutionIsAspectRatio ( page 617)
590
8.1 Java Reference nativeTypeOf ( rotateFlip ( save (
see page 617)
see page 617)
see page 618) see
setHorzResolution (
see page 621) Sets horizontal resolution in pixels per inch of image. Sets NImage resolution aspect ratio.
setResolutionIsAspectRatio ( page 621) setVertResolution ( toGrayscale ( toImage ( toRgb ( see page 621)
see page 621) Sets vertical resolution in pixels per inch of image. Converts NImage to NGrayscaleImage ( Creates an Image object. Converts NImage to monochrome image. Converts NImage to Rgb image. see page 587).
toMonochrome (
8.1.5.1.2.1 NImage Classes

8.1.5.1.2.1.1 NImage.PlaneCollection Class
Represents a collection of planes. Java public final class PlaneCollection extends ByteBufferReadOnlyCollection; File NImage.java
8.1.5.1.2.2 NImage Fields

8.1.5.1.2.2.1 NImage.FLAG_DST_ALPHA_CHANNEL_FIRST Field
This flag is used when Nimage should be copied using RGB Alpha channel first method (ARGB color space). Java public static final int FLAG_DST_ALPHA_CHANNEL_FIRST = 0x00000200;
8.1.5.1.2.2.2 NImage.FLAG_DST_BOTTOM_TO_TOP Field

This flag is used when NImage ( become top and vice versa). Java public static final int FLAG_DST_BOTTOM_TO_TOP = 0x00000400; see page 589) should be copied changing pixels order bottom to top (bottom lines
8.1.5.1.2.2.3 NImage.FLAG_DST_SWAP_CHANNELS Field

This flag is used when NImage ( Java public static final int FLAG_DST_SWAP_CHANNELS = 0x00000100; see page 589) should be copied swapping RGB channels (Eg. RGB to BRG).
8.1.5.1.2.2.4 NImage.FLAG_SRC_ALPHA_CHANNEL_FIRST Field

This flag is used when Nimage should be copied using RGB Alpha channel first method (ARGB color space). Java public static final int FLAG_SRC_ALPHA_CHANNEL_FIRST = 0x00002000;
8.1.5.1.2.2.5 NImage.FLAG_SRC_BOTTOM_TO_TOP Field

This flag is used when NImage ( become top and vice versa). see page 589) should be copied changing pixels order bottom to top (bottom lines
591
public static final int FLAG_SRC_BOTTOM_TO_TOP = 0x00004000;
8.1.5.1.2.2.6 NImage.FLAG_SRC_SWAP_CHANNELS Field

This flag is used when NImage ( Java public static final int FLAG_SRC_SWAP_CHANNELS = 0x00001000; see page 589) should be copied swapping RGB channels (Eg. RGB to BRG).
8.1.5.1.2.3 NImage Methods

8.1.5.1.2.3.1 copy Method 8.1.5.1.2.3.1.1 NImage.copy Method (NImage, int, int, int, int, NImage, int, int)
Copies specified rectangular area of the NImage ( Java public static void copy(NImage srcImage, int left, int top, int width, int height, NImage dstImage, int dstLeft, int dstTop); Parameters Parameters NImage srcImage int left int top int width int height NImage dstImage int dstLeft Description NImage ( see page 589) object to copy. The x coordinate of source rectangle. The y coordinate of source rectangle. The width of source rectangle. The height of source rectangle. A destination NImage ( see page 589) object. Specified rectangular area will be copied to this object. The x coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. The y coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. see page 589) to other NImage ( see page 589) object.
int dstTop
8.1.5.1.2.3.1.2 NImage.copy Method (NPixelFormat, int, int, int, ByteBuffer, int, int, NPixelFormat, int, int, int, ByteBuffer, int, int, int, int)
Copies pixels from one memory buffer to another. Java public static void copy(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, int srcStride, ByteBuffer srcPixels, int srcLeft, int srcTop, NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, int dstStride, ByteBuffer dstPixels, int dstLeft, int dstTop, int width, int height); Parameters Parameters NPixelFormat srcPixelFormat int srcWidth int srcHeight int srcStride ByteBuffer srcPixels int srcLeft Description The source pixel format. The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the source image data. 592
8.1 Java Reference int srcTop NPixelFormat dstPixelFormat int dstWidth int dstHeight int dstStride ByteBuffer dstPixels int dstLeft int dstTop int width int height
The top coordinate of the source image data. The destination pixel format. The width of the destination image data. The height of the destination image data. The stride of the destination image data. The destination memory block. The left coordinate of the destination image data. The top coordinate of the destination image data. Image width. Image height.
8.1.5.1.2.3.1.3 NImage.copy Method (NPixelFormat, int, int, long, ByteBuffer, int, int, NPixelFormat, int, int, long, ByteBuffer, int, int, int, int, int)
Copies pixels from one memory buffer to another. Java public static void copy(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, long srcStride, ByteBuffer srcPixels, int srcLeft, int srcTop, NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, long dstStride, ByteBuffer dstPixels, int dstLeft, int dstTop, int width, int height, int flags); Parameters Parameters NPixelFormat srcPixelFormat int srcWidth int srcHeight long srcStride ByteBuffer srcPixels int srcLeft int srcTop NPixelFormat dstPixelFormat int dstWidth int dstHeight long dstStride ByteBuffer dstPixels int dstLeft int dstTop int width int height int flags Description The source pixel format. The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the source image data. The top coordinate of the source image data. The destination pixel format. The width of the destination image data. The height of the destination image data. The stride of the destination image data. The destination memory block. The left coordinate of the destination image data. The top coordinate of the destination image data. Image width. Image height. Flags controlling function. These flags can be used: NI_DST_ALPHA_CHANNEL_FIRST, NI_DST_BOTTOM_TO_TOP, NI_DST_SWAP_CHANNELS.
8.1.5.1.2.3.1.4 NImage.copy Method (NPixelFormat, int, int, long, ByteBuffer[], int, int, NPixelFormat, int, int, long, ByteBuffer[], int, int, int, int, int)
Copies planes from one memory buffer to another. Java public static void copy(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, long srcStride, ByteBuffer[] srcPlanes, int srcLeft, int srcTop, NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, long dstStride, ByteBuffer[] dstPlanes, int dstLeft, int dstTop, int width, int height, int flags);
593
8.1 Java Reference Parameters Parameters NPixelFormat srcPixelFormat int srcWidth int srcHeight long srcStride ByteBuffer[] srcPlanes int srcLeft int srcTop NPixelFormat dstPixelFormat int dstWidth int dstHeight long dstStride ByteBuffer[] dstPlanes int dstLeft int dstTop int width int height int flags
Description The source pixel format. The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the source image data. The top coordinate of the source image data. The destination pixel format. The width of the destination image data. The height of the destination image data. The stride of the destination image data. The destination memory block. The left coordinate of the destination image data. The top coordinate of the destination image data. Image width. Image height. Flags controlling function. These flags can be used: NI_DST_ALPHA_CHANNEL_FIRST, NI_DST_BOTTOM_TO_TOP, NI_DST_SWAP_CHANNELS.
8.1.5.1.2.3.2 copyFrom Method 8.1.5.1.2.3.2.1 NImage.copyFrom Method (NPixelFormat, int, int, int, ByteBuffer, int, int)
Copies pixels to from memory buffer. Java public final void copyFrom(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, int srcStride, ByteBuffer srcPixels, int left, int top); Parameters Parameters NPixelFormat srcPixelFormat int srcWidth int srcHeight int srcStride ByteBuffer srcPixels int left int top Description The source pixel format. The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the image data. The top coordinate of the image data.
8.1.5.1.2.3.2.2 NImage.copyFrom Method (NPixelFormat, int, int, int, ByteBuffer, int, int, int, int, int, int)
Copies part of pixels to from memory buffer. Java public final void copyFrom(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, int srcStride, ByteBuffer srcPixels, int srcLeft, int srcTop, int left, int top, int width, int height); Parameters Parameters NPixelFormat srcPixelFormat Description The source pixel format. 594
8.1 Java Reference int srcWidth int srcHeight int srcStride ByteBuffer srcPixels int srcLeft int srcTop int left int top int width int height
The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the source image data. The top coordinate of the source image data. The left coordinate of the image part. The top coordinate of the image part. Width of the image part. Height of the image part.
8.1.5.1.2.3.2.3 NImage.copyFrom Method (NPixelFormat, int, int, long, ByteBuffer, int, int, int)
Copies pixels to from memory buffer. Java public final void copyFrom(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, long srcStride, ByteBuffer srcPixels, int left, int top, int flags); Parameters Parameters NPixelFormat srcPixelFormat int srcWidth int srcHeight long srcStride ByteBuffer srcPixels int left int top int flags Description The source pixel format. The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the image data. The top coordinate of the image data. Flags controlling function. These flags can be used: NI_DST_ALPHA_CHANNEL_FIRST, NI_DST_BOTTOM_TO_TOP, NI_DST_SWAP_CHANNELS.
8.1.5.1.2.3.2.4 NImage.copyFrom Method (NPixelFormat, int, int, long, ByteBuffer, int, int, int, int, int, int, int)
Copies part of pixels to from memory buffer. Java public final void copyFrom(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, long srcStride, ByteBuffer srcPixels, int srcLeft, int srcTop, int left, int top, int width, int height, int flags); Parameters Parameters NPixelFormat srcPixelFormat int srcWidth int srcHeight long srcStride ByteBuffer srcPixels int srcLeft int srcTop int left int top int width Description The source pixel format. The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the source image data. The top coordinate of the source image data. The left coordinate of the image part. The top coordinate of the image part. Width of the image part.
595
8.1 Java Reference int height int flags
Height of the image part. Flags controlling function. These flags can be used: NI_DST_ALPHA_CHANNEL_FIRST, NI_DST_BOTTOM_TO_TOP, NI_DST_SWAP_CHANNELS.
8.1.5.1.2.3.2.5 NImage.copyFrom Method (NPixelFormat, int, int, long, ByteBuffer[], int, int, NPixelFormat, int, int, long, ByteBuffer[], int, int, int, int, int, int, int)
Java public final void copyFrom(NPixelFormat srcPixelFormat, int srcWidth, int srcHeight, long srcStride, ByteBuffer[] srcPlanes, int srcLeft, int srcTop, NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, long dstStride, ByteBuffer[] dstPlanes, int dstLeft, int dstTop, int left, int top, int width, int height, int flags); Parameters Parameters NPixelFormat srcPixelFormat int srcWidth int srcHeight long srcStride ByteBuffer[] srcPlanes int srcLeft int srcTop NPixelFormat dstPixelFormat int dstWidth int dstHeight long dstStride ByteBuffer[] dstPlanes int dstLeft int dstTop int left int top int width int height int flags Description The source pixel format. The width of the source image data. The height of the source image data. The stride of the source image data. The source memory block. The left coordinate of the source image data. The top coordinate of the source image data. The destination pixel format. The width of the destination image data. The height of the destination image data. The stride of the destination image data. The destination memory block. The left coordinate of the destination image data. The top coordinate of the destination image data. The left coordinate of the image part. The top coordinate of the image part. Width of the image part. Height of the image part. Flags controlling function. These flags can be used: NI_DST_ALPHA_CHANNEL_FIRST, NI_DST_BOTTOM_TO_TOP, NI_DST_SWAP_CHANNELS.
8.1.5.1.2.3.3 copyTo Method 8.1.5.1.2.3.3.1 NImage.copyTo Method (NImage, int, int)

Copies specified rectangular area of the NImage ( Java public final void copyTo(NImage dstImage, int dstLeft, int dstTop); Parameters Parameters NImage dstImage int dstLeft Description Destination NImage ( see page 589) object. Specified NImage ( see page 589) will be copied to this object. The x coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. see page 589) to other NImage ( see page 589) object.
596
8.1 Java Reference int dstTop
The y coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. Flags controlling this method. These flags can be used: FlagDstAlphaChannelFirst, FlagDstBottomToTop, FlagDstSwapChannels.
flags
8.1.5.1.2.3.3.2 NImage.copyTo Method (NPixelFormat, int, int, int, ByteBuffer, int, int)
Copies specified rectangular area of the NImage ( Java public final void copyTo(NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, int dstStride, ByteBuffer dstPixels, int dstLeft, int dstTop); Parameters Parameters NPixelFormat dstPixelFormat int dstWidth int dstHeight int dstStride int dstLeft Description Destination pixel format. The width of source image data. The height of source image data. The stride of source image data. The x coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. The y coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. Memory buffer where Nimage data is saved. see page 589) to other NImage ( see page 589) object.
int dstTop
dstPixel
8.1.5.1.2.3.3.3 NImage.copyTo Method (NPixelFormat, int, int, long, ByteBuffer, int, int, int)
Copies specified rectangular area of the NImage ( Java public final void copyTo(NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, long dstStride, ByteBuffer dstPixels, int dstLeft, int dstTop, int flags); Parameters Parameters NPixelFormat dstPixelFormat int dstWidth int dstHeight long dstStride int dstLeft Description Destination pixel format. The width of source image data. The height of source image data. The stride of source image data. The x coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. The y coordinate in the destination NImage ( see page 589) object. Copied NImage ( see page 589) will be placed starting by this coordinate. Flags controlling this method. These flags can be used: FlagDstAlphaChannelFirst, FlagDstBottomToTop, FlagDstSwapChannels. Memory buffer where Nimage data is saved. see page 589) to other NImage ( see page 589) object.
int dstTop
int flags
dstPixel
8.1.5.1.2.3.3.4 NImage.copyTo Method (int, int, NPixelFormat, int, int, int, ByteBuffer, int, int, int, int)
Copies part of NImage ( see page 589) pixels to memory buffer. paran left Left coordinate of the image part.
597
public final void copyTo(int left, int top, NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, int dstStride, ByteBuffer dstPixels, int dstLeft, int dstTop, int width, int height); Parameters Parameters int top NPixelFormat dstPixelFormat int dstWidth int dstHeight int dstStride ByteBuffer dstPixels int dstLeft Description Top coordinate of the image part. Destination pixel format. The width of source image data. The height of source image data. The stride of source image data. The memory block where Nimage data is saved. The x coordinate in the destination NImage ( see page 589) object. Copied data will be placed starting by this coordinate. The y coordinate in the destination NImage ( see page 589) object. Copied data will be placed starting by this coordinate. Width of the image part. Height of the image part.
int dstTop
int width int height
8.1.5.1.2.3.3.5 NImage.copyTo Method (int, int, NPixelFormat, int, int, long, ByteBuffer, int, int, int, int, int)
Copies part of NImage ( Java public final void copyTo(int left, int top, NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, long dstStride, ByteBuffer dstPixels, int dstLeft, int dstTop, int width, int height, int flags); Parameters Parameters int top NPixelFormat dstPixelFormat int dstWidth int dstHeight long dstStride ByteBuffer dstPixels int dstLeft Description Top coordinate of the image part. Destination pixel format. The width of source image data. The height of source image data. The stride of source image data. The memory block where Nimage data is saved. The x coordinate in the destination NImage ( see page 589) object. Copied data will be placed starting by this coordinate. The y coordinate in the destination NImage ( see page 589) object. Copied data will be placed starting by this coordinate. Width of the image part. Height of the image part. Flags controlling function. These flags can be used: NI_DST_ALPHA_CHANNEL_FIRST, NI_DST_BOTTOM_TO_TOP, NI_DST_SWAP_CHANNELS. see page 589) pixels to memory buffer. paran left Left coordinate of the image part.
int dstTop
int width int height int flags
8.1.5.1.2.3.3.6 NImage.copyTo Method (int, int, NPixelFormat, int, int, long, ByteBuffer[], int, int, int, int, int)
Copies part of NImage ( see page 589) planes to memory buffer. paran left Left coordinate of the image part.
598
public final void copyTo(int left, int top, NPixelFormat dstPixelFormat, int dstWidth, int dstHeight, long dstStride, ByteBuffer[] dstPlanes, int dstLeft, int dstTop, int width, int height, int flags); Parameters Parameters int top NPixelFormat dstPixelFormat int dstWidth int dstHeight long dstStride int dstLeft Description Top coordinate of the image part. Destination pixel format. The width of source image data. The height of source image data. The stride of source image data. The x coordinate in the destination NImage ( see page 589) object. Copied data will be placed starting by this coordinate. The y coordinate in the destination NImage ( see page 589) object. Copied data will be placed starting by this coordinate. Width of the image part. Height of the image part. Flags controlling function. These flags can be used: NI_DST_ALPHA_CHANNEL_FIRST, NI_DST_BOTTOM_TO_TOP, NI_DST_SWAP_CHANNELS. The memory block where Nimage data is saved.
int dstTop
int width int height int flags
dstPlaness
8.1.5.1.2.3.4 create Method 8.1.5.1.2.3.4.1 NImage.create Method (NPixelFormat, int, int, int)
Creates an image with specified pixel format, size and stride. Java public static NImage create(NPixelFormat pixelFormat, int width, int height, int stride); Parameters Parameters NPixelFormat pixelFormat int width int height int stride Returns NImage ( see page 589) object. Description Specifies pixel format of the image. Specifies width of the image. Specifies height of the image. Specifies stride of the image.
8.1.5.1.2.3.4.2 NImage.create Method (NPixelFormat, int, int, long, int)

Creates an image with specified pixel format, size and stride. Java public static NImage create(NPixelFormat pixelFormat, int width, int height, long stride, int flags); Parameters Parameters NPixelFormat pixelFormat int width Description Specifies pixel format of the image. Specifies width of the image. 599
8.1 Java Reference int height long stride int flags Returns NImage ( see page 589) object.
Specifies height of the image. Specifies stride of the image.
8.1.5.1.2.3.5 NImage.crop Method

Crops an image. Java public final NImage crop(int left, int top, int width, int height); Parameters Parameters int left int top int width int height Returns Cropped NImage ( see page 589) object. Description X-coordinate of the cropping rectangle. Y-coordinate of the cropping rectangle. Width of the cropping rectangle. Width of the cropping rectangle.
8.1.5.1.2.3.6 NImage.flipDiagonally Method

Flips image diagonally. Java public final void flipDiagonally();
8.1.5.1.2.3.7 NImage.flipHorizontally Method

Flips image horizontally. Java public final void flipHorizontally();
8.1.5.1.2.3.8 NImage.flipVertically Method

Flips image vertically. Java public final void flipVertically();
8.1.5.1.2.3.9 fromChannel Method 8.1.5.1.2.3.9.1 NImage.fromChannel Method (ReadableByteChannel)

Creates NImageWithInfo object from a byte channel. Java public static NImage fromChannel(ReadableByteChannel ch) throws IOException; Parameters Parameters ReadableByteChannel ch Description The source byte channel
600
8.1 Java Reference Returns A NImageWithInfo type object.
8.1.5.1.2.3.9.2 NImage.fromChannel Method (ReadableByteChannel, NImageFormat)

Creates NImageWithInfo object from a byte channel. Java public static NImage fromChannel(ReadableByteChannel ch, NImageFormat imageFormat) throws IOException; Parameters Parameters ReadableByteChannel ch NImageFormat imageFormat Returns A NImageWithInfo type object. Description The source byte channel Format of the image.
8.1.5.1.2.3.9.3 NImage.fromChannel Method (ReadableByteChannel, NImageFormat, boolean)

Creates NImageWithInfo object from a byte channel. Java public static NImageWithInfo fromChannel(ReadableByteChannel ch, NImageFormat imageFormat, boolean returnImageInfo) throws IOException; Parameters Parameters ReadableByteChannel ch NImageFormat imageFormat boolean returnImageInfo Returns A NImageWithInfo type object. Description The source byte channel Format of the image. True, if image info should be returned; else false.
8.1.5.1.2.3.9.4 NImage.fromChannel Method (ReadableByteChannel, NImageFormat, int)

Creates NImageWithInfo object from a byte channel. Java public static NImage fromChannel(ReadableByteChannel ch, NImageFormat imageFormat, int flags) throws IOException; Parameters Parameters ReadableByteChannel ch NImageFormat imageFormat int flags Returns A NImageWithInfo type object. Description The source byte channel Format of the image. Should be zero.
8.1.5.1.2.3.9.5 NImage.fromChannel Method (ReadableByteChannel, NImageFormat, int, boolean)

Creates NImageWithInfo object from a byte channel.
601
public static NImageWithInfo fromChannel(ReadableByteChannel ch, NImageFormat imageFormat, int flags, boolean returnImageInfo) throws IOException; Parameters Parameters ReadableByteChannel ch NImageFormat imageFormat int flags boolean returnImageInfo Returns A NImageWithInfo type object. Description The source byte channel Format of the image. Should be zero. True, if image info should be returned; else false.
8.1.5.1.2.3.9.6 NImage.fromChannel Method (ReadableByteChannel, boolean)

Creates NImageWithInfo object from a byte channel. Java public static NImageWithInfo fromChannel(ReadableByteChannel ch, boolean returnImageInfo) throws IOException; Parameters Parameters ReadableByteChannel ch boolean returnImageInfo Returns A NImageWithInfo type object. Description The source byte channel True, if image info should be returned; else false.
8.1.5.1.2.3.10 fromData Method 8.1.5.1.2.3.10.1 NImage.fromData Method (NPixelFormat, int, int, int, int, ByteBuffer)
Creates NImage ( Java public static NImage fromData(NPixelFormat pixelFormat, int width, int height, int stride, int srcStride, ByteBuffer srcPixels); Parameters Parameters NPixelFormat pixelFormat int width int height int stride int srcStride ByteBuffer srcPixels Returns A NImage ( see page 589) object. note If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Format of memory block srcPixels points to must be the same as described in Pixels property, only stride is equal to srcStride. horzResolution and vertResolution can be zero if resolution is not applicable for the image. Description A NPixelFormat ( A width of image. A height of image. A stride of image. A stride of source image. ByteBuffer of pixels. see page 636) of image. see page 589) object from data.
602
8.1 Java Reference
8.1.5.1.2.3.10.2 NImage.fromData Method (NPixelFormat, int, int, int, int, ByteBuffer, int, int, int, int)
Creates NImage ( Java public static NImage fromData(NPixelFormat pixelFormat, int stride, int srcWidth, int srcHeight, int srcStride, ByteBuffer srcPixels, int left, int top, int width, int height); Parameters Parameters NPixelFormat pixelFormat int stride int srcWidth int srcHeight int srcStride ByteBuffer srcPixels int left int top int width int height Returns A NImage ( see page 589) object. If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Format of memory block srcPixels points to must be the same as described in Pixels property, only stride is equal to srcStride. horzResolution and vertResolution can be zero if resolution is not applicable for the image. Description A NPixelFormat ( A stride of image. A width of source image. A height of source image. A stride of source image. ByteBuffer of pixels. X - coordinate of the image rectangle. Y - coordinate of the image rectangle. A width of image. A height of image. see page 636) of image. see page 589) object from data.
8.1.5.1.2.3.10.3 NImage.fromData Method (NPixelFormat, int, int, long, long, ByteBuffer, int)
Creates NImage ( Java public static NImage fromData(NPixelFormat pixelFormat, int width, int height, long stride, long srcStride, ByteBuffer srcPixels, int flags); Parameters Parameters NPixelFormat pixelFormat int width int height long stride long srcStride ByteBuffer srcPixels int flags Returns A NImage ( see page 589) object. If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Format of memory block srcPixels points to must be the same as described in Pixels property, only stride is equal to srcStride. horzResolution and vertResolution can be zero if resolution is not applicable for the image. Description A NPixelFormat ( A width of image. A height of image. A stride of image. A stride of source image. ByteBuffer of pixels. see page 636) of image. see page 589) object from data.
8.1.5.1.2.3.10.4 NImage.fromData Method (NPixelFormat, long, int, int, long, ByteBuffer, int, int, int, int, int)
Creates NImage ( see page 589) object from data.
603
public static NImage fromData(NPixelFormat pixelFormat, long stride, int srcWidth, int srcHeight, long srcStride, ByteBuffer srcPixels, int left, int top, int width, int height, int flags); Parameters Parameters long stride int srcWidth int srcHeight long srcStride ByteBuffer srcPixels int left int top int width int height int flags pixelForma Returns A NImage ( see page 589) object. If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Format of memory block srcPixels points to must be the same as described in Pixels property, only stride is equal to srcStride. horzResolution and vertResolution can be zero if resolution is not applicable for the image. A NPixelFormat ( see page 636) of image. Description A stride of image. A width of source image. A height of source image. A stride of source image. ByteBuffer of pixels. X - coordinate of the image rectangle. Y - coordinate of the image rectangle. A width of image. A height of image.
8.1.5.1.2.3.10.5 NImage.fromData Method (NPixelFormat, long, int, int, long, ByteBuffer[], int, int, int, int, int)
Creates NImage ( Java public static NImage fromData(NPixelFormat pixelFormat, long stride, int srcWidth, int srcHeight, long srcStride, ByteBuffer[] srcPlanes, int left, int top, int width, int height, int flags); Parameters Parameters long stride int srcWidth int srcHeight long srcStride ByteBuffer[] srcPlanes int left int top int width int height int flags pixelForma Returns A NImage ( see page 589) object. A NPixelFormat ( see page 636) of image. Description A stride of image. A width of source image. A height of source image. A stride of source image. ByteBuffer of planes. X - coordinate of the image rectangle. Y - coordinate of the image rectangle. A width of image. A height of image. see page 589) object from data.
8
8.1.5.1.2.3.11 fromFile Method
604
8.1 Java Reference
8.1.5.1.2.3.11.1 NImage.fromFile Method (String)

Creates NImage ( Java public static NImage fromFile(String fileName) throws IOException; Parameters Parameters String fileName Returns A NImage ( see page 589) object. Description A string that contains the name of the file. see page 589) object from file.
8.1.5.1.2.3.11.2 NImage.fromFile Method (String, NImageFormat)

Creates NImage ( Java public static NImage fromFile(String fileName, NImageFormat imageFormat) throws IOException; Parameters Parameters String fileName NImageFormat imageFormat Returns A NImage ( see page 589) object. Description A name of the file. An image NImageFormat ( see page 622) object. see page 589) object from file with specified NImageFormat ( see page 622).
8.1.5.1.2.3.11.3 NImage.fromFile Method (String, NImageFormat, boolean)

Creates NImageWithInfo object from file. Java public static NImageWithInfo fromFile(String fileName, NImageFormat imageFormat, boolean returnImageInfo) throws IOException; Parameters Parameters String fileName NImageFormat imageFormat boolean returnImageInfo Returns A NImageWithInfo type object. Description A name of the file. Format of the image. True, if image info should be returned; else false.
8.1.5.1.2.3.11.4 NImage.fromFile Method (String, NImageFormat, int)

Creates NImage ( Java public static NImage fromFile(String fileName, NImageFormat imageFormat, int flags) throws IOException; Parameters Parameters String fileName NImageFormat imageFormat Description A name of the file. An image NImageFormat ( see page 622) object. 605 see page 589) object from file with specified NImageFormat ( see page 622).
8.1 Java Reference int flags Returns A NImage ( see page 589) object.
8.1.5.1.2.3.11.5 NImage.fromFile Method (String, NImageFormat, int, boolean)

Creates NImageWithInfo object from file. Java public static NImageWithInfo fromFile(String fileName, NImageFormat imageFormat, int flags, boolean returnImageInfo) throws IOException; Parameters Parameters String fileName NImageFormat imageFormat int flags boolean returnImageInfo Returns A NImageWithInfo type object. Description A name of the file. Format of the image. Should be zero. True, if image info should be returned; else false.
8.1.5.1.2.3.11.6 NImage.fromFile Method (String, boolean)

Creates NImageWithInfo object from file. Java public static NImageWithInfo fromFile(String fileName, boolean returnImageInfo) throws IOException; Parameters Parameters String fileName Returns A NImageWithInfo type object. Description A name of the file.
8.1.5.1.2.3.12 fromImage Method 8.1.5.1.2.3.12.1 NImage.fromImage Method (NPixelFormat, int, NImage)

Creates NImage ( see page 589) object from another NImage ( see page 589) object. note If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Java public static NImage fromImage(NPixelFormat pixelFormat, int stride, NImage srcImage); Parameters Parameters NPixelFormat pixelFormat int stride NImage srcImage Returns A NImage ( see page 589) object. Description A NPixelFormat ( A stride of image. A NImage ( see page 589) source object. see page 636) of image.
606
8.1 Java Reference
8.1.5.1.2.3.12.2 NImage.fromImage Method (NPixelFormat, int, NImage, int, int, int, int)
Creates NImage ( Java public static NImage fromImage(NPixelFormat pixelFormat, int stride, NImage srcImage, int left, int top, int width, int height); Parameters Parameters NPixelFormat pixelFormat int stride NImage srcImage int left int top int width int height Returns A NImage ( Remarks If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Notes horzResolution and vertResolution can be zero if resolution is not applicable for the image. see page 589) object. Description A NPixelFormat ( A stride of image. A NImage ( see page 589) source object. X-coordinate of the image rectangle. Y-coordinate of the image rectangle. A width of image. A height of image. see page 636) of image. see page 589) object from another NImage ( see page 589) object.
8.1.5.1.2.3.12.3 NImage.fromImage Method (NPixelFormat, long, NImage, int)

Creates NImage ( see page 589) object from another NImage ( see page 589) object.
If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Java public static NImage fromImage(NPixelFormat pixelFormat, long stride, NImage srcImage, int flags); Parameters Parameters NPixelFormat pixelFormat long stride NImage srcImage int flags Returns A NImage ( see page 589) object. Description A NPixelFormat ( A stride of image. A NImage ( see page 589) source object. see page 636) of image.
8.1.5.1.2.3.12.4 NImage.fromImage Method (NPixelFormat, long, NImage, int, int, int, int, int)
Creates NImage ( Java public static NImage fromImage(NPixelFormat pixelFormat, long stride, NImage srcImage, int left, int top, int width, int height, int flags); see page 589) object from another NImage ( see page 589) object.
607
8.1 Java Reference Parameters Parameters NPixelFormat pixelFormat long stride NImage srcImage int left int top int width int height int flags Returns A NImage ( Remarks see page 589) object.
Description A NPixelFormat ( A stride of image. A NImage ( see page 589) source object. X-coordinate of the image rectangle. Y-coordinate of the image rectangle. A width of image. A height of image. see page 636) of image.
If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Notes horzResolution and vertResolution can be zero if resolution is not applicable for the image.
8.1.5.1.2.3.13 fromInputStream Method 8.1.5.1.2.3.13.1 NImage.fromInputStream Method (InputStream)

Creates NImageWithInfo object from an input stream. Java public static NImage fromInputStream(InputStream in) throws IOException; Parameters Parameters InputStream in Returns A NImageWithInfo type object. Description The input stream.
8.1.5.1.2.3.13.2 NImage.fromInputStream Method (InputStream, NImageFormat)

Creates NImageWithInfo object from an input stream. Java public static NImage fromInputStream(InputStream in, NImageFormat imageFormat) throws IOException; Parameters Parameters InputStream in NImageFormat imageFormat Returns A NImageWithInfo type object. Description The input stream. Format of the image.
8.1.5.1.2.3.13.3 NImage.fromInputStream Method (InputStream, NImageFormat, boolean)

Creates NImageWithInfo object from an input stream.
608
public static NImageWithInfo fromInputStream(InputStream in, NImageFormat imageFormat, boolean returnImageInfo) throws IOException; Parameters Parameters InputStream in NImageFormat imageFormat boolean returnImageInfo Returns A NImageWithInfo type object. Description The input stream. Format of the image. True, if image info should be returned; else false.
8.1.5.1.2.3.13.4 NImage.fromInputStream Method (InputStream, NImageFormat, int)

Creates NImageWithInfo object from an input stream. Java public static NImage fromInputStream(InputStream in, NImageFormat imageFormat, int flags) throws IOException; Parameters Parameters InputStream in NImageFormat imageFormat int flags Returns A NImageWithInfo type object. Description The input stream. Format of the image. Should be zero.
8.1.5.1.2.3.13.5 NImage.fromInputStream Method (InputStream, NImageFormat, int, boolean)

Creates NImageWithInfo object from an input stream. Java public static NImageWithInfo fromInputStream(InputStream in, NImageFormat imageFormat, int flags, boolean returnImageInfo) throws IOException; Parameters Parameters InputStream in NImageFormat imageFormat int flags boolean returnImageInfo Returns A NImageWithInfo type object. Description The input stream. Format of the image. Should be zero. True, if image info should be returned; else false.
8.1.5.1.2.3.13.6 NImage.fromInputStream Method (InputStream, boolean)

Creates NImageWithInfo object from an input stream. Java public static NImageWithInfo fromInputStream(InputStream in, boolean returnImageInfo) throws IOException;
609
8.1 Java Reference Parameters Parameters InputStream in boolean returnImageInfo Returns A NImageWithInfo type object.
Description The input stream. True, if image info should be returned; else false.
8.1.5.1.2.3.14 fromMemory Method 8.1.5.1.2.3.14.1 NImage.fromMemory Method (ByteBuffer)

Creates NImageWithInfo object from memory a memory buffer. Java public static NImage fromMemory(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns A NImageWithInfo type object. Description The source memory buffer.
8.1.5.1.2.3.14.2 NImage.fromMemory Method (ByteBuffer, NImageFormat)

Creates NImageWithInfo object from a memory buffer. Java public static NImage fromMemory(ByteBuffer buffer, NImageFormat imageFormat); Parameters Parameters ByteBuffer buffer NImageFormat imageFormat Returns A NImageWithInfo type object. Description The source memory buffer. Format of the image.
8.1.5.1.2.3.14.3 NImage.fromMemory Method (ByteBuffer, NImageFormat, boolean)

Creates NImageWithInfo object from a memory buffer. Java public static NImageWithInfo fromMemory(ByteBuffer buffer, NImageFormat imageFormat, boolean returnImageInfo) throws IOException; Parameters Parameters ByteBuffer buffer NImageFormat imageFormat boolean returnImageInfo Returns A NImageWithInfo type object. Description The source memory buffer. Format of the image. True, if image info should be returned; else false.
610
8.1 Java Reference
8.1.5.1.2.3.14.4 NImage.fromMemory Method (ByteBuffer, NImageFormat, int)

Creates NImageWithInfo object from a memory buffer. Java public static NImage fromMemory(ByteBuffer buffer, NImageFormat imageFormat, int flags); Parameters Parameters ByteBuffer buffer NImageFormat imageFormat int flags Returns A NImageWithInfo type object. Description The source memory buffer. Format of the image. Should be zero.
8.1.5.1.2.3.14.5 NImage.fromMemory Method (ByteBuffer, NImageFormat, int, boolean)

Creates NImageWithInfo object from a memory buffer. Java public static NImageWithInfo fromMemory(ByteBuffer buffer, NImageFormat imageFormat, int flags, boolean returnImageInfo) throws IOException; Parameters Parameters ByteBuffer buffer NImageFormat imageFormat int flags boolean returnImageInfo Returns A NImageWithInfo type object. Description The source memory buffer. Format of the image. Should be zero. True, if image info should be returned; else false.
8.1.5.1.2.3.14.6 NImage.fromMemory Method (ByteBuffer, boolean)

Creates NImageWithInfo object from a memory buffer. Java public static NImageWithInfo fromMemory(ByteBuffer buffer, boolean returnImageInfo) throws IOException; Parameters Parameters ByteBuffer buffer boolean returnImageInfo Returns A NImageWithInfo type object. Description The source memory buffer. True, if image info should be returned; else false.
8.1.5.1.2.3.15 NImage.getHeight Method

Gets height of image from NImage ( Java public final int getHeight(); see page 589) object.
611
8.1 Java Reference Returns A height of image.
8.1.5.1.2.3.16 NImage.getHorzResolution Method

Gets horizontal resolution in pixels per inch of image. Horizontal resolution equal to zero means that it is not applicable for the image. Java public final float getHorzResolution(); Returns A horizontal resolution in pixels per inch of image.
8.1.5.1.2.3.17 NImage.getImageSize Method

Gets size of NImage ( Java public final int getImageSize(); Returns A size of NImage ( Remarks Size of memory block containing image pixels is equal to image height multiplied by image stride. For more information see Height and Stride properties. see page 589) object. see page 589) object.
8.1.5.1.2.3.18 NImage.getLongImageSize Method

Gets size of NImage ( Java public final long getLongImageSize(); Returns A size of NImage ( Remarks Size of memory block containing image pixels is equal to image height multiplied by image stride. For more information see Height and Stride properties. see page 589) object. see page 589) object.
8.1.5.1.2.3.19 NImage.getLongPlaneSize Method

Gets the plane size. Java public final long getLongPlaneSize(); Returns The plane size.
8.1.5.1.2.3.20 NImage.getLongStride Method

Gets stride of image from NImage ( Java public final long getLongStride(); see page 589) object.
612
A stride of image. Stride (size of one row) of the image depends on image pixel format and width. It cannot be less than value obtained with GetRowLongSize or GetRowSize methods with arguments obtained with PixelFormat and Width properties.
8.1.5.1.2.3.21 NImage.getPixelFormat Method

Gets NPixelFormat ( Java public final NPixelFormat getPixelFormat(); Returns A NPixelFormat ( see page 636) structure. see page 636) of NImage ( see page 589) object.
8.1.5.1.2.3.22 NImage.getPixels Method

Gets pointer to array of pixels from NImage ( Java public final ByteBuffer getPixels(); Returns A pointer to pixel array. Notes Memory block containing image pixels is organized as image height rows following each other in top-to-bottom order. Each row occupies image stride bytes and is organized as image width pixels following each other in right-to-left order. Each pixel is described by image pixel format. For more information see PixelFormat, Width, Height, Stride, and Size properties. see page 589) object.
8.1.5.1.2.3.23 NImage.getPlanes Method

Gets the collection of planes. Java public final PlaneCollection getPlanes(); Returns PlaneCollection ( see page 591) object.
8.1.5.1.2.3.24 NImage.getPlaneSize Method

Gets the plane size. Java public final int getPlaneSize(); Returns The plane size.
8.1.5.1.2.3.25 NImage.getStride Method

Gets stride of image from NImage ( Java public final int getStride(); Returns A stride of image. Stride (size of one row) of the image depends on image pixel format and width. It cannot be less than 613 see page 589) object.
8.1 Java Reference
value obtained with GetRowLongSize or GetRowSize methods with arguments obtained with PixelFormat and Width properties.
8.1.5.1.2.3.26 NImage.getVertResolution Method

Gets vertical resolution in pixels per inch of image. Java public final float getVertResolution(); Returns A vertical resolution in pixels per inch of image. Remarks Vertical resolution equal to zero means that it is not applicable for the image.
8.1.5.1.2.3.27 NImage.getWidth Method

Gets width of image from NImage ( Java public final int getWidth(); Returns A width of image. see page 589) object.
8.1.5.1.2.3.28 getWrapper Method 8.1.5.1.2.3.28.1 NImage.getWrapper Method (NImage, int, int, int, int)
Creates NImage ( Java public static NImage getWrapper(NImage srcImage, int left, int top, int width, int height); Parameters Parameters NImage srcImage int left int top int width int height Returns A NImage ( see page 589) object. Description A NImage ( see page 589) source object. X - coordinate of the image rectangle. Y - coordinate of the image rectangle. A width of image. A height of image. see page 589) object wrapper.
8.1.5.1.2.3.28.2 NImage.getWrapper Method (NImage, int, int, int, int, int)

Creates NImage ( Java public static NImage getWrapper(NImage srcImage, int left, int top, int width, int height, int flags); Parameters Parameters NImage srcImage int left Description A NImage ( see page 589) source object. X - coordinate of the image rectangle. 614 see page 589) object wrapper.
8.1 Java Reference int top int width int height int flags Returns A NImage ( see page 589) object.
Y - coordinate of the image rectangle. A width of image. A height of image. Must be zero.
8.1.5.1.2.3.28.3 NImage.getWrapper Method (NPixelFormat, int, int, int, ByteBuffer)

Creates NImage ( Java public static NImage getWrapper(NPixelFormat pixelFormat, int width, int height, int stride, ByteBuffer pixels); Parameters Parameters NPixelFormat pixelFormat int width int height int stride ByteBuffer pixels Returns A NImage ( see page 589) object. Description A NPixelFormat ( A width of image. A height of image. A stride of image. ByteBuffer containing pixels. see page 636) of image. see page 589) object wrapper.
8.1.5.1.2.3.28.4 NImage.getWrapper Method (NPixelFormat, int, int, int, ByteBuffer, int, int, int, int)
Creates NImage ( Java public static NImage getWrapper(NPixelFormat pixelFormat, int srcWidth, int srcHeight, int stride, ByteBuffer pixels, int left, int top, int width, int height); Parameters Parameters NPixelFormat pixelFormat int srcWidth int srcHeight int stride ByteBuffer pixels int left int top int width int height Returns A NImage ( see page 589) object. Description A NPixelFormat ( A width of image. A height of image. A stride of image. A source Bytebuffer. Left X-coordinate of the image. Top Y-coordinate of the image. Image width. Image height. see page 636) of image. see page 589) object wrapper.
8.1.5.1.2.3.28.5 NImage.getWrapper Method (NPixelFormat, int, int, long, ByteBuffer, int)

Creates NImage ( Java public static NImage getWrapper(NPixelFormat pixelFormat, int width, int height, long 615 see page 589) object wrapper.
8.1 Java Reference
stride, ByteBuffer pixels, int flags); Parameters Parameters NPixelFormat pixelFormat int width int height long stride ByteBuffer pixels int flags Returns A NImage ( see page 589) object. Description A NPixelFormat ( A width of image. A height of image. A stride of image. ByteBuffer containing pixels. Must be zero. see page 636) of image.
8.1.5.1.2.3.28.6 NImage.getWrapper Method (NPixelFormat, int, int, long, ByteBuffer, int, int, int, int, int)
Creates NImage ( Java public static NImage getWrapper(NPixelFormat pixelFormat, int srcWidth, int srcHeight, long stride, ByteBuffer pixels, int left, int top, int width, int height, int flags); Parameters Parameters NPixelFormat pixelFormat int srcWidth int srcHeight long stride ByteBuffer pixels int left int top int width int height int flags Returns A NImage ( see page 589) object. Description A NPixelFormat ( A width of image. A height of image. A stride of image. A source Bytebuffer. Left X-coordinate of the image. Top Y-coordinate of the image. NImage ( NImage ( see page 589) width. see page 589) height. see page 636) of image. see page 589) object wrapper.
Must be zero.
8.1.5.1.2.3.28.7 NImage.getWrapper Method (NPixelFormat, int, int, long, ByteBuffer[], int, int, int, int, int)
Creates NImage ( Java public static NImage getWrapper(NPixelFormat pixelFormat, int srcWidth, int srcHeight, long stride, ByteBuffer[] planes, int left, int top, int width, int height, int flags); Parameters Parameters NPixelFormat pixelFormat int srcWidth int srcHeight long stride ByteBuffer[] planes int left int top Description A NPixelFormat ( A width of image. A height of image. A stride of image. A source Bytebuffer. Left X-coordinate of the image. Top Y-coordinate of the image. 616 see page 636) of image. see page 589) object wrapper.
8.1 Java Reference int width int height int flags Returns A NImage ( see page 589) object.
NImage ( NImage (
see page 589) width. see page 589) height.
Must be zero.
8.1.5.1.2.3.29 NImage.isResolutionIsAspectRatio Method

Gets NImage ( Java public final boolean isResolutionIsAspectRatio(); Returns NImage ( Remarks NImage ( see page 589) resolution can have 2 modes: physical height and width in pixels or aspect ratio. Picture aspect ratio defines the shape of displayed image. Picture aspect ratio is notated X:Y, where X:Y is the ratio of picture width to height. If true value is returned it means that NImage ( see page 589) shape is defined using width and height ratio (aspect ratio). see page 589) resolution aspect ratio. see page 589) resolution aspect ratio.
8.1.5.1.2.3.30 NImage.nativeTypeOf Method

8.1.5.1.2.3.31 rotateFlip Method 8.1.5.1.2.3.31.1 NImage.rotateFlip Method (NImageRotateFlipType)

Rotates image using rotation type. Java public final NImage rotateFlip(NImageRotateFlipType rotateFlipType); Parameters Parameters NImageRotateFlipType rotateFlipType Returns Rotated NImage ( see page 589) object. Description One of the rotation type value.
8.1.5.1.2.3.31.2 NImage.rotateFlip Method (NImageRotateType, EnumSet<NImageFlipType>)

Rotates image using rotation type. Java public final NImage rotateFlip(NImageRotateType rotateType, EnumSet<NImageFlipType> flipType);
617
8.1 Java Reference Parameters Parameters NImageRotateType rotateType EnumSet<NImageFlipType> flipType Returns NImage ( see page 589) object
Description One of the NImageRotateType value. One of the NImageFlipType value.
8.1.5.1.2.3.32 save Method 8.1.5.1.2.3.32.1 NImage.save Method (NImageFormat)

Saves image to memory buffer using specified format. Java public ByteBuffer save(NImageFormat imageFormat); Parameters Parameters NImageFormat imageFormat Returns NBuffer type memory buffer which contains saved image data. Description The image format.
8.1.5.1.2.3.32.2 NImage.save Method (NImageFormat, NImageInfo, int)

Saves image to memory buffer with specified image info and format. Java public ByteBuffer save(NImageFormat imageFormat, NImageInfo info, int flags); Parameters Parameters NImageFormat imageFormat NImageInfo info int flags Returns NBuffer type memory buffer which contains saved image data. Description The image format. The image info. Must be zero.
8.1.5.1.2.3.32.3 NImage.save Method (NImageInfo)

Saves image to memory buffer with specified image info. Java public ByteBuffer save(NImageInfo info); Parameters Parameters NImageInfo info Returns NBuffer type memory buffer which contains saved image data. Description The image info.
8
8.1.5.1.2.3.32.4 NImage.save Method (OutputStream, NImageFormat)
Saves image to stream using specified format. 618
public final void save(OutputStream out, NImageFormat imageFormat) throws IOException; Parameters Parameters OutputStream out NImageFormat imageFormat Description Data stream used to save the image. The image format.
8.1.5.1.2.3.32.5 NImage.save Method (OutputStream, NImageFormat, NImageInfo, int)

Saves image to stream using specified image info and format. Java public final void save(OutputStream out, NImageFormat imageFormat, NImageInfo info, int flags) throws IOException; Parameters Parameters OutputStream out NImageFormat imageFormat NImageInfo info int flags Description Data stream used to save the image. The image format. The image info. Must be zero.
8.1.5.1.2.3.32.6 NImage.save Method (OutputStream, NImageInfo)

Saves image to stream using specified image info. Java public final void save(OutputStream out, NImageInfo info) throws IOException; Parameters Parameters OutputStream out NImageInfo info Description Data stream used to save the image. The image info.
8.1.5.1.2.3.32.7 NImage.save Method (String)

Saves NImage ( Java public final void save(String fileName) throws IOException; Parameters Parameters String fileName Description A string that contains the name of the file. see page 589) object to file.
8.1.5.1.2.3.32.8 NImage.save Method (String, NImageFormat)

Saves NImage ( Java public final void save(String fileName, NImageFormat imageFormat) throws IOException; Parameters Parameters String fileName NImageFormat imageFormat Description A string that contains the name of the file. An image NImageFormat ( see page 622) object. see page 589) object to file with specified NImageFormat ( see page 622).
619
8.1 Java Reference
8.1.5.1.2.3.32.9 NImage.save Method (String, NImageFormat, NImageInfo, int)

Saves image to file using specified format and image info. Java public final void save(String fileName, NImageFormat imageFormat, NImageInfo info, int flags) throws IOException; Parameters Parameters String fileName NImageFormat imageFormat NImageInfo info int flags Description A string that contains the name of the file. An image NImageFormat ( Image info. Must be zero. see page 622) object.
8.1.5.1.2.3.32.10 NImage.save Method (String, NImageInfo)

Saves NImage ( Java public final void save(String fileName, NImageInfo info) throws IOException; Parameters Parameters String fileName NImageInfo info Description A string that contains the name of the file. Image info. see page 589) object to file using specified image info.
8.1.5.1.2.3.32.11 NImage.save Method (WritableByteChannel, NImageFormat)

Saves image to byte channel using specified format. Java public final void save(WritableByteChannel ch, NImageFormat imageFormat) throws IOException; Parameters Parameters WritableByteChannel ch NImageFormat imageFormat Description Byte channel used to save the image. The image format.
8.1.5.1.2.3.32.12 NImage.save Method (WritableByteChannel, NImageFormat, NImageInfo, int)

Saves image to byte channel using specified format and image info. Java public final void save(WritableByteChannel ch, NImageFormat imageFormat, NImageInfo info, int flags) throws IOException; Parameters Parameters WritableByteChannel ch NImageFormat imageFormat NImageInfo info int flags Description Byte channel used to save the image. The image format. The image info. Must be zero.
8.1.5.1.2.3.32.13 NImage.save Method (WritableByteChannel, NImageInfo)

Saves image to byte channel using specified image info.
620
public final void save(WritableByteChannel ch, NImageInfo info) throws IOException; Parameters Parameters WritableByteChannel ch NImageInfo info Description Byte channel used to save the image. The image info.
8.1.5.1.2.3.33 NImage.setHorzResolution Method

Sets horizontal resolution in pixels per inch of image. Java public final void setHorzResolution(float value); Parameters Parameters float value Remarks Horizontal resolution equal to zero means that it is not applicable for the image. Description A horizontal resolution in pixels per inch of image.
8.1.5.1.2.3.34 NImage.setResolutionIsAspectRatio Method

Sets NImage ( Java public final void setResolutionIsAspectRatio(boolean value); Parameters Parameters boolean value Description [in] Defines NImage ( see page 589) resolution mode. If set to true, it means that NImage ( see page 589) shape will be defined using width and height ratio (aspect ratio). see page 589) resolution aspect ratio.
Remarks NImage ( see page 589) resolution can have 2 modes: physical height and width in pixels or aspect ratio. Picture aspect ratio defines the shape of displayed image. Picture aspect ratio is notated X:Y, where X:Y is the ration of picture width to height. If true value is used it means that NImage ( see page 589) shape will be defined using width and height ratio (aspect ratio).
8.1.5.1.2.3.35 NImage.setVertResolution Method

Sets vertical resolution in pixels per inch of image. Java public final void setVertResolution(float value); Parameters Parameters float value Remarks Horizontal vertical equal to zero means that it is not applicable for the image. Description A vertical resolution in pixels per inch of image.
8.1.5.1.2.3.36 NImage.toGrayscale Method

Converts NImage ( see page 589) to NGrayscaleImage ( see page 587). 621
public final NGrayscaleImage toGrayscale(); Returns NGrayscaleImage ( see page 587) object.
8.1.5.1.2.3.37 NImage.toImage Method

Creates an Image object. Java public final Image toImage(); Returns An Image object.
8.1.5.1.2.3.38 NImage.toMonochrome Method

Converts NImage ( Java public final NMonochromeImage toMonochrome(); Returns NMonochromeImage object. see page 589) to monochrome image.
8.1.5.1.2.3.39 NImage.toRgb Method

Converts NImage ( Java public final NRGBImage toRgb(); Returns NRgbImage object. see page 589) to Rgb image.
8.1.5.1.3 NImageFormat Class

Provides functionality for loading and saving images in format-neutral style. Java public final class NImageFormat extends NObject; File NImageFormat.java NImageFormat Classes Name ImageFormatCollection ( page 623) NImageFormat Methods Name createInfo ( getBMP ( see page 623) see page 624) see Description Creates NImageInfo ( see page 634) for the specified image. Specifies the BMP image format. Gets default file extension of the current image format. see Description Represents the collection of formats in a NImageFormat.
getDefaultFileExtension ( page 624)
622
8.1 Java Reference
getDefaultInternetMediaType ( see page 624) getFileFilter ( getFormats ( getIHead ( see page 624) see page 625) see page 625) see page
Gets default Internet media type of the current image format. Gets file filter of the current image format. Specifies collection of supported image formats. Specifies the NIST IHead image format. Gets Internet media type of the current image format. Specifies the JPEG image format. Specifies the JPEG2000 image format. Gets name of the current image format. Specifies the PNG image format. Specifies the TIFF image format. Specifies the WSQ image format. Gets a value indicating whether the current image format supports reading. Gets a value indicating whether the current image format supports writing. Retrieves a value indicating whether the image format supports writing of multiple images. Retrieves a function that retrieves NType object for the enclosing type. Opens NImageReader from a memory buffer. Opens NImageWriter. Retrieves supported image format registered with file extension of specified file name and supporting reading/writing as specified. see Retrieves supported image format registered with Internet media type of specified file name and supporting reading/writing as specified. Selects a NImageReader from a memory buffer.
getInternetMediaType ( 625) getJPEG ( getName ( getPNG ( getTIFF ( getWSQ ( getJPEG2K (
see page 625) see page 625) see page 625) see page 626) see page 626) see page 626) see page 626) see page 626) see page
isCanRead ( isCanWrite (
isCanWriteMultiple ( 627) nativeTypeOf ( openReader ( openWriter ( select (
see page 629)
see page 631)
selectByInternetMediaType ( page 631) selectReader (
see page 632)
8.1.5.1.3.1 NImageFormat Classes

8.1.5.1.3.1.1 NImageFormat.ImageFormatCollection Class
Represents the collection of formats in a NImageFormat ( Java public static final class ImageFormatCollection extends NObjectReadOnlyCollection<NImageFormat>; File NImageFormat.java see page 622).
8.1.5.1.3.2 NImageFormat Methods

8.1.5.1.3.2.1 createInfo Method 8.1.5.1.3.2.1.1 NImageFormat.createInfo Method (NImage)
Creates NImageInfo ( Java public NImageInfo createInfo(NImage image); see page 634) for the specified image.
623
8.1 Java Reference Parameters Parameters NImage image Returns NImageInfo ( see page 634) object.
Description The specified image.
8.1.5.1.3.2.1.2 NImageFormat.createInfo Method (NImage, int)

Creates NImageInfo ( Java public NImageInfo createInfo(NImage image, int flags); Parameters Parameters NImage image int flags Returns NImageInfo ( see page 634) object. Description The specified image. Must be zero. see page 634) for the specified image.
8.1.5.1.3.2.2 NImageFormat.getBMP Method

Specifies the BMP image format. Java public static NImageFormat getBMP(); Returns Type NImageFormat ( see page 622) object.
8.1.5.1.3.2.3 NImageFormat.getDefaultFileExtension Method

Gets default file extension of the current image format. Java public String getDefaultFileExtension(); Returns Default file extension.
8.1.5.1.3.2.4 NImageFormat.getDefaultInternetMediaType Method

Gets default Internet media type of the current image format. Java public String getDefaultInternetMediaType(); Returns An image format default Internet media type.
8.1.5.1.3.2.5 NImageFormat.getFileFilter Method

Gets file filter of the current image format. Java public String getFileFilter();
624
8.1 Java Reference Returns An image format file filter.
8.1.5.1.3.2.6 NImageFormat.getFormats Method

Specifies collection of supported image formats. Java public static ImageFormatCollection getFormats(); Returns ImageFormatCollection ( see page 623) object which contains supported image formats.
8.1.5.1.3.2.7 NImageFormat.getIHead Method

Specifies the NIST IHead image format. Java public static NImageFormat getIHead(); Returns NIST type image.
8.1.5.1.3.2.8 NImageFormat.getInternetMediaType Method

Gets Internet media type of the current image format. Java public String getInternetMediaType(); Returns An image format Internet media type.
8.1.5.1.3.2.9 NImageFormat.getJPEG Method

Specifies the JPEG image format. Java public static NImageFormat getJPEG(); Returns JPEG type image.
8.1.5.1.3.2.10 NImageFormat.getJPEG2K Method

Specifies the JPEG2000 image format. Java public static NImageFormat getJPEG2K(); Returns JPEG2000 type image.
8.1.5.1.3.2.11 NImageFormat.getName Method

Gets name of the current image format. Java public String getName();
625
8.1 Java Reference Returns An image format name.
8.1.5.1.3.2.12 NImageFormat.getPNG Method

Specifies the PNG image format. Java public static NImageFormat getPNG(); Returns PNG type image.
8.1.5.1.3.2.13 NImageFormat.getTIFF Method

Specifies the TIFF image format. Java public static NImageFormat getTIFF(); Returns TIFF type image.
8.1.5.1.3.2.14 NImageFormat.getWSQ Method

Specifies the WSQ image format. Java public static NImageFormat getWSQ(); Returns WSQ type image.
8.1.5.1.3.2.15 NImageFormat.isCanRead Method

Gets a value indicating whether the current image format supports reading. Java public boolean isCanRead(); Returns true if image format can read, false if image format cannot read.
8.1.5.1.3.2.16 NImageFormat.isCanWrite Method

Gets a value indicating whether the current image format supports writing. Java public boolean isCanWrite(); Returns true if image format can write, false
626
8.1 Java Reference if image format cannot write.
8.1.5.1.3.2.17 NImageFormat.isCanWriteMultiple Method

Retrieves a value indicating whether the image format supports writing of multiple images. Java public boolean isCanWriteMultiple(); Returns true if image format can write, false if image format cannot write.
8.1.5.1.3.2.18 NImageFormat.nativeTypeOf Method

8.1.5.1.3.2.19 openReader Method 8.1.5.1.3.2.19.1 NImageFormat.openReader Method (ByteBuffer)

Opens NImageReader from a memory buffer. Java public NImageReader openReader(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns HNImageReader object. throw IOException Description The memory buffer.
8.1.5.1.3.2.19.2 NImageFormat.openReader Method (ByteBuffer, int)

Opens NImageReader from a memory buffer. Java public NImageReader openReader(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Returns HNImageReader object. throw IOException Description The memory buffer. Must be zero.
627
8.1 Java Reference
8.1.5.1.3.2.19.3 NImageFormat.openReader Method (InputStream)

Opens NImageReader from a specified stream. Java public NImageReader openReader(InputStream in) throws IOException; Parameters Parameters InputStream in Returns HNImageReader object. throw IOException Description The specified stream.
8.1.5.1.3.2.19.4 NImageFormat.openReader Method (InputStream, int)

Opens NImageReader from a specified stream. Java public NImageReader openReader(InputStream in, int flags) throws IOException; Parameters Parameters InputStream in int flags Returns HNImageReader object. throw IOException Description The specified stream. Must be zero.
8.1.5.1.3.2.19.5 NImageFormat.openReader Method (ReadableByteChannel)

Opens NImageReader from a specified channel. Java public NImageReader openReader(ReadableByteChannel ch) throws IOException; Parameters Parameters in Returns HNImageReader object. throw IOException Description The specified channel.
8.1.5.1.3.2.19.6 NImageFormat.openReader Method (ReadableByteChannel, int)

Opens NImageReader from a specified channel. Java public NImageReader openReader(ReadableByteChannel ch, int flags) throws IOException; Parameters Parameters int flags in Returns HNImageReader object. throw IOException Description Must be zero. The specified channel.
628
8.1 Java Reference
8.1.5.1.3.2.19.7 NImageFormat.openReader Method (String)

Opens NImageReader from a specified file. Java public NImageReader openReader(String fileName) throws IOException; Parameters Parameters String fileName Returns HNImageReader object. throw IOException Description The file name.
8.1.5.1.3.2.19.8 NImageFormat.openReader Method (String, int)

Opens NImageReader from a specified file. Java public NImageReader openReader(String fileName, int flags) throws IOException; Parameters Parameters String fileName int flags Returns HNImageReader object. throw IOException Description The file name. Must be zero.
8.1.5.1.3.2.20 openWriter Method 8.1.5.1.3.2.20.1 NImageFormat.openWriter Method ()

Opens NImageWriter. Java public NImageWriter openWriter(); Returns NImageWriter object.
8.1.5.1.3.2.20.2 NImageFormat.openWriter Method (OutputStream)

Opens NImageWriter to a specified stream. Java public NImageWriter openWriter(OutputStream out) throws IOException; Parameters Parameters OutputStream out Returns NImageWriter object. Description The specified stream.
8.1.5.1.3.2.20.3 NImageFormat.openWriter Method (OutputStream, int)

Opens NImageWriter to a specified stream. 629
public NImageWriter openWriter(OutputStream out, int flags) throws IOException; Parameters Parameters OutputStream out int flags Returns NImageWriter object. Description The specified stream. Must be zero.
8.1.5.1.3.2.20.4 NImageFormat.openWriter Method (String)

Opens NImageWriter to a specified file. Java public NImageWriter openWriter(String fileName) throws IOException; Parameters Parameters String fileName Returns NImageWriter object. Description The file name.
8.1.5.1.3.2.20.5 NImageFormat.openWriter Method (String, int)

Opens NImageWriter to a specified file. Java public NImageWriter openWriter(String fileName, int flags) throws IOException; Parameters Parameters String fileName int flags Returns NImageWriter object. Description The file name. Must be zero.
8.1.5.1.3.2.20.6 NImageFormat.openWriter Method (WritableByteChannel)

Opens NImageWriter to a specified channel. Java public NImageWriter openWriter(WritableByteChannel ch) throws IOException; Parameters Parameters WritableByteChannel ch Returns NImageWriter object. Description The specified channel.
8.1.5.1.3.2.20.7 NImageFormat.openWriter Method (WritableByteChannel, int)

Opens NImageWriter to a specified channel. 630
public NImageWriter openWriter(WritableByteChannel ch, int flags) throws IOException; Parameters Parameters WritableByteChannel ch int flags Returns NImageWriter object. Description The specified channel. Must be zero.
8.1.5.1.3.2.20.8 NImageFormat.openWriter Method (int)

Opens NImageWriter. Java public NImageWriter openWriter(int flags); Parameters Parameters int flags Returns NImageWriter object. Description Must be zero.
8.1.5.1.3.2.21 NImageFormat.select Method

Retrieves supported image format registered with file extension of specified file name and supporting reading/writing as specified. Java public static NImageFormat select(String fileName, NFileAccess fileAccess); Parameters Parameters String fileName NFileAccess fileAccess Returns A NImageFormat ( see page 622) object. Description A string that contains the name of the file. A file access.
8.1.5.1.3.2.22 NImageFormat.selectByInternetMediaType Method

Retrieves supported image format registered with Internet media type of specified file name and supporting reading/writing as specified. Java public static NImageFormat selectByInternetMediaType(String internetMediaType, NFileAccess fileAccess); Parameters Parameters String internetMediaType NFileAccess fileAccess Description String containing Internet media type. Specifies that image format should support reading, writing or both.
631
8.1 Java Reference Returns A NImageFormat (
8.1.5.1.3.2.23 selectReader Method 8.1.5.1.3.2.23.1 NImageFormat.selectReader Method (ByteBuffer)

Selects a NImageReader from a memory buffer. Java public static NImageReader selectReader(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns NImageReader object. Description The source memory buffer.
8.1.5.1.3.2.23.2 NImageFormat.selectReader Method (ByteBuffer, int)

Selects a NImageReader from a memory buffer. Java public static NImageReader selectReader(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Returns NImageReader object. Description The source memory buffer. Must be zero.
8.1.5.1.3.2.23.3 NImageFormat.selectReader Method (InputStream)

Selects a NImageReader from a specified stream. Java public static NImageReader selectReader(InputStream in) throws IOException; Parameters Parameters buffer Returns NImageReader object. Description The source stream.
8.1.5.1.3.2.23.4 NImageFormat.selectReader Method (InputStream, int)

Selects a NImageReader from a specified stream. Java public static NImageReader selectReader(InputStream in, int flags) throws IOException;
632
8.1 Java Reference Parameters Parameters int flags buffer Returns NImageReader object.
Description Must be zero. The source stream.
8.1.5.1.3.2.23.5 NImageFormat.selectReader Method (ReadableByteChannel)

Selects a NImageReader from a specified channel. Java public static NImageReader selectReader(ReadableByteChannel ch) throws IOException; Parameters Parameters buffer Returns NImageReader object. Description The byte channel.
8.1.5.1.3.2.23.6 NImageFormat.selectReader Method (ReadableByteChannel, int)

Selects a NImageReader from a specified channel. Java public static NImageReader selectReader(ReadableByteChannel ch, int flags) throws IOException; Parameters Parameters int flags buffer Returns NImageReader object. Description Must be zero. The byte channel.
8.1.5.1.3.2.23.7 NImageFormat.selectReader Method (String)

Selects a NImageReader from a specified file. Java public static NImageReader selectReader(String fileName) throws IOException; Parameters Parameters String fileName Returns NImageReader object. Description Name of the file.
8.1.5.1.3.2.23.8 NImageFormat.selectReader Method (String, int)

Selects a NImageReader from a specified file.
633
public static NImageReader selectReader(String fileName, int flags) throws IOException; Parameters Parameters String fileName int flags Returns NImageReader object. Description Name of the file. Must be zero.
8.1.5.1.4 NImageInfo Class

Retrieves the object information. Java public class NImageInfo extends NObject; File NImageInfo.java NImageInfo Methods Name getFormat ( see page 634) see page 634) nativeTypeOf ( Description Gets the image format. Retrieves a function that retrieves NType object for the enclosing type.
8.1.5.1.4.1 NImageInfo Methods

8.1.5.1.4.1.1 NImageInfo.getFormat Method
Gets the image format. Java public NImageFormat getFormat(); Returns NImageFormat ( see page 622) object.
8.1.5.1.4.1.2 NImageInfo.nativeTypeOf Method

8.1.5.1.5 NImages Class

Provides library registration and other additional functionality. Java public final class NImages; File NImages.java 634
8.1 Java Reference NImages Methods Name getGrayscaleColorWrapper ( page 635) getOpenFileFilter (
Description see Creates NImage ( see page 589) object wrapper. note Gray values in source image are replaced with according RGB values from range [minColor, maxColor] in created image.
see page 635) Gets a list with names of all NImageFormats, which support reading. Names in the list are separated by semicolon. see Gets a list with names of all NImageFormats, which support reading. Names in the list are separated by semicolon. Gets a list with names of all NImageFormats, which support. Names in the list are separated by semicolon.
getOpenFileFilterString ( page 635) getSaveFileFilter (
see page 636)
getSaveFileFilterString ( 636) nativeTypeOf (
see page Gets a list with names of all NImageFormats, which support writing. Names in the list are separated by semicolon. Retrieves a function that retrieves NType object for the enclosing type.
see page 636)
8.1.5.1.5.1 NImages Methods

8.1.5.1.5.1.1 NImages.getGrayscaleColorWrapper Method
Creates NImage ( see page 589) object wrapper. note Gray values in source image are replaced with according RGB values from range [minColor, maxColor] in created image. Java public static NImage getGrayscaleColorWrapper(NImage image, NRGB minColor, NRGB maxColor); Parameters Parameters NImage image NRGB minColor NRGB maxColor Returns A NImage ( see page 589) object. Description A NImage ( see page 589) object. Specifies color to be used for black color. Specifies color to be used for white color.
8.1.5.1.5.1.2 NImages.getOpenFileFilter Method

Gets a list with names of all NImageFormats, which support reading. Names in the list are separated by semicolon. Java public static String getOpenFileFilter(); Returns String with NImageFormat ( see page 622) names separated by semicolon.
8.1.5.1.5.1.3 NImages.getOpenFileFilterString Method

Gets a list with names of all NImageFormats, which support reading. Names in the list are separated by semicolon. Java public static String getOpenFileFilterString(boolean addAllImage, boolean addAllFiles); Parameters Parameters boolean addAllImage boolean addAllFiles Description Boolean indicating whether to add "All image files" to the list. Boolean indicating whether to add "All files" to the list
635
8.1 Java Reference Returns String with NImageFormat (
see page 622) names separated by semicolon.
8.1.5.1.5.1.4 NImages.getSaveFileFilter Method

Gets a list with names of all NImageFormats, which support. Names in the list are separated by semicolon. Java public static String getSaveFileFilter(); Returns String with NImageFormat ( see page 622) names separated by semicolon.
8.1.5.1.5.1.5 NImages.getSaveFileFilterString Method

Gets a list with names of all NImageFormats, which support writing. Names in the list are separated by semicolon. Java public static String getSaveFileFilterString(); Returns String with NImageFormat ( see page 622) names separated by semicolon.
8.1.5.1.5.1.6 NImages.nativeTypeOf Method

8.1.5.1.6 NPixelFormat Class

Provides functionality for working with pixel format. Java public final class NPixelFormat extends NSampleFormat; File NPixelFormat.java Remarks Image pixel format is not limited to these fields. However only these fields are provided for usage with this SDK. Methods Name NPixelFormat ( NPixelFormat Fields Name GRAYSCALE_16S ( 641) GRAYSCALE_16U ( 641) see page see page Description Specifies grayscale image pixel format where each pixel is represented by 16 bits per channel (channel format - signed integer). Specifies grayscale image pixel format where each pixel is represented by 16 bits per channel (channel format - unsigned integer). see page 640) Description Initiazlizes a new instance of NPixelFormat class.
636
8.1 Java Reference GRAYSCALE_1U ( GRAYSCALE_2U ( GRAYSCALE_32F ( 642) GRAYSCALE_32S ( 642) GRAYSCALE_32U ( 642) GRAYSCALE_4U ( GRAYSCALE_64F ( 642) GRAYSCALE_64S ( 642) GRAYSCALE_64U ( 642) GRAYSCALE_8S ( GRAYSCALE_8U (
see page 641) Specifies grayscale image pixel format where each pixel is represented by 1 bit per channel (channel format - unsigned integer). see page 641) Specifies grayscale image pixel format where each pixel is represented by 2 bits per channel (channel format - unsigned integer). see page see page see page Specifies grayscale image pixel format where each pixel is represented by 32 bits per channel (channel format - floating point). Specifies grayscale image pixel format where each pixel is represented by 32 bits per channel (channel format - signed integer). Specifies grayscale image pixel format where each pixel is represented by 32 bits per channel (channel format - unsigned integer).
see page 642) Specifies grayscale image pixel format where each pixel is represented by 4 bits per channel (channel format - unsigned integer). see page see page see page Specifies grayscale image pixel format where each pixel is represented by 64 bits per channel (channel format - floating point). Specifies grayscale image pixel format where each pixel is represented by 64 bits per channel (channel format - signed integer). Specifies grayscale image pixel format where each pixel is represented by 64 bits per channel (channel format - unsigned integer).
see page 642) Specifies grayscale image pixel format where each pixel is represented by 8 bits per channel (channel format - signed integer). see page 643) Specifies grayscale image pixel format where each pixel is represented by 8 bits per channel (channel format - unsigned integer). see page Specifies grayscale image pixel format where each pixel is represented by 16 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 16 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 32 bits per alpha channel (channel format - floating point). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 32 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 32 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 64 bits per alpha channel (channel format - floating point). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 64 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 64 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 8 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 8 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies grayscale image pixel format where each pixel is represented by 16 bits per pre-multiplied alpha channel (channel format - signed integer).
GRAYSCALE_A_16S ( 643) GRAYSCALE_A_16U ( 643) GRAYSCALE_A_32F ( 643) GRAYSCALE_A_32S ( 643) GRAYSCALE_A_32U ( 643) GRAYSCALE_A_64F ( 643) GRAYSCALE_A_64S ( 643) GRAYSCALE_A_64U ( 644) GRAYSCALE_A_8S ( 644) GRAYSCALE_A_8U ( 644)
see page
see page
see page
see page
see page
see page
see page
see page
see page
GRAYSCALE_PA_16S ( page 644)
see
637
8.1 Java Reference GRAYSCALE_PA_16U ( page 644) GRAYSCALE_PA_32F ( page 644) GRAYSCALE_PA_32S ( page 644) GRAYSCALE_PA_32U ( page 644) GRAYSCALE_PA_64F ( page 645) GRAYSCALE_PA_64S ( page 645) GRAYSCALE_PA_64U ( page 645) GRAYSCALE_PA_8S ( 645) GRAYSCALE_PA_8U ( 645) RGB_16S (
see
Specifies grayscale image pixel format where each pixel is represented by 16 bits per pre-multiplied alpha channel (channel format - unsigned integer). Specifies grayscale image pixel format where each pixel is represented by 32 bits per pre-multiplied alpha channel (channel format - floating point). Specifies grayscale image pixel format where each pixel is represented by 32 bits per pre-multiplied alpha channel (channel format - signed integer). Specifies grayscale image pixel format where each pixel is represented by 32 bits per pre-multiplied alpha channel (channel format - unsigned integer). Specifies grayscale image pixel format where each pixel is represented by 64 bits per pre-multiplied alpha channel (channel format - floating point). Specifies grayscale image pixel format where each pixel is represented by 64 bits per pre-multiplied alpha channel (channel format - signed integer). Specifies grayscale image pixel format where each pixel is represented by 64 bits per pre-multiplied alpha channel (channel format - unsigned integer). Specifies grayscale image pixel format where each pixel is represented by 8 bits per pre-multiplied alpha channel (channel format - signed integer). Specifies grayscale image pixel format where each pixel is represented by 8 bits per pre-multiplied alpha channel (channel format - unsigned integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per channel (channel format - floating point). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per channel (channel format - floating point). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - signed integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - unsigned integer).
see
see
see
see
see
see
see page
see page
see page 645)
RGB_16U (
see page 645)
RGB_32F ( RGB_32S (
RGB_32U (
see page 646)
RGB_64F ( RGB_64S (
RGB_64U (
see page 646)
RGB_8S ( RGB_8U (
RGB_8U_INDEXED_1 ( 646)
see page Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - unsigned integer). Also 1 bit is for saving index to image palette.
638
8.1 Java Reference RGB_8U_INDEXED_2 ( 647) RGB_8U_INDEXED_4 ( 647) RGB_8U_INDEXED_8 ( 647) RGB_A_16S (
see page Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - unsigned integer). Also 2 bits is for saving index to image palette. see page Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - unsigned integer). Also 4 bits is for saving index to image palette. see page Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - unsigned integer). Also 8 bits is for saving index to image palette. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per alpha channel (channel format - floating point). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per alpha channel (channel format - floating point). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format unsigned integer). Also 1 bit is for saving index to image palette. Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format unsigned integer). Also 2 bits is for saving index to image palette. Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format unsigned integer). Also 4 bits is for saving index to image palette. Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format unsigned integer). Also 8 bits is for saving index to image palette. Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per pre-multiplied alpha channel (channel format signed integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per pre-multiplied alpha channel (channel format unsigned integer).
see page 647)
RGB_A_16U (
see page 647)
RGB_A_32F (
see page 647)
RGB_A_32S (
see page 647)
RGB_A_32U (
see page 647)
RGB_A_64F (
see page 648)
RGB_A_64S (
see page 648)
RGB_A_64U (
see page 648)
RGB_A_8S (
see page 648)
RGB_A_8U (
see page 648)
RGB_A_8U_INDEXED_1 ( page 648) RGB_A_8U_INDEXED_2 ( page 648) RGB_A_8U_INDEXED_4 ( page 648) RGB_A_8U_INDEXED_8 ( page 649) RGB_PA_16S (
see
see
see
see
see page 649)
RGB_PA_16U (
see page 649)
639
8.1 Java Reference RGB_PA_32F (
see page 649)
Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per pre-multiplied alpha channel (channel format floating point). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per pre-multiplied alpha channel (channel format signed integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per pre-multiplied alpha channel (channel format unsigned integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per pre-multiplied alpha channel (channel format floating point). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per pre-multiplied alpha channel (channel format signed integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per pre-multiplied alpha channel (channel format unsigned integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per pre-multiplied alpha channel (channel format signed integer). Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per pre-multiplied alpha channel (channel format unsigned integer). Indicates undefined pixel format.
RGB_PA_32S (
see page 649)
RGB_PA_32U (
see page 649)
RGB_PA_64F (
see page 649)
RGB_PA_64S (
see page 649)
RGB_PA_64U (
see page 650)
RGB_PA_8S (
see page 650)
RGB_PA_8U (
see page 650)
UNDEFINED ( NPixelFormat Methods Name
see page 650)
Description see page 650) Calculates number of bytes needed to store line of specified length of pixels with specified bits per pixel and alignment. Calculates number of bytes needed to store line of specified length of pixels with specified bits per pixel and alignment. Retrieves number of bits used to store a pixel. Retrieves number of bytes used to store a pixel. Retrieves an indexed version of the NPixelFormat. Retrieves a non-indexed version of the NPixelFormat. Retrieves the palette size. Retrieves the pixel type for the specified pixel format. Calculates number of bytes needed to store line of specified length of pixels with specified NPixelFormat. Calculates number of bytes needed to store line of specified length of pixels with specified NPixelFormat. Retrieves a separated version of the NPixelFormat. Retrieves a version of the NPixelFormat with an extra channel. Checks whether current NPixelFormat value is valid.
calcRowLongSize ( calcRowSize (
see page 651) see page 651) see page 651) see page 652) see page 652) see page 652) see page 653)
getBitsPerPixel ( getBytesPerPixel ( getIndexed ( getNonIndexed ( getPaletteSize ( getPixelType (
see page 652)
getNonSeparated (
see page 652) Retrieves a non-separated version of the NPixelFormat.
getRowLongSize ( getRowSize ( getSeparated (
getWithExtraChannel ( 654) isValid ( see page 654)
8.1.5.1.6.1 NPixelFormat Constructor

8.1.5.1.6.1.1 NPixelFormat.NPixelFormat Constructor (NPixelType, NExtraChannel, int, NChannelFormat, int, int, boolean)
Initiazlizes a new instance of NPixelFormat class.
640
public NPixelFormat(NPixelType pixelType, NExtraChannel extraChannel, int channelCount, NChannelFormat channelFormat, int bitsPerChannel, int bitsPerIndex, boolean isSeparated); Parameters Parameters NPixelType pixelType NExtraChannel extraChannel int channelCount NChannelFormat channelFormat int bitsPerChannel boolean isSeparated bitsPetIndex Description Type of pixels. The extra channel. The number of channels. Format of the channel. Number of bits per channel. true if separated; else false. Number of bits per index.
8.1.5.1.6.1.2 NPixelFormat.NPixelFormat Constructor (int)

Initiazlizes a new instance of NPixelFormat class. Java public NPixelFormat(int value); Parameters Parameters int value Description The pixel format.
8.1.5.1.6.2 NPixelFormat Fields

8.1.5.1.6.2.1 NPixelFormat.GRAYSCALE_16S Field
Specifies grayscale image pixel format where each pixel is represented by 16 bits per channel (channel format - signed integer). Java public static final NPixelFormat GRAYSCALE_16S = new NPixelFormat(0x00411001);
8.1.5.1.6.2.2 NPixelFormat.GRAYSCALE_16U Field

Specifies grayscale image pixel format where each pixel is represented by 16 bits per channel (channel format - unsigned integer). Java public static final NPixelFormat GRAYSCALE_16U = new NPixelFormat(0x00401001);

Specifies grayscale image pixel format where each pixel is represented by 1 bit per channel (channel format - unsigned integer). Java public static final NPixelFormat GRAYSCALE_1U = new NPixelFormat(0x00001001);

641
8.1 Java Reference
8.1.5.1.6.2.5 NPixelFormat.GRAYSCALE_32F Field

Specifies grayscale image pixel format where each pixel is represented by 32 bits per channel (channel format - floating point). Java public static final NPixelFormat GRAYSCALE_32F = new NPixelFormat(0x00521001);



8.1.5.1.6.2.9 NPixelFormat.GRAYSCALE_64F Field

Specifies grayscale image pixel format where each pixel is represented by 64 bits per channel (channel format - floating point). Java public static final NPixelFormat GRAYSCALE_64F = new NPixelFormat(0x00621001);



642
8.1 Java Reference

8.1.5.1.6.2.14 NPixelFormat.GRAYSCALE_A_16S Field

Specifies grayscale image pixel format where each pixel is represented by 16 bits per alpha channel (channel format signed integer). Alpha channel specifies pixel transparency. Java public static final NPixelFormat GRAYSCALE_A_16S = new NPixelFormat(0x00412101);
8.1.5.1.6.2.15 NPixelFormat.GRAYSCALE_A_16U Field

Specifies grayscale image pixel format where each pixel is represented by 16 bits per alpha channel (channel format unsigned integer). Alpha channel specifies pixel transparency. Java public static final NPixelFormat GRAYSCALE_A_16U = new NPixelFormat(0x00402101);
8.1.5.1.6.2.16 NPixelFormat.GRAYSCALE_A_32F Field

Specifies grayscale image pixel format where each pixel is represented by 32 bits per alpha channel (channel format floating point). Alpha channel specifies pixel transparency. Java public static final NPixelFormat GRAYSCALE_A_32F = new NPixelFormat(0x00522101);


8.1.5.1.6.2.19 NPixelFormat.GRAYSCALE_A_64F Field

Specifies grayscale image pixel format where each pixel is represented by 64 bits per alpha channel (channel format floating point). Alpha channel specifies pixel transparency. Java public static final NPixelFormat GRAYSCALE_A_64F = new NPixelFormat(0x00622101);

643
8.1 Java Reference


Specifies grayscale image pixel format where each pixel is represented by 8 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Java public static final NPixelFormat GRAYSCALE_A_8S = new NPixelFormat(0x00312101);

8.1.5.1.6.2.24 NPixelFormat.GRAYSCALE_PA_16S Field

Specifies grayscale image pixel format where each pixel is represented by 16 bits per pre-multiplied alpha channel (channel format - signed integer). Java public static final NPixelFormat GRAYSCALE_PA_16S = new NPixelFormat(0x00412201);
8.1.5.1.6.2.25 NPixelFormat.GRAYSCALE_PA_16U Field

Specifies grayscale image pixel format where each pixel is represented by 16 bits per pre-multiplied alpha channel (channel format - unsigned integer). Java public static final NPixelFormat GRAYSCALE_PA_16U = new NPixelFormat(0x00402201);
8.1.5.1.6.2.26 NPixelFormat.GRAYSCALE_PA_32F Field

Specifies grayscale image pixel format where each pixel is represented by 32 bits per pre-multiplied alpha channel (channel format - floating point). Java public static final NPixelFormat GRAYSCALE_PA_32F = new NPixelFormat(0x00522201);


644
8.1 Java Reference
8.1.5.1.6.2.29 NPixelFormat.GRAYSCALE_PA_64F Field

Specifies grayscale image pixel format where each pixel is represented by 64 bits per pre-multiplied alpha channel (channel format - floating point). Java public static final NPixelFormat GRAYSCALE_PA_64F = new NPixelFormat(0x00622201);




8.1.5.1.6.2.34 NPixelFormat.RGB_16S Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Java public static final NPixelFormat RGB_16S = new NPixelFormat(0x00413003);
8.1.5.1.6.2.35 NPixelFormat.RGB_16U Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Java public static final NPixelFormat RGB_16U = new NPixelFormat(0x00403003);
8.1.5.1.6.2.36 NPixelFormat.RGB_32F Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per channel (channel format - floating point). Java public static final NPixelFormat RGB_32F = new NPixelFormat(0x00523003);
645
8.1 Java Reference


8.1.5.1.6.2.39 NPixelFormat.RGB_64F Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per channel (channel format - floating point). Java public static final NPixelFormat RGB_64F = new NPixelFormat(0x00623003);



Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format signed integer). Java public static final NPixelFormat RGB_8S = new NPixelFormat(0x00313003);

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format unsigned integer). Java public static final NPixelFormat RGB_8U = new NPixelFormat(0x00303003);
8.1.5.1.6.2.44 NPixelFormat.RGB_8U_INDEXED_1 Field

Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - unsigned integer). Also 1 bit is for saving index to image palette. Java public static final NPixelFormat RGB_8U_INDEXED_1 = new NPixelFormat(0x01303003);
646
8.1 Java Reference

Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per channel (channel format - unsigned integer). Also 2 bits is for saving index to image palette. Java public static final NPixelFormat RGB_8U_INDEXED_2 = new NPixelFormat(0x02303003);


8.1.5.1.6.2.48 NPixelFormat.RGB_A_16S Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - signed integer). Alpha channel specifies pixel transparency. Java public static final NPixelFormat RGB_A_16S = new NPixelFormat(0x00414103);
8.1.5.1.6.2.49 NPixelFormat.RGB_A_16U Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per alpha channel (channel format - unsigned integer). Alpha channel specifies pixel transparency. Java public static final NPixelFormat RGB_A_16U = new NPixelFormat(0x00404103);
8.1.5.1.6.2.50 NPixelFormat.RGB_A_32F Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per alpha channel (channel format - floating point). Alpha channel specifies pixel transparency. Java public static final NPixelFormat RGB_A_32F = new NPixelFormat(0x00524103);


647
8.1 Java Reference
8.1.5.1.6.2.53 NPixelFormat.RGB_A_64F Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per alpha channel (channel format - floating point). Alpha channel specifies pixel transparency. Java public static final NPixelFormat RGB_A_64F = new NPixelFormat(0x00624103);




8.1.5.1.6.2.58 NPixelFormat.RGB_A_8U_INDEXED_1 Field

Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format - unsigned integer). Also 1 bit is for saving index to image palette. Java public static final NPixelFormat RGB_A_8U_INDEXED_1 = new NPixelFormat(0x01304103);

Specifies indexed Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 8 bits per alpha channel (channel format - unsigned integer). Also 2 bits is for saving index to image palette. Java public static final NPixelFormat RGB_A_8U_INDEXED_2 = new NPixelFormat(0x02304103);

648
8.1 Java Reference

8.1.5.1.6.2.62 NPixelFormat.RGB_PA_16S Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per pre-multiplied alpha channel (channel format - signed integer). Java public static final NPixelFormat RGB_PA_16S = new NPixelFormat(0x00414203);
8.1.5.1.6.2.63 NPixelFormat.RGB_PA_16U Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 16 bits per pre-multiplied alpha channel (channel format - unsigned integer). Java public static final NPixelFormat RGB_PA_16U = new NPixelFormat(0x00404203);
8.1.5.1.6.2.64 NPixelFormat.RGB_PA_32F Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 32 bits per pre-multiplied alpha channel (channel format - floating point). Java public static final NPixelFormat RGB_PA_32F = new NPixelFormat(0x00524203);


8.1.5.1.6.2.67 NPixelFormat.RGB_PA_64F Field

Specifies Rgb image pixel format where each pixel (Red, Green, Blue) is represented by 64 bits per pre-multiplied alpha channel (channel format - floating point). Java public static final NPixelFormat RGB_PA_64F = new NPixelFormat(0x00624203);

649
8.1 Java Reference



8.1.5.1.6.2.72 NPixelFormat.UNDEFINED Field

Indicates undefined pixel format. Java public static final NPixelFormat UNDEFINED = new NPixelFormat(0);
8.1.5.1.6.3 NPixelFormat Methods

8.1.5.1.6.3.1 calcRowLongSize Method 8.1.5.1.6.3.1.1 NPixelFormat.calcRowLongSize Method (int, int)
Calculates number of bytes needed to store line of specified length of pixels with specified bits per pixel and alignment. Java public static long calcRowLongSize(int bitsPerPixel, int length); Parameters Parameters int bitsPerPixel int length Returns The number of bytes needed to store line of specified length of pixels with specified bits per pixel. Description A number of bytes needed to store line of pixels. A length of pixels.
8.1.5.1.6.3.1.2 NPixelFormat.calcRowLongSize Method (int, int, int)

Calculates number of bytes needed to store line of specified length of pixels with specified bits per pixel and alignment. Java public static long calcRowLongSize(int bitsPerPixel, int length, int alignment); Parameters Parameters int bitsPerPixel Description A number of bytes needed to store line of pixels. 650
8.1 Java Reference int length int alignment Returns
A length of pixels. Alignment.
The number of bytes needed to store line of specified length of pixels with specified bits per pixel.
8.1.5.1.6.3.2 calcRowSize Method 8.1.5.1.6.3.2.1 NPixelFormat.calcRowSize Method (int, int)

Calculates number of bytes needed to store line of specified length of pixels with specified bits per pixel and alignment. Java public static int calcRowSize(int bitsPerPixel, int length); Parameters Parameters int bitsPerPixel int length Returns The number of bytes needed to store line of specified length of pixels with specified bits per pixel. Description A number of bytes needed to store line of pixels. A length of pixels.
8.1.5.1.6.3.2.2 NPixelFormat.calcRowSize Method (int, int, int)

Calculates number of bytes needed to store line of specified length of pixels with specified bits per pixel and alignment. Java public static int calcRowSize(int bitsPerPixel, int length, int alignment); Parameters Parameters int bitsPerPixel int length int alignment Returns The number of bytes needed to store line of specified length of pixels with specified bits per pixel. Description A number of bytes needed to store line of pixels. A length of pixels. Alignment.
8.1.5.1.6.3.3 NPixelFormat.getBitsPerPixel Method

Retrieves number of bits used to store a pixel. Java public int getBitsPerPixel(); Returns Number of bits per pixel.
8.1.5.1.6.3.4 NPixelFormat.getBytesPerPixel Method

Retrieves number of bytes used to store a pixel. Java public int getBytesPerPixel(); Returns Number of bytes per pixel. 651
8.1 Java Reference
8.1.5.1.6.3.5 NPixelFormat.getIndexed Method

Retrieves an indexed version of the NPixelFormat ( Java public NPixelFormat getIndexed(int bitsPerIndex); Parameters Parameters int bitsPerIndex Returns Indexed NPixelFormat ( see page 636). Description Number of bits per index. see page 636).
8.1.5.1.6.3.6 NPixelFormat.getNonIndexed Method

Retrieves a non-indexed version of the NPixelFormat ( Java public NPixelFormat getNonIndexed(); Returns Non-indexed NPixelFormat ( see page 636). see page 636).
8.1.5.1.6.3.7 NPixelFormat.getNonSeparated Method

Retrieves a non-separated version of the NPixelFormat ( Java public NPixelFormat getNonSeparated(); Returns Non-separated NPixelFormat ( see page 636). see page 636).
8.1.5.1.6.3.8 NPixelFormat.getPaletteSize Method

Retrieves the palette size. Java public int getPaletteSize(int length); Parameters Parameters int length Returns Palette size. Description The length of pixels.
8.1.5.1.6.3.9 NPixelFormat.getPixelType Method

Retrieves the pixel type for the specified pixel format. Java public NPixelType getPixelType(int sampleFormat); Parameters Parameters int sampleFormat Description Specified pixel format.
652
8.1 Java Reference Returns NPixelType object.
8.1.5.1.6.3.10 getRowLongSize Method 8.1.5.1.6.3.10.1 NPixelFormat.getRowLongSize Method (int)

Calculates number of bytes needed to store line of specified length of pixels with specified NPixelFormat ( Java public long getRowLongSize(int length); Parameters Parameters int length Returns The number of bytes needed to store line of specified length of pixels with specified NPixel Format. Description A length of pixels. see page 636).
8.1.5.1.6.3.10.2 NPixelFormat.getRowLongSize Method (int, int)

Calculates number of bytes needed to store line of specified length of pixels with specified NPixelFormat ( and alignment. Java public long getRowLongSize(int length, int alignment); Parameters Parameters int length int alignment Returns The number of bytes needed to store line of specified length of pixels with specified NPixel Format. Description A length of pixels. Alignment. see page 636)
8.1.5.1.6.3.11 getRowSize Method 8.1.5.1.6.3.11.1 NPixelFormat.getRowSize Method (int)

Calculates number of bytes needed to store line of specified length of pixels with specified NPixelFormat ( Java public int getRowSize(int length); Parameters Parameters int length Returns The number of bytes needed to store line of specified length of pixels with specified NPixel Format. Description A length of pixels. see page 636).
8.1.5.1.6.3.11.2 NPixelFormat.getRowSize Method (int, int)

Calculates number of bytes needed to store line of specified length of pixels with specified NPixelFormat ( and alignment. see page 636)
653
public int getRowSize(int length, int alignment); Parameters Parameters int length int alignment Returns The number of bytes needed to store line of specified length of pixels with specified NPixel Format. Description A length of pixels. Alignment.
8.1.5.1.6.3.12 NPixelFormat.getSeparated Method

Retrieves a separated version of the NPixelFormat ( Java public NPixelFormat getSeparated(); Returns Separated NPixelFormat ( see page 636). see page 636).
8.1.5.1.6.3.13 NPixelFormat.getWithExtraChannel Method

Retrieves a version of the NPixelFormat ( Java public NPixelFormat getWithExtraChannel(NExtraChannel extraChannel); Returns NPixelFormat ( see page 636) with an extra channel. see page 636) with an extra channel.
8.1.5.1.6.3.14 NPixelFormat.isValid Method

Checks whether current NPixelFormat ( Java public boolean isValid(); Returns true if the object is valid NPixelFormat ( false if not. see page 636), see page 636) value is valid.
8.1.5.1.7 NRGB Class

Represents an RGB color. Java public final class NRGB; File NRGB.java
654
8.1 Java Reference Methods Name NRGB ( NRGB Fields Name blue ( green ( red ( see page 655) see page 655) see page 655) see page 655)
Description Initializes a new instance of NRGB class.
Description The blue component value of this NRGB. The green component value of this NRGB. The red component value of this NRGB.
8.1.5.1.7.1 NRGB Constructor

8.1.5.1.7.1.1 NRGB.NRGB Constructor ()
Initializes a new instance of NRGB class. Java public NRGB();
8.1.5.1.7.1.2 NRGB.NRGB Constructor (int, int, int)

Initializes a new instance of the NRGB structure. Java public NRGB(int red, int green, int blue); Parameters Parameters int red int green int blue Description The red ( The blue ( see page 655) component value of this NRGB. see page 655) component value of this NRGB. see page 655) component value of this NRGB. The green (
8.1.5.1.7.2 NRGB Fields

8.1.5.1.7.2.1 NRGB.blue Field
The blue component value of this NRGB ( Java public int blue; see page 654).
8.1.5.1.7.2.2 NRGB.green Field

The green component value of this NRGB ( Java public int green; see page 654).
8.1.5.1.7.2.3 NRGB.red Field

The red component value of this NRGB ( Java public int red; see page 654).
8.1.5.1.8 NRGBImage Class

Provides functionality for managing 24-bit RGB images. 655
public final class NRGBImage extends NImage; File NRGBImage.java Remarks This class provides advanced functionality, such as individual pixel value retrieval for image with pixel format equal to Rgb. NImage Classes Name PlaneCollection ( NImage Fields Name Description see page 591) Description Represents a collection of planes.
FLAG_DST_ALPHA_CHANNEL_FIRST This flag is used when Nimage should be copied using RGB Alpha ( see page 591) channel first method (ARGB color space). FLAG_DST_BOTTOM_TO_TOP ( page 591) FLAG_DST_SWAP_CHANNELS ( see page 591) see This flag is used when NImage ( see page 589) should be copied changing pixels order bottom to top (bottom lines become top and vice versa). This flag is used when NImage ( see page 589) should be copied swapping RGB channels (Eg. RGB to BRG).
FLAG_SRC_ALPHA_CHANNEL_FIRST This flag is used when Nimage should be copied using RGB Alpha ( see page 591) channel first method (ARGB color space). FLAG_SRC_BOTTOM_TO_TOP ( see page 591) FLAG_SRC_SWAP_CHANNELS ( see page 592) NImage Methods Name copy ( see page 592) see page 594) Description Copies specified rectangular area of the NImage ( other NImage ( see page 589) object. Copies pixels to from memory buffer. Copies specified rectangular area of the NImage ( other NImage ( see page 589) object. Crops an image. Flips image diagonally. Flips image horizontally. Flips image vertically. Creates NImageWithInfo object from a byte channel. Creates NImage ( Creates NImage ( see page 589) object from data. see page 589) object from file. see page 589) to see page 589) to This flag is used when NImage ( see page 589) should be copied changing pixels order bottom to top (bottom lines become top and vice versa). This flag is used when NImage ( see page 589) should be copied swapping RGB channels (Eg. RGB to BRG).
copyFrom ( copyTo ( create ( crop (
Creates an image with specified pixel format, size and stride.
Creates NImage ( see page 589) object from another NImage ( see page 589) object. note If stride is zero then image stride is automatically calculated. For more information on image stride see Stride property. Creates NImageWithInfo object from an input stream. Creates NImageWithInfo object from memory a memory buffer. Gets height of image from NImage ( see page 589) object. Gets horizontal resolution in pixels per inch of image. Horizontal resolution equal to zero means that it is not applicable for the image. 656
see page 608)
see page 611)
getHorzResolution ( 612)
8.1 Java Reference getImageSize (
Gets size of NImage ( Gets size of NImage (
see page 612) Gets the plane size. Gets stride of image from NImage ( Gets NPixelFormat ( object. see page 589) object. see page 589) see page 636) of NImage (
see page 613) see page 613) see page 613) see page 613) see page 614) see page 614) see
Gets pointer to array of pixels from NImage ( Gets the collection of planes. Gets the plane size. Gets stride of image from NImage ( Gets width of image from NImage ( Creates NImage ( Gets NImage (
getPlaneSize (
see page 614) Gets vertical resolution in pixels per inch of image. see page 589) object wrapper.
isResolutionIsAspectRatio ( page 617) nativeTypeOf ( rotateFlip ( save ( see page 617)
see page 589) resolution aspect ratio.
see page 617)
see page 618) see
setHorzResolution (
see page 621) Sets horizontal resolution in pixels per inch of image. Sets NImage ( see page 589) resolution aspect ratio.
setResolutionIsAspectRatio ( page 621) setVertResolution ( toGrayscale ( toImage ( toRgb ( NRGBImage Class Name get ( see page 657) see page 658) getMin ( set ( see page 621)
see page 621) Sets vertical resolution in pixels per inch of image. Converts NImage ( 587). Converts NImage ( Converts NImage ( see page 589) to NGrayscaleImage ( see page
Creates an Image object. see page 589) to monochrome image. see page 589) to Rgb image.
toMonochrome (
Description Gets pixel value in NRGBImage. Public methods Retrieves a function that retrieves NType object for the enclosing type. Sets pixel value in NRGBImage.
nativeTypeOf (
see page 658)
see page 658)
8.1.5.1.8.1 NRGBImage Methods

8.1.5.1.8.1.1 NRGBImage.get Method
Gets pixel value in NRGBImage ( Java public NRGB get(int x, int y); Parameters Parameters int x int y Returns Value of a pixel with specified coordinates. Description X coordinate of the pixel. Y coordinate of the pixel. see page 655).
657
8.1 Java Reference
8.1.5.1.8.1.2 NRGBImage.getMin Method

Public methods Java public NRGB getMin();
8.1.5.1.8.1.3 NRGBImage.nativeTypeOf Method

8.1.5.1.8.1.4 NRGBImage.set Method

Sets pixel value in NRGBImage ( Java public void set(int x, int y, NRGB value); Parameters Parameters int x int y NRGB value Description X coordinate of the pixel. Y coordinate of the pixel. Value of a pixel with specified coordinates. see page 655).
8.1.5.1.9 PNGInfo Class

Provides infromation about PNG format images. Java public final class PNGInfo extends NImageInfo; File PNGInfo.java PNGInfo Fields PNGInfo Class Name Description
DEFAULT_COMPRESSION_LEVEL Specifies default PNG compression level. ( see page 659) NImageInfo Methods Name getFormat ( see page 634) see page 634) nativeTypeOf ( PNGInfo Class Name getCompressionLevel ( 659) nativeTypeOf ( see page Description Retrieves compression level of a PNG image. Description Gets the image format. Retrieves a function that retrieves NType object for the enclosing type.
8
see page 659)
658
8.1 Java Reference setCompressionLevel ( 659)
com.neurotec.jna Package
see page
Sets compression level of a PNG image.
8.1.5.1.9.1 PNGInfo Fields

8.1.5.1.9.1.1 PNGInfo.DEFAULT_COMPRESSION_LEVEL Field
Specifies default PNG compression level. Java public static final int DEFAULT_COMPRESSION_LEVEL = 6;
8.1.5.1.9.2 PNGInfo Methods

8.1.5.1.9.2.1 PNGInfo.getCompressionLevel Method
Retrieves compression level of a PNG image. Java public int getCompressionLevel(); Returns NInt value defining the compression level.
8.1.5.1.9.2.2 PNGInfo.nativeTypeOf Method

8.1.5.1.9.2.3 PNGInfo.setCompressionLevel Method

Sets compression level of a PNG image. Java public void setCompressionLevel(int value); Parameters Parameters int value Description New compression level value.
8.1.6 com.neurotec.jna Package

Contains classes that provide functionality for working with Java Native Access (JNA). Module Java Reference ( Classes Name HNObject ( NativeSize ( see page 660) see page 660) Description Provides functionality for working with object handles. Provides functionality for working with native size. 659 see page 59)
8.1 Java Reference NFunctionMapper ( NMemory ( Interfaces Name NLibrary ( see page 663)
see page 661) Provides functionality for function mapping. Provides memory management for Neurotechnology components.
see page 661)
Description
8.1.6.1 Classes
8.1.6.1.1 HNObject Class
Provides functionality for working with object handles. Java public final class HNObject extends PointerType; File HNObject.java Methods Name HNObject ( see page 660) Description Initializes a new instance of HNObject class.
8.1.6.1.1.1 HNObject Constructor

8.1.6.1.1.1.1 HNObject.HNObject Constructor ()
Initializes a new instance of HNObject class. Java public HNObject();
8.1.6.1.1.1.2 HNObject.HNObject Constructor (Pointer)

Initializes a new instance of HNObject class. Java public HNObject(Pointer pointer); Parameters Parameters Pointer pointer Description An object handle.
8.1.6.1.2 NativeSize Class

Provides functionality for working with native size. Java public final class NativeSize extends IntegerType; File NativeSize.java
660
8.1 Java Reference Methods Name NativeSize ( NativeSize Fields Name SIZE ( see page 661) see page 661)
Description Initializes a new instance of NativeSize structure.
Description Platform.is64Bit() ? 8 : 4;
8.1.6.1.2.1 NativeSize Constructor

8.1.6.1.2.1.1 NativeSize.NativeSize Constructor ()
Initializes a new instance of NativeSize structure. Java public NativeSize();
8.1.6.1.2.1.2 NativeSize.NativeSize Constructor (long)

Initializes a new instance of NativeSize structure. Java public NativeSize(long value); Parameters Parameters long value Description The native size.
8.1.6.1.2.2 NativeSize Fields

8.1.6.1.2.2.1 NativeSize.SIZE Field
Platform.is64Bit() ? 8 : 4; Java public static final int SIZE = Native.SIZE_T_SIZE;
8.1.6.1.3 NFunctionMapper Class

Provides functionality for function mapping. Java public class NFunctionMapper extends W32APIFunctionMapper; File NFunctionMapper.java
8.1.6.1.4 NMemory Class

Provides memory management for Neurotechnology components. Java public class NMemory extends Memory implements NDisposable; File NMemory.java
661
8.1 Java Reference Methods Name NMemory ( NMemory Methods Name dispose ( see page 662) see page 662)
Description Initializes a new instance of NMemory class.
Description Disposes of the current memory block.
8.1.6.1.4.1 NMemory Constructor

8.1.6.1.4.1.1 NMemory.NMemory Constructor (Pointer, long)
Initializes a new instance of NMemory class. Java public NMemory(Pointer ptr, long size); Parameters Parameters Pointer ptr long size Description A pointer to the memory block. Size of the memory block.
8.1.6.1.4.1.2 NMemory.NMemory Constructor (Pointer, long, boolean)

Initializes a new instance of NMemory class. Java public NMemory(Pointer ptr, long size, boolean ownsPtr); Parameters Parameters Pointer ptr long size boolean ownsPtr Description A pointer to the memory block. Size of the memory block. true, if the memory block owns the pointer; else false.
8.1.6.1.4.1.3 NMemory.NMemory Constructor (long)

Initializes a new instance of NMemory class. Java public NMemory(long size); Parameters Parameters long size Description Size of the memory block.
8.1.6.1.4.2 NMemory Methods

8.1.6.1.4.2.1 NMemory.dispose Method
Disposes of the current memory block. Java public void dispose();
8.1.6.2 Interfaces
662
8.1 Java Reference
com.neurotec.lang Package
8.1.6.2.1 NLibrary Interface

Java public interface NLibrary extends Library; File NLibrary.java
8.1.7 com.neurotec.lang Package

Contains classes that provide infrastructure for Neurotechnology components. Module Java Reference ( Classes Name ErrorCreator ( see page 663) see page ExternalException ( Description Manages error creation. Provides a method to release allocated resources. This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. Defines error codes used in Neurotechnology components. The exception that is thrown when unknown error occurred in one of Neurotechnology libraries. Allow to get the information about the module. Provides functionality for retrieving information about specified object. Represents an unsigned rational number. Provides functionality for unmanaged functions error handling. This type of exception appears when trying to perform unsupported operation with the parameter. This type of exception appears when trying to change parameter's value that is read only. see page 664) Provides functionality for managing excternal exceptions. see page 59)
NAbstractDisposable ( 665) NCore ( NError ( see page 666)
NeurotecException ( 680) NModule ( NObject ( NRational ( NResult (
see page 680) see page 683) see page 694) see page 695) see page
ParameterException ( 704)
ParameterReadOnlyException ( see page 704) Interfaces Name NDisposable ( see page 705)
Description Provides a method to release allocated resources.
8.1.7.1 Classes
8.1.7.1.1 ErrorCreator Class
Manages error creation. Java public abstract class ErrorCreator; File ErrorCreator.java 663
8.1 Java Reference
8.1.7.1.2 ExternalException Class

Provides functionality for managing excternal exceptions. Java public class ExternalException extends NeurotecExceptionBase implements NThrowable; File ExternalException.java Methods Name ExternalException ( ExternalException Methods Name getExternalError ( see page 665) Description Retrieves the external error. Description see page 664) Initializes a new instance of ExternalException class.
8.1.7.1.2.1 ExternalException Constructor

8.1.7.1.2.1.1 ExternalException.ExternalException Constructor ()
Initializes a new instance of ExternalException class. Java public ExternalException();
8.1.7.1.2.1.2 ExternalException.ExternalException Constructor (String)

Initializes a new instance of ExternalException class. Java public ExternalException(String message); Parameters Parameters String message Description Error message.
8.1.7.1.2.1.3 ExternalException.ExternalException Constructor (String, Throwable)

Initializes a new instance of ExternalException class. Java public ExternalException(String message, Throwable cause); Parameters Parameters String message Throwable cause Description Error message.
8.1.7.1.2.1.4 ExternalException.ExternalException Constructor (int, String)

Initializes a new instance of ExternalException class. Java public ExternalException(int externalError, String message);
664
8.1 Java Reference Parameters Parameters int externalError String message
Description Error message.
8.1.7.1.2.1.5 ExternalException.ExternalException Constructor (int, int, String, Throwable)

Initializes a new instance of ExternalException class. Java public ExternalException(int code, int externalError, String message, Throwable cause); Parameters Parameters int code int externalError String message Throwable cause Error message. Description Error code.
8.1.7.1.2.2 ExternalException Methods

8.1.7.1.2.2.1 ExternalException.getExternalError Method
Retrieves the external error. Java public final int getExternalError();
8.1.7.1.3 NAbstractDisposable Class

Provides a method to release allocated resources. Java public abstract class NAbstractDisposable implements NDisposable; File NAbstractDisposable.java NAbstractDisposable Methods NAbstractDisposable Class Name dispose ( see page 665) Description Performs tasks associated with freeing, releasing, or resetting unmanaged resources. This method is used to close or release unmanaged resources. By convention, this method is used for all tasks associated with freeing resources held by an object. Gets whether allocated resources were released previously.
isDisposed (
see page 666)
8.1.7.1.3.1 NAbstractDisposable Methods

8.1.7.1.3.1.1 NAbstractDisposable.dispose Method
Performs tasks associated with freeing, releasing, or resetting unmanaged resources. This method is used to close or release unmanaged resources. By convention, this method is used for all tasks associated with freeing resources held by an object.
665
8.1 Java Reference Java public void dispose();
8.1.7.1.3.1.2 NAbstractDisposable.isDisposed Method

Gets whether allocated resources were released previously. Java public boolean isDisposed(); Returns true, if disposed; else false.
8.1.7.1.4 NCore Class

This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. Java public final class NCore; File NCore.java NCore Fields Name DLL_NAME ( see page 667) see page see page NATIVE_LIBRARY ( 667) Description Name of DLL containing unmanaged part of this component. The native library. String encoding.
STRING_ENCODING ( 667) NCore Methods Name
Description Adds an error suppressed listener. Adds a shutdown ( see page 676) hook to a task.
addErrorSuppressedListener ( see page 667) addShutdownHook ( 668) alloc ( calloc ( clear ( copy ( fill ( free ( see page 668) see page 668) see page 669) see page 669) see page 670) see page 671) see see page
Allocates a block of memory. Allocates an array in memory with elements initialized to 0. Clears all elements in the specified array. Compares two memory blocks. Copies data from one memory block to other. Sets memory block to a specified value. Frees a block of memory. Gets a specific constructor of the NByteType class. Gets method of the extended class, whose parameters match the specified argument types. Gets a specific constructor of the NIntType class. Gets a specific constructor of the NLongType class. Retrieves an object indicated by a pointer.
compare (
see page 671)
getByteTypeConstructor ( page 672) getEnumGetMethod ( 672) getIntTypeConstructor ( 672)
see page see page see
getLongTypeConstructor ( page 673) getObjectFromPointer ( 673)
see page
getObjectsFromPointerArray ( page 673)
see Retrieves an array of object from an array of pointer.
666
8.1 Java Reference getPointerForCallback ( 673) getPointerFreeProc ( 674)
see page
Gets a pointer for the specified callback. Gets a free ( see page 671) pointer.
see page see
getShortTypeConstructor ( page 674) move ( see page 674) nativeModuleOf ( realloc (
Gets a specific constructor of the NShortType class. Moves one memory block to another. Retrieves a function that retrieves NModule ( the enclosing module. Reallocate memory blocks. For internal use. Removes the error suppressed listener. see page 676) hook from a task. see page 680) object for
see page 675)
refPointer (
removeErrorSuppressedListener ( see page 676) removeShutdownHook ( 676) shutdown ( shutdownThread ( toCharArray ( toDate ( toString ( toNativeDate ( unrefPointer (
see page Removes a shutdown (
Shuts the current task down. Shuts the current thread down. Returns a char array representing the specified type. Converts a long value into UTC DateTime value. Converts an UTC DateTime value into long value. Returns a string that represents the specified type. For internal use.
8.1.7.1.4.1 NCore Fields

8.1.7.1.4.1.1 NCore.DLL_NAME Field
Name of DLL containing unmanaged part of this component. Java public static final String DLL_NAME = "NCore";
8.1.7.1.4.1.2 NCore.NATIVE_LIBRARY Field

The native library. Java public static final NativeLibrary NATIVE_LIBRARY;
8.1.7.1.4.1.3 NCore.STRING_ENCODING Field

String encoding. Java public static final NEncoding STRING_ENCODING;
8.1.7.1.4.2 NCore Methods

8.1.7.1.4.2.1 NCore.addErrorSuppressedListener Method
Adds an error suppressed listener. Java public static void addErrorSuppressedListener(ErrorSuppressedListener listener);
667
8.1 Java Reference Parameters Parameters ErrorSuppressedListener listener
Description The error suppressed listener.
8.1.7.1.4.2.2 NCore.addShutdownHook Method

Adds a shutdown ( Java public static synchronized void addShutdownHook(Runnable task); Parameters Parameters Runnable task Description The specified task. see page 676) hook to a task.
8.1.7.1.4.2.3 alloc Method 8.1.7.1.4.2.3.1 NCore.alloc Method (int)

Allocates a block of memory. Java public static Pointer alloc(int size); Parameters Parameters int size Returns A representation of a pointer to the allocated Description Size in bytes of memory to be allocated.
8.1.7.1.4.2.3.2 NCore.alloc Method (long)

Allocates a block of memory. Java public static Pointer alloc(long size); Parameters Parameters long size Returns A representation of a pointer to the allocated Description Size in bytes of memory to be allocated.
8.1.7.1.4.2.4 calloc Method 8.1.7.1.4.2.4.1 NCore.calloc Method (int)

Allocates an array in memory with elements initialized to 0. Java public static Pointer calloc(int size); Parameters Parameters int size Description Size in bytes of memory to be allocated. 668
8.1 Java Reference Returns Pointer to allocated memory block.
8.1.7.1.4.2.4.2 NCore.calloc Method (long)

Allocates an array in memory with elements initialized to 0. Java public static Pointer calloc(long size); Parameters Parameters long size Returns Pointer to allocated memory block. Description Size in bytes of memory to be allocated.
8.1.7.1.4.2.5 clear Method 8.1.7.1.4.2.5.1 NCore.clear Method (Pointer, int)

Clears all elements in the specified array. Java public static void clear(Pointer pBlock, int size); Parameters Parameters Pointer pBlock int size Description A pointer to memory block that contains an array. The size in bytes of an array.
8.1.7.1.4.2.5.2 NCore.clear Method (Pointer, long)

Clears all elements in the specified array. Java public static void clear(Pointer pBlock, long size); Parameters Parameters Pointer pBlock long size Description A pointer to memory block that contains an array. The size in bytes of an array.
8.1.7.1.4.2.6 compare Method 8.1.7.1.4.2.6.1 NCore.compare Method (Pointer, Pointer, int)

Compares two memory blocks. Java public static int compare(Pointer pBlock1, Pointer pBlock2, int size); Parameters Parameters Pointer pBlock1 Pointer pBlock2 int size Description A pointer to the first memory block. A pointer to the second memory block. Number of characters to be compared. 669
The value indicating the relationship between the memory blocks. If return value is less than zero a block specified by pBlock1 is less than a block specified by pBlock2. If return value is zero a block specified by pBlock1 is identical to a block specified by pBlock2. If return value is greater than zero a block specified by pBlock1 is greater than a block specified by pBlock2.
8.1.7.1.4.2.6.2 NCore.compare Method (Pointer, Pointer, long)

Compares two memory blocks. Java public static int compare(Pointer pBlock1, Pointer pBlock2, long size); Parameters Parameters Pointer pBlock1 Pointer pBlock2 long size Returns The value indicating the relationship between the memory blocks. If return value is less than zero a block specified by pBlock1 is less than a block specified by pBlock2. If return value is zero a block specified by pBlock1 is identical to a block specified by pBlock2. If return value is greater than zero a block specified by pBlock1 is greater than a block specified by pBlock2. Description A pointer to the first memory block. A pointer to the second memory block. Number of characters to be compared.
8.1.7.1.4.2.7 copy Method 8.1.7.1.4.2.7.1 NCore.copy Method (Pointer, Pointer, int)

Copies data from one memory block to other. Java public static void copy(Pointer pDstBlock, Pointer pSrcBlock, int size); Parameters Parameters Pointer pDstBlock Pointer pSrcBlock int size Description A pointer to destination memory block (a memory block where the data from source memory block will be copied). A pointer to memory block to be copied to another memory block. The size of memory block to be copied (the size is in bytes).
8.1.7.1.4.2.7.2 NCore.copy Method (Pointer, Pointer, long)

Copies data from one memory block to other. Java public static void copy(Pointer pDstBlock, Pointer pSrcBlock, long size); Parameters Parameters Pointer pDstBlock Pointer pSrcBlock Description A pointer to destination memory block (a memory block where the data from source memory block will be copied). A pointer to memory block to be copied to another memory block.
670
8.1 Java Reference long size
The size of memory block to be copied (the size is in bytes).
8.1.7.1.4.2.8 fill Method 8.1.7.1.4.2.8.1 NCore.fill Method (Pointer, byte, int)

Sets memory block to a specified value. Java public static void fill(Pointer pBlock, byte value, int size); Parameters Parameters Pointer pBlock byte value int size Description A pointer to a destination memory block that contains data. A value to set. The size in bytes of memory block to be set.
8.1.7.1.4.2.8.2 NCore.fill Method (Pointer, byte, long)

Sets memory block to a specified value. Java public static void fill(Pointer pBlock, byte value, long size); Parameters Parameters Pointer pBlock byte value long size Description A pointer to a destination memory block that contains data. A value to set. The size in bytes of memory block to be set.
8.1.7.1.4.2.9 free Method 8.1.7.1.4.2.9.1 NCore.free Method (HNString)

Frees a block of memory. Java public static void free(HNString hValue); Parameters Parameters HNString hValue Description a handle to the name of the block of memory to be freed.
8.1.7.1.4.2.9.2 NCore.free Method (Pointer)

Frees a specified memory block. Java public static void free(Pointer rBlock); Parameters Parameters Pointer rBlock Remarks The Free method frees a memory block that was previously allocated by a call to Alloc, CAlloc or ReAlloc methods. The number of freed bytes is equivalent to the number of bytes requested when the block was allocated (or reallocated, in the case of ReAlloc). 671 Description A pointer to previously allocated memory block to be freed.
8.1 Java Reference
8.1.7.1.4.2.9.3 NCore.free Method (Pointer, NMemoryType)

Frees a specified memory block. Java public static void free(Pointer rBlock, NMemoryType memoryType); Parameters Parameters Pointer rBlock NMemoryType memoryType Remarks The Free method frees a memory block that was previously allocated by a call to Alloc, CAlloc or ReAlloc methods. The number of freed bytes is equivalent to the number of bytes requested when the block was allocated (or reallocated, in the case of ReAlloc(. Description A pointer to previously allocated memory block to be freed. Type of the memory block.
8.1.7.1.4.2.10 NCore.getByteTypeConstructor Method

Gets a specific constructor of the NByteType class. Java public static <EextendsNByteType>Constructor<E> getByteTypeConstructor(Class<E> cls); Parameters Parameters An Returns An object representing the public instance constructor whose parameters match the types in the parameter type array, if found; otherwise, null. Description array of Type objects representing the number, order, and type of the parameters for the desired constructor.
8.1.7.1.4.2.11 NCore.getEnumGetMethod Method

Gets method of the extended class, whose parameters match the specified argument types. Java public static <EextendsNEnum>Method getEnumGetMethod(Class<E> cls); Parameters Parameters Class<E> cls Description An array of type objects representing the number, order, and type of the parameters for the method to get.
8.1.7.1.4.2.12 NCore.getIntTypeConstructor Method

Gets a specific constructor of the NIntType class. Java public static <EextendsNIntType>Constructor<E> getIntTypeConstructor(Class<E> cls); Parameters Parameters An Description array of Type objects representing the number, order, and type of the parameters for the desired constructor.
672
An object representing the public instance constructor whose parameters match the types in the parameter type array, if found; otherwise, null.
8.1.7.1.4.2.13 NCore.getLongTypeConstructor Method

Gets a specific constructor of the NLongType class. Java public static <EextendsNLongType>Constructor<E> getLongTypeConstructor(Class<E> cls); Parameters Parameters An Returns An object representing the public instance constructor whose parameters match the types in the parameter type array, if found; otherwise, null. Description array of Type objects representing the number, order, and type of the parameters for the desired constructor.
8.1.7.1.4.2.14 NCore.getObjectFromPointer Method

Retrieves an object indicated by a pointer. Java public static Object getObjectFromPointer(Pointer ptr); Parameters Parameters Pointer ptr Returns The object. Description A pointer to an object.
8.1.7.1.4.2.15 NCore.getObjectsFromPointerArray Method

Retrieves an array of object from an array of pointer. Java public static Object getObjectsFromPointerArray(Pointer[] ptrs); Parameters Parameters Pointer[] ptrs Returns An array of objects. Description An array of object pointers.
8.1.7.1.4.2.16 NCore.getPointerForCallback Method

Gets a pointer for the specified callback. Java public static Pointer getPointerForCallback(NCallback value); Parameters Parameters NCallback value Description The callback specified. 673
8.1 Java Reference Returns The pointer to the callback.
8.1.7.1.4.2.17 NCore.getPointerFreeProc Method

Gets a free ( Java public static Pointer getPointerFreeProc(); Returns A pointer. see page 671) pointer.
8.1.7.1.4.2.18 NCore.getShortTypeConstructor Method

Gets a specific constructor of the NShortType class. Java public static <EextendsNShortType>Constructor<E> getShortTypeConstructor(Class<E> cls); Parameters Parameters An Returns An object representing the public instance constructor whose parameters match the types in the parameter type array, if found; otherwise, null. Description array of Type objects representing the number, order, and type of the parameters for the desired constructor.
8.1.7.1.4.2.19 move Method 8.1.7.1.4.2.19.1 NCore.move Method (Pointer, Pointer, int)

Moves one memory block to another. Java public static void move(Pointer pDstBlock, Pointer pSrcBlock, int size); Parameters Parameters Pointer pDstBlock Pointer pSrcBlock int size Remarks Copies size bytes from pSrcBlock to pDstBlock. Make sure that the destination buffer is the same size or larger than the source buffer. Description A pointer to destination memory block. A pointer to source memory block. size in bytes to be copied.
8.1.7.1.4.2.19.2 NCore.move Method (Pointer, Pointer, long)

Moves one memory block to another. Java public static void move(Pointer pDstBlock, Pointer pSrcBlock, long size);
674
8.1 Java Reference Parameters Parameters Pointer pDstBlock Pointer pSrcBlock long size
Description A pointer to destination memory block. A pointer to source memory block. size in bytes to be copied. Copies size bytes from pDstBlock to pSrcBlock. Make sure that the destination buffer is the same size or larger than the source buffer.
8.1.7.1.4.2.20 NCore.nativeModuleOf Method

Retrieves a function that retrieves NModule ( Java public static NModule nativeModuleOf(); Returns The function that retrieves NModule ( see page 680) object for the enclosing module. see page 680) object for the enclosing module.
8.1.7.1.4.2.21 realloc Method 8.1.7.1.4.2.21.1 NCore.realloc Method (Pointer, int)

Reallocate memory blocks. Java public static Pointer realloc(Pointer pBlock, int size); Parameters Parameters Pointer pBlock int size Returns New Pointer. Description Pointer to memory block to be allocated. Size in bytes of new memory block.
8.1.7.1.4.2.21.2 NCore.realloc Method (Pointer, long)

Reallocate memory blocks. Java public static Pointer realloc(Pointer pBlock, long size); Parameters Parameters Pointer pBlock long size Returns New Pointer. Description A Pointer to memory block to be allocated. size in bytes of new memory block.
8.1.7.1.4.2.22 refPointer Method 8.1.7.1.4.2.22.1 NCore.refPointer Method (Object)

For internal use.
675
public static Pointer refPointer(Object obj);
8.1.7.1.4.2.22.2 NCore.refPointer Method (Pointer)

For internal use. Java public static void refPointer(Pointer ptr);
8.1.7.1.4.2.23 NCore.removeErrorSuppressedListener Method

Removes the error suppressed listener. Java public static void removeErrorSuppressedListener(ErrorSuppressedListener listener); Parameters Parameters ErrorSuppressedListener listener Description The error suppressed listener.
8.1.7.1.4.2.24 NCore.removeShutdownHook Method

Removes a shutdown ( Java public static synchronized void removeShutdownHook(Runnable task); Parameters Parameters Runnable task Description The specified task. see page 676) hook from a task.
8.1.7.1.4.2.25 NCore.shutdown Method

Shuts the current task down. Java public static synchronized void shutdown();
8.1.7.1.4.2.26 NCore.shutdownThread Method

Shuts the current thread down. Java public static synchronized void shutdownThread();
8.1.7.1.4.2.27 NCore.toCharArray Method

Returns a char array representing the specified type. Java public static char toCharArray(HNString hValue); Parameters Parameters HNString hValue Returns A char array that represents the specified type. Description A handle to the name of the specified type.
676
8.1 Java Reference
8.1.7.1.4.2.28 NCore.toDate Method

Converts a long value into UTC DateTime value. Java public static Date toDate(long value, boolean isUTC); Parameters Parameters long value Returns UTC DateTime value. Description A raw UTC date.
8.1.7.1.4.2.29 NCore.toNativeDate Method

Converts an UTC DateTime value into long value. Java public static long toNativeDate(Date value, boolean isUTC); Parameters Parameters Date value Returns Raw UTC date. Description UTC DateTime value.
8.1.7.1.4.2.30 NCore.toString Method

Returns a string that represents the specified type. Java public static String toString(HNString hValue); Parameters Parameters HNString hValue Returns A string that represents the specified type. Description A handle to the name of the specified type.
8.1.7.1.4.2.31 unrefPointer Method 8.1.7.1.4.2.31.1 NCore.unrefPointer Method (Object)

For internal use. Java public static void unrefPointer(Object obj);
8.1.7.1.4.2.31.2 NCore.unrefPointer Method (Pointer)

For internal use. Java public static void unrefPointer(Pointer ptr);
677
8.1 Java Reference
8.1.7.1.5 NError Class

Defines error codes used in Neurotechnology components. Java public final class NError; File NError.java NError Methods Name get ( see page 678) see page getDefaultMessage ( 678) getLast ( setLast ( suppress ( getMessage ( Description Gets a specific exception. Gets default message for the specified error. Gets the last exception. Gets an error message. Sets the last exception. Suppresses a specific error.
8.1.7.1.5.1 NError Methods

8.1.7.1.5.1.1 get Method 8.1.7.1.5.1.1.1 NError.get Method (HNObject)
Gets a specific exception. Java public static Throwable get(HNObject hError); Parameters Parameters HNObject hError Returns The exception. Description Handle to the object that caused the error.
8.1.7.1.5.1.1.2 NError.get Method (int, HNObject)

Gets a specific exception. Java public static Throwable get(int code, HNObject hError); Parameters Parameters int code HNObject hError Returns The exception. Description Error code. Handle to the object that caused the error.
8
8.1.7.1.5.1.2 NError.getDefaultMessage Method
Gets default message for the specified error. 678
public static String getDefaultMessage(int code); Parameters Parameters int code Returns The default message. Description Error code.
8.1.7.1.5.1.3 NError.getLast Method

Gets the last exception. Java public static Throwable getLast(int code); Parameters Parameters int code Returns The last exception. Description Exception code.
8.1.7.1.5.1.4 NError.getMessage Method

Gets an error message. Java public static String getMessage(String message, String paramName, String param); Parameters Parameters String message String paramName String param Returns Error message. Description Base error message. Parameter name. Error parameter.
8.1.7.1.5.1.5 NError.setLast Method

Sets the last exception. Java public static int setLast(Throwable error); Parameters Parameters Throwable error Returns Code of the last exception. Description Last exception.
8.1.7.1.5.1.6 NError.suppress Method

Suppresses a specific error. 679
public static void suppress(Throwable error); Parameters Parameters Throwable error Description The error to be suppressed.
8.1.7.1.6 NeurotecException Class

The exception that is thrown when unknown error occurred in one of Neurotechnology libraries. Java public final class NeurotecException extends NeurotecExceptionBase; File NeurotecException.java
8.1.7.1.7 NModule Class

Allow to get the information about the module. Java public class NModule extends NObject; File NModule.java NObject Fields NObject Class Name FLAG_REF_RET ( Description see page 684) Parameter used when object should be returned with incremented reference count. This parameter can be used with all *Add* functions accepting flags.
NAbstractDisposable Methods NAbstractDisposable Class Name dispose ( see page 665) Description Performs tasks associated with freeing, releasing, or resetting unmanaged resources. This method is used to close or release unmanaged resources. By convention, this method is used for all tasks associated with freeing resources held by an object. Gets whether allocated resources were released previously.
isDisposed ( NObject Class Name
see page 666)
Description see page 684) Copies parameters values from one NObject ( another. Disposes an object array. Creates a new object of a specified class from a specified handle. Gets flags of the object. Gets handle to unmanaged NObject ( Retrieves native type of object. Gets owner of the object. Gets value of parameter by parameter id. 680 see page 683). see page 683) object to
copyParameters ( disposeArray ( fromHandle ( getFlags ( getHandle ( getOwner (
getNativeType ( getParameter (
8.1 Java Reference getSize ( see page 687)
Retrieves the size of current object. Retrieves the size of the array of objects. Retrieves a function that retrieves NType object for the enclosing type. Increments the reference count for an interface on a specified object. Resets all NObject ( Saves a NObject ( see page 683) parameters to default values. see page 683) array in a memory buffer. Saves the current object in memory buffer. Sets value of parameter by parameter id. Returns a handle to the specified object. Releases memory resources used by specified object. Releases memory resources used by specified object array. Releases memory resources used by specified element array.
getSizeMany ( nativeTypeOf ( ref ( save ( reset (
see page 688) see page 688) see page 688) see page 690) see page 692) see page 693) see page 694) see page 694)
saveMany ( toHandle ( unref ( unrefArray (
setParameter (
see page 693)
unrefElements ( NModule Class Name getActivated ( getCompany ( getCopyright (
Description see page 681) see page 681) see page 681) see page 682) see page Gets a string describing whether the product license has been activated. Gets a string representing the company. Gets a string representing the copyright. Retrieves module dependencies. Gets all the loaded modules that are part of this assembly. Gets a string representing the name of the module. Retrieves module options enumeration. Gets a string representing the product. Gets a string representing the title of the module. Gets a string representing the version. Retrieves a function that retrieves NType object for the enclosing type.
getDependences ( getLoadedModules ( 682) getName ( getOptions ( getProduct ( getTitle ( getVersion (
see page 682)
nativeTypeOf (
8.1.7.1.7.1 NModule Methods

8.1.7.1.7.1.1 NModule.getActivated Method
Gets a string describing whether the product license has been activated. Java public String getActivated(); Returns A string describing whether the product license has been activated.
8.1.7.1.7.1.2 NModule.getCompany Method

Gets a string representing the company. Java public String getCompany(); Returns A string representing the company.
8.1.7.1.7.1.3 NModule.getCopyright Method

Gets a string representing the copyright.
681
8.1 Java Reference Java public String getCopyright(); Returns A string representing the copyright.
8.1.7.1.7.1.4 NModule.getDependences Method

Retrieves module dependencies. Java public NModule getDependences(); Returns Module dependencies.
8.1.7.1.7.1.5 NModule.getLoadedModules Method

Gets all the loaded modules that are part of this assembly. Java public static NModule getLoadedModules(); Returns An array of loaded modules.
8.1.7.1.7.1.6 NModule.getName Method

Gets a string representing the name of the module. Java public String getName(); Returns A string representing the name of the module.
8.1.7.1.7.1.7 NModule.getOptions Method

Retrieves module options enumeration. Java public EnumSet<NModuleOption> getOptions(); Returns Module options enumeration.
8.1.7.1.7.1.8 NModule.getProduct Method

Gets a string representing the product. Java public String getProduct(); Returns A string representing the product.
8.1.7.1.7.1.9 NModule.getTitle Method

Gets a string representing the title of the module.
682
8.1 Java Reference Java public String getTitle(); Returns
A string representing the title of the module.
8.1.7.1.7.1.10 NModule.getVersion Method

Gets a string representing the version. Java public String getVersion(); Returns A string representing the version.
8.1.7.1.7.1.11 NModule.nativeTypeOf Method

8.1.7.1.8 NObject Class

Provides functionality for retrieving information about specified object. Java public class NObject extends NAbstractDisposable; File NObject.java NObject Fields NObject Class Name FLAG_REF_RET ( Description see page 684) Parameter used when object should be returned with incremented reference count. This parameter can be used with all *Add* functions accepting flags.
NAbstractDisposable Methods NAbstractDisposable Class Name dispose ( see page 665) Description Performs tasks associated with freeing, releasing, or resetting unmanaged resources. This method is used to close or release unmanaged resources. By convention, this method is used for all tasks associated with freeing resources held by an object. Gets whether allocated resources were released previously.
isDisposed ( NObject Class Name
see page 666)
Description see page 684) Copies parameters values from one NObject object to another. Disposes an object array. see page 684)
copyParameters ( disposeArray (
683
8.1 Java Reference fromHandle ( getFlags ( getHandle ( getOwner ( getSize (
see page 685) see page 685) see page 685) see page 686) see page 687) see page 688) see page 686)
Creates a new object of a specified class from a specified handle. Gets flags of the object. Gets handle to unmanaged NObject. Retrieves native type of object. Gets owner of the object. Gets value of parameter by parameter id. Retrieves the size of current object. Retrieves the size of the array of objects. Retrieves a function that retrieves NType object for the enclosing type. Increments the reference count for an interface on a specified object. Resets all NObject parameters to default values. Saves the current object in memory buffer. Saves a NObject array in a memory buffer. Sets value of parameter by parameter id. Returns a handle to the specified object. Releases memory resources used by specified object. Releases memory resources used by specified object array. Releases memory resources used by specified element array.
see page 685)
getNativeType ( getParameter ( getSizeMany ( nativeTypeOf ( ref ( save ( reset (
see page 687)
saveMany ( toHandle ( unref ( unrefArray (
setParameter (
see page 693)
unrefElements (
8.1.7.1.8.1 NObject Fields

8.1.7.1.8.1.1 NObject.FLAG_REF_RET Field
Parameter used when object should be returned with incremented reference count. This parameter can be used with all *Add* functions accepting flags. Java public static final int FLAG_REF_RET = 0x00000010;
8.1.7.1.8.2 NObject Methods

8.1.7.1.8.2.1 NObject.copyParameters Method
Copies parameters values from one NObject ( Java public static void copyParameters(NObject srcObj, NObject dstObj); Parameters Parameters NObject srcObj NObject dstObj Description Source NObject ( copied. see page 683) object which should be see page 683) object where source see page 683) object to another.
Destination NObject ( object will be copied.
8.1.7.1.8.2.2 NObject.disposeArray Method

Disposes an object array. Java public static <EextendsNObject>void disposeArray(E[] objects); Parameters Parameters E[] objects Description The array of objects to be disposed. 684
8.1 Java Reference
8.1.7.1.8.2.3 fromHandle Method 8.1.7.1.8.2.3.1 NObject.fromHandle Method (HNObject, Class<T>)

Creates a new object of a specified class from a specified handle. Java public static <TextendsNObject>T fromHandle(HNObject handle, Class<T> cls); Parameters Parameters HNObject handle Class<T> cls Returns The created object. Description Handle to the source object. Class of the new object.
8.1.7.1.8.2.3.2 NObject.fromHandle Method (HNObject, boolean, boolean, Class<T>)

Creates a new object of a specified class from a specified handle. Java public static <TextendsNObject>T fromHandle(HNObject handle, boolean ownsHandle, boolean cache, Class<T> cls); Parameters Parameters HNObject handle boolean ownsHandle boolean cache Class<T> cls Returns The created object. Description Handle to the source object. true if owns handle; else false. true if created form cache; else false. Class of the new object.
8.1.7.1.8.2.4 NObject.getFlags Method

Gets flags of the object. Java public int getFlags(); Returns Flags of the object.
8.1.7.1.8.2.5 NObject.getHandle Method

Gets handle to unmanaged NObject ( Java public final HNObject getHandle(); Returns A handle to unmanaged NObject ( see page 683). see page 683).
8.1.7.1.8.2.6 NObject.getNativeType Method

Retrieves native type of object. 685
public final NType getNativeType(); Returns NType value.
8.1.7.1.8.2.7 NObject.getOwner Method

Gets owner of the object. Java public NObject getOwner(); Returns Object (owner) of NObject ( see page 683) type.
8.1.7.1.8.2.8 getParameter Method 8.1.7.1.8.2.8.1 NObject.getParameter Method (int)

Gets value of parameter by parameter id. Java public final Object getParameter(int parameterId); Parameters Parameters int parameterId Returns The parameter value. Description The parameter identifier.
8.1.7.1.8.2.8.2 NObject.getParameter Method (int, Class<T>)

Gets value of parameter by parameter id. Java public final <T>T getParameter(int parameterId, Class<T> parameterClass); Parameters Parameters int parameterId Class<T> parameterClass Returns The parameter value. Description The parameter identifier. The runtime class of an object.
8.1.7.1.8.2.8.3 NObject.getParameter Method (short, int)

Gets value of parameter by parameter id. Java public final Object getParameter(short partId, int parameterId); Parameters Parameters short partId int parameterId Description Specifies the part of the specified NObject ( The parameter identifier. 686 see page 683).
8.1 Java Reference Returns The parameter value.
8.1.7.1.8.2.8.4 NObject.getParameter Method (short, int, Class<T>)

Gets value of parameter by parameter id. Java public final <T>T getParameter(short partId, int parameterId, Class<T> parameterClass); Parameters Parameters short partId int parameterId Class<T> parameterClass Returns The parameter value. Description Specifies the part of the specified NObject ( The parameter identifier. The runtime class of an object. see page 683).
8.1.7.1.8.2.9 getSize Method 8.1.7.1.8.2.9.1 NObject.getSize Method ()

Retrieves the size of current object. Java public final int getSize(); Returns The size of the object.
8.1.7.1.8.2.9.2 NObject.getSize Method (int)

Retrieves the size of current object. Java public final int getSize(int flags); Parameters Parameters int flags Returns The size of the object. Description Must be zero.
8.1.7.1.8.2.10 getSizeMany Method 8.1.7.1.8.2.10.1 NObject.getSizeMany Method (E[])

Retrieves the size of the array of objects. Java public static <EextendsNObject>int getSizeMany(E[] objects); Parameters Parameters E[] objects Description The array of objects. 687
8.1 Java Reference Returns Size of the array.
8.1.7.1.8.2.10.2 NObject.getSizeMany Method (E[], int)

Retrieves the size of the array of objects. Java public static <EextendsNObject>int getSizeMany(E[] objects, int flags); Parameters Parameters E[] objects int flags Returns Size of the array. Description The array of objects. Must be zero.
8.1.7.1.8.2.11 NObject.nativeTypeOf Method

8.1.7.1.8.2.12 NObject.ref Method

Increments the reference count for an interface on a specified object. Java public static void ref(HNObject hObject); Parameters Parameters HNObject hObject Description The specified object.
8.1.7.1.8.2.13 NObject.reset Method

Resets all NObject ( Java public final void reset(); see page 683) parameters to default values.
8.1.7.1.8.2.14 save Method 8.1.7.1.8.2.14.1 NObject.save Method ()

Saves the current object in memory buffer. Java public final ByteBuffer save(); Returns The target buffer.
688
8.1 Java Reference
8.1.7.1.8.2.14.2 NObject.save Method (ByteBuffer)

Saves an objects to a memory location with specified size. Java public final int save(ByteBuffer buffer); Parameters Parameters ByteBuffer buffer Returns The size of the object. Description The target buffer.
8.1.7.1.8.2.14.3 NObject.save Method (ByteBuffer, int)

Saves an objects to a memory location with specified size. Java public final int save(ByteBuffer buffer, int flags); Parameters Parameters ByteBuffer buffer int flags Returns The size of the object. Description The target buffer. Must be zero.
8.1.7.1.8.2.14.4 NObject.save Method (OutputStream)

Saves the current object in target stream. Java public final void save(OutputStream out) throws IOException; Parameters Parameters OutputStream out Description The target stream.
8.1.7.1.8.2.14.5 NObject.save Method (OutputStream, int)

Saves the current object in target stream. Java public final void save(OutputStream out, int flags) throws IOException; Parameters Parameters OutputStream out int flags Description The target stream. Must be zero.
8.1.7.1.8.2.14.6 NObject.save Method (WritableByteChannel)

Saves the current object in target byte channel. Java public final void save(WritableByteChannel ch) throws IOException;
689
8.1 Java Reference Parameters Parameters WritableByteChannel ch
Description The target channel.
8.1.7.1.8.2.14.7 NObject.save Method (WritableByteChannel, int)

Saves the current object in target byte channel. Java public final void save(WritableByteChannel ch, int flags) throws IOException; Parameters Parameters WritableByteChannel ch int flags Description The target channel. Must be zero.
8.1.7.1.8.2.14.8 NObject.save Method (int)

Saves the current object in memory buffer. Java public final ByteBuffer save(int flags); Parameters Parameters int flags Returns The target buffer. Description Must be zero.
8.1.7.1.8.2.15 saveMany Method 8.1.7.1.8.2.15.1 NObject.saveMany Method (E[])

Saves a NObject ( Java public static <EextendsNObject>ByteBuffer saveMany(E[] objects); Parameters Parameters E[] objects ch Returns The target buffer. Description The object array to be saved. The target channel. see page 683) array in a memory buffer.
8.1.7.1.8.2.15.2 NObject.saveMany Method (E[], ByteBuffer)

Saves a NObject ( Java public static <EextendsNObject>int saveMany(E[] objects, ByteBuffer buffer); Parameters Parameters E[] objects Description The object array to be saved. 690 see page 683) array in a specified memory buffer.
8.1 Java Reference ByteBuffer buffer Returns The size of the saved array.
The target buffer.
8.1.7.1.8.2.15.3 NObject.saveMany Method (E[], ByteBuffer, int)

Saves a NObject ( Java public static <EextendsNObject>int saveMany(E[] objects, ByteBuffer buffer, int flags); Parameters Parameters E[] objects ByteBuffer buffer int flags Returns The size of the saved array. Description The object array to be saved. The target buffer. Must be zero. see page 683) array in a specified memory buffer.
8.1.7.1.8.2.15.4 NObject.saveMany Method (E[], OutputStream)

Saves a NObject ( Java public static <EextendsNObject>void saveMany(E[] objects, OutputStream out) throws IOException; Parameters Parameters E[] objects OutputStream out Description The object array to be saved. The target stream. see page 683) array in a stream.
8.1.7.1.8.2.15.5 NObject.saveMany Method (E[], OutputStream, int)

Saves a NObject ( Java public static <EextendsNObject>void saveMany(E[] objects, OutputStream out, int flags) throws IOException; Parameters Parameters E[] objects OutputStream out int flags Description The object array to be saved. The target stream. Must be zero. see page 683) array in a stream.
8.1.7.1.8.2.15.6 NObject.saveMany Method (E[], WritableByteChannel)

Saves a NObject ( Java public static <EextendsNObject>void saveMany(E[] objects, WritableByteChannel ch) throws IOException; see page 683) array in a byte channel.
691
8.1 Java Reference Parameters Parameters E[] objects WritableByteChannel ch
Description The object array to be saved. The target channel.
8.1.7.1.8.2.15.7 NObject.saveMany Method (E[], WritableByteChannel, int)

Saves a NObject ( Java public static <EextendsNObject>void saveMany(E[] objects, WritableByteChannel ch, int flags) throws IOException; Parameters Parameters E[] objects WritableByteChannel ch int flags Description The object array to be saved. The target channel. Must be zero. see page 683) array in a byte channel.
8.1.7.1.8.2.15.8 NObject.saveMany Method (E[], int)

Saves a NObject ( Java public static <EextendsNObject>ByteBuffer saveMany(E[] objects, int flags); Parameters Parameters E[] objects int flags ch Returns The target buffer. Description The object array to be saved. Must be zero. The target channel. see page 683) array in a memory buffer.
8.1.7.1.8.2.16 setParameter Method 8.1.7.1.8.2.16.1 NObject.setParameter Method (int, Class<T>, T)

Sets value of parameter by parameter id. Java public final <T>void setParameter(int parameterId, Class<T> parameterClass, T value); Parameters Parameters int parameterId Class<T> parameterClass T value Description The parameter identifier. The runtime class of an object. The parameter value.
8.1.7.1.8.2.16.2 NObject.setParameter Method (int, Object)

Sets value of parameter by parameter id. Java public final void setParameter(int parameterId, Object value);
692
8.1 Java Reference Parameters Parameters int parameterId Object value
Description The parameter identifier. The parameter value.
8.1.7.1.8.2.16.3 NObject.setParameter Method (short, int, Class<T>, T)

Sets value of parameter by parameter id. Java public final <T>void setParameter(short partId, int parameterId, Class<T> parameterClass, T value); Parameters Parameters short partId int parameterId Class<T> parameterClass T value Description Specifies the part of the specified NObject ( The parameter identifier. The runtime class of an object. The parameter value. see page 683).
8.1.7.1.8.2.16.4 NObject.setParameter Method (short, int, Object)

Sets value of parameter by parameter id. Java public final void setParameter(short partId, int parameterId, Object value); Parameters Parameters short partId int parameterId Object value Description Specifies the part of the specified NObject ( The parameter identifier. The parameter value. see page 683).
8.1.7.1.8.2.17 NObject.toHandle Method

Returns a handle to the specified object. Java public static HNObject toHandle(NObject obj); Parameters Parameters NObject obj Returns The handle to the object. Description The specified object.
8.1.7.1.8.2.18 NObject.unref Method

Releases memory resources used by specified object. Java public static void unref(HNObject hObject); Parameters Parameters HNObject hObject Description Pointer to previously allocated memory block to free. 693
8.1 Java Reference
8.1.7.1.8.2.19 NObject.unrefArray Method

Releases memory resources used by specified object array. Java public static void unrefArray(Pointer arhObjects, int objectCount); Parameters Parameters Pointer arhObjects int objectCount Description Pointer to previously allocated object array to free. Number of objects in the array.
8.1.7.1.8.2.20 NObject.unrefElements Method

Releases memory resources used by specified element array. Java public static void unrefElements(Pointer arhObjects, int objectCount); Parameters Parameters Pointer arhObjects int objectCount Description Pointer to previously allocated element array to free. Number of objects in the array.
8.1.7.1.9 NRational Class

Represents an unsigned rational number. Java public final class NRational; File NRational.java Methods Name NRational ( NRational Fields Name denominator ( numerator ( see page 695) see page 695) Description Denominator of NRational. Numerator of NRational. see page 694) Description Initializes a new instance of the NRational structure.
8.1.7.1.9.1 NRational Constructor

8.1.7.1.9.1.1 NRational.NRational Constructor ()
Initializes a new instance of the NRational structure. Java public NRational();
8.1.7.1.9.1.2 NRational.NRational Constructor (int, int)

Initializes a new instance of the NRational structure. Java public NRational(int numerator, int denominator); 694
8.1 Java Reference Parameters Parameters int numerator int denominator
Description Numerator of this NRational. Denominator of this NRational.
8.1.7.1.9.2 NRational Fields

8.1.7.1.9.2.1 NRational.denominator Field
Denominator of NRational ( Java public int denominator; see page 694).
8.1.7.1.9.2.2 NRational.numerator Field

Numerator of NRational ( Java public int numerator; see page 694).
8.1.7.1.10 NResult Class

Provides functionality for unmanaged functions error handling. Java public final class NResult; File NResult.java NResult Fields Name E_ABANDONED_MUTEX ( page 697) E_ARGUMENT ( E_ARGUMENT_NULL ( 697) see Description The wait completed due to an abandoned mutex. Invalid argument.
see page 697)
see page Argument is NULL.
E_ARGUMENT_OUT_OF_RANGE Argument is out of range. ( see page 697) E_ARITHMETIC ( see page 697) see Arithmetic error occurred. Module has invalid format. CLR error occurred. COM error occurred. Core error occurred. C++ error occurred. Directory not found. Module not found. Drive not found. E_BAD_IMAGE_FORMAT ( page 697) E_CLR ( E_COM ( E_CORE ( E_CPP ( see page 697) see page 697) see page 698) see page 698)
E_DIRECTORY_NOT_FOUND ( see page 698) E_DLL_NOT_FOUND ( 698) see page see
E_DRIVE_NOT_FOUND ( page 698) E_END_OF_STREAM ( 698)
see page Unexpected end of stream.
695
8.1 Java Reference
E_ENTRY_POINT_NOT_FOUND ( see page 698) E_EXTERNAL ( E_FAILED ( see page 698) see page 698) see page 699)
Entry point not found in a module. External error occurred. Operation failed. Error loading module from file.
E_FILE_FORMAT ( E_FILE_LOAD (
see page 699) File or stream format is invalid. see page File not found. Argument format is invalid. Access with index was out of range. The cast is invalid. Argument is an invalid enum value. Attempted to execute operation that is not valid for the object. IO error occurred. JVM error occurred. MacOS error occurred. Operation is not activated. Operation is not implemented.
E_FILE_NOT_FOUND ( 699) E_FORMAT (
see page 699)
E_INDEX_OUT_OF_RANGE ( see page 699) E_INVALID_CAST ( 699) see page
E_INVALID_ENUM_ARGUMENT ( see page 699) E_INVALID_OPERATION ( page 699) E_IO ( E_JVM ( E_MAC ( see page 699) see page 699) see page 700) see page see see
E_NOT_ACTIVATED ( 700)
E_NOT_IMPLEMENTED ( page 700) E_NOT_SUPPORTED ( 700) E_NULL_REFERENCE ( page 700) E_OUT_OF_MEMORY ( page 700) E_OVERFLOW ( E_PARAMETER (
see page Operation is not supported. see see Attempted to reference a NULL object. Out of memory. Overflow occurred. Invalid parameter Id. Attempted to set read-only parameter.
E_PARAMETER_READ_ONLY ( see page 700) E_PATH_TOO_LONG ( 701) E_SECURITY ( E_SOCKET ( E_SYS (
see page Path is too long. Security error occurred. Socket error occurred. Sys error occurred. see Error during target invocation. Operation timed out. Win32 error occurred. No error.
see page 701)
E_TARGET_INVOCATION ( page 701) E_TIMEOUT ( E_WIN32 ( OK ( NResult Methods Name check ( see page 701) see page 702) see page 702) see page 702) see page 701)
see page 701)
see page 701)
Description Checks if the result of a function indicates that an error has occurred and if so throws an exception. Checks whether the specified throwable throws all runtime exceptions. Checks whether the specified throwable throws an Input/Output exception Checks whether the specified throwable throws a socket exception. 696
checkAll ( checkIO ( checkNet (
8.1 Java Reference checkTimeout ( getError ( isFailed (
Checks whether the specified throwable throws a timeout exception. Checks what throwable produces the specified result. For internal use only. Checks if the result of a function indicates that an error has occurred. Checks if the result of a function indicates that no error has occurred. For internal use only. For internal use only.
checkUnchecked (
isSucceeded ( setLastError ( suppressError (
8.1.7.1.10.1 NResult Fields

8.1.7.1.10.1.1 NResult.E_ABANDONED_MUTEX Field
The wait completed due to an abandoned mutex. Java public static final int E_ABANDONED_MUTEX = -25;
8.1.7.1.10.1.2 NResult.E_ARGUMENT Field

Invalid argument. Java public static final int E_ARGUMENT = -10;
8.1.7.1.10.1.3 NResult.E_ARGUMENT_NULL Field

Argument is NULL. Java public static final int E_ARGUMENT_NULL = -11;
8.1.7.1.10.1.4 NResult.E_ARGUMENT_OUT_OF_RANGE Field

Argument is out of range. Java public static final int E_ARGUMENT_OUT_OF_RANGE = -12;
8.1.7.1.10.1.5 NResult.E_ARITHMETIC Field

Arithmetic error occurred. Java public static final int E_ARITHMETIC = -17;
8.1.7.1.10.1.6 NResult.E_BAD_IMAGE_FORMAT Field

Module has invalid format. Java public static final int E_BAD_IMAGE_FORMAT = -26;
8.1.7.1.10.1.7 NResult.E_CLR Field

CLR error occurred. Java public static final int E_CLR = -93;
8.1.7.1.10.1.8 NResult.E_COM Field

COM error occurred.
697
public static final int E_COM = -92;
8.1.7.1.10.1.9 NResult.E_CORE Field

Core error occurred. Java public static final int E_CORE = -2;
8.1.7.1.10.1.10 NResult.E_CPP Field

C++ error occurred. Java public static final int E_CPP = -96;
8.1.7.1.10.1.11 NResult.E_DIRECTORY_NOT_FOUND Field

Directory not found. Java public static final int E_DIRECTORY_NOT_FOUND = -19;
8.1.7.1.10.1.12 NResult.E_DLL_NOT_FOUND Field

Module not found. Java public static final int E_DLL_NOT_FOUND = -27;
8.1.7.1.10.1.13 NResult.E_DRIVE_NOT_FOUND Field

Drive not found. Java public static final int E_DRIVE_NOT_FOUND = -20;
8.1.7.1.10.1.14 NResult.E_END_OF_STREAM Field

Unexpected end of stream. Java public static final int E_END_OF_STREAM = -15;
8.1.7.1.10.1.15 NResult.E_ENTRY_POINT_NOT_FOUND Field

Entry point not found in a module. Java public static final int E_ENTRY_POINT_NOT_FOUND = -28;
8.1.7.1.10.1.16 NResult.E_EXTERNAL Field

External error occurred. Java public static final int E_EXTERNAL = -90;
8.1.7.1.10.1.17 NResult.E_FAILED Field

Operation failed. Java public static final int E_FAILED = -1; 698
8.1 Java Reference
8.1.7.1.10.1.18 NResult.E_FILE_FORMAT Field

File or stream format is invalid. Java public static final int E_FILE_FORMAT = -29;
8.1.7.1.10.1.19 NResult.E_FILE_LOAD Field

Error loading module from file. Java public static final int E_FILE_LOAD = -22;
8.1.7.1.10.1.20 NResult.E_FILE_NOT_FOUND Field

File not found. Java public static final int E_FILE_NOT_FOUND = -21;
8.1.7.1.10.1.21 NResult.E_FORMAT Field

Argument format is invalid. Java public static final int E_FORMAT = -13;
8.1.7.1.10.1.22 NResult.E_INDEX_OUT_OF_RANGE Field

Access with index was out of range. Java public static final int E_INDEX_OUT_OF_RANGE = -9;
8.1.7.1.10.1.23 NResult.E_INVALID_CAST Field

The cast is invalid. Java public static final int E_INVALID_CAST = -18;
8.1.7.1.10.1.24 NResult.E_INVALID_ENUM_ARGUMENT Field

Argument is an invalid enum value. Java public static final int E_INVALID_ENUM_ARGUMENT = -16;
8.1.7.1.10.1.25 NResult.E_INVALID_OPERATION Field

Attempted to execute operation that is not valid for the object. Java public static final int E_INVALID_OPERATION = -7;
8.1.7.1.10.1.26 NResult.E_IO Field

IO error occurred. Java public static final int E_IO = -14;
8.1.7.1.10.1.27 NResult.E_JVM Field

JVM error occurred. 699
public static final int E_JVM = -97;
8.1.7.1.10.1.28 NResult.E_MAC Field

MacOS error occurred. Java public static final int E_MAC = -95;
8.1.7.1.10.1.29 NResult.E_NOT_ACTIVATED Field

Operation is not activated. Java public static final int E_NOT_ACTIVATED = -200;
8.1.7.1.10.1.30 NResult.E_NOT_IMPLEMENTED Field

Operation is not implemented. Java public static final int E_NOT_IMPLEMENTED = -5;
8.1.7.1.10.1.31 NResult.E_NOT_SUPPORTED Field

Operation is not supported. Java public static final int E_NOT_SUPPORTED = -6;
8.1.7.1.10.1.32 NResult.E_NULL_REFERENCE Field

Attempted to reference a NULL object. Java public static final int E_NULL_REFERENCE = -3;
8.1.7.1.10.1.33 NResult.E_OUT_OF_MEMORY Field

Out of memory. Java public static final int E_OUT_OF_MEMORY = -4;
8.1.7.1.10.1.34 NResult.E_OVERFLOW Field

Overflow occurred. Java public static final int E_OVERFLOW = -8;
8.1.7.1.10.1.35 NResult.E_PARAMETER Field

Invalid parameter Id. Java public static final int E_PARAMETER = -100;
8.1.7.1.10.1.36 NResult.E_PARAMETER_READ_ONLY Field

Attempted to set read-only parameter. Java public static final int E_PARAMETER_READ_ONLY = -101; 700
8.1 Java Reference
8.1.7.1.10.1.37 NResult.E_PATH_TOO_LONG Field

Path is too long. Java public static final int E_PATH_TOO_LONG = -23;
8.1.7.1.10.1.38 NResult.E_SECURITY Field

Security error occurred. Java public static final int E_SECURITY = -24;
8.1.7.1.10.1.39 NResult.E_SOCKET Field

Socket error occurred. Java public static final int E_SOCKET = -31;
8.1.7.1.10.1.40 NResult.E_SYS Field

Sys error occurred. Java public static final int E_SYS = -94;
8.1.7.1.10.1.41 NResult.E_TARGET_INVOCATION Field

Error during target invocation. Java public static final int E_TARGET_INVOCATION = -29;
8.1.7.1.10.1.42 NResult.E_TIMEOUT Field

Operation timed out. Java public static final int E_TIMEOUT = -30;
8.1.7.1.10.1.43 NResult.E_WIN32 Field

Win32 error occurred. Java public static final int E_WIN32 = -91;
8.1.7.1.10.1.44 NResult.OK Field

No error. Java public static final int OK = 0;
8.1.7.1.10.2 NResult Methods

8.1.7.1.10.2.1 NResult.check Method
Checks if the result of a function indicates that an error has occurred and if so throws an exception. Java public static int check(int result); 701
8.1 Java Reference Parameters Parameters int result Returns result
Description int representing function's result
8.1.7.1.10.2.2 NResult.checkAll Method

Checks whether the specified throwable throws all runtime exceptions. Java public static void checkAll(Throwable th); Parameters Parameters Throwable th Description The throwable specified.
8.1.7.1.10.2.3 NResult.checkIO Method

Checks whether the specified throwable throws an Input/Output exception Java public static Throwable checkIO(Throwable th) throws IOException; Parameters Parameters The Returns The throwable that throws the exception. Description throwable specified.
8.1.7.1.10.2.4 NResult.checkNet Method

Checks whether the specified throwable throws a socket exception. Java public static Throwable checkNet(Throwable th) throws SocketException; Parameters Parameters Throwable th Returns The throwable that throws the exception. Description The throwable specified.
8.1.7.1.10.2.5 NResult.checkTimeout Method

Checks whether the specified throwable throws a timeout exception. Java public static Throwable checkTimeout(Throwable th) throws TimeoutException; Parameters Parameters Throwable th Description The throwable specified.
702
8.1 Java Reference Returns The throwable that throws the exception.
8.1.7.1.10.2.6 NResult.checkUnchecked Method

Checks what throwable produces the specified result. Java public static Throwable checkUnchecked(int result); Parameters Parameters int result Returns The throwable that throws the exception. Description
8.1.7.1.10.2.7 NResult.getError Method

For internal use only. Java public static Throwable getError(int error, HNObject hError);
8.1.7.1.10.2.8 NResult.isFailed Method

Checks if the result of a function indicates that an error has occurred. Java public static boolean isFailed(int result); Parameters Parameters int result Returns True if an error has occurred, false otherwise. Description int representing function's result
8.1.7.1.10.2.9 NResult.isSucceeded Method

Checks if the result of a function indicates that no error has occurred. Java public static boolean isSucceeded(int result); Parameters Parameters int result Returns True if no error has occurred, false otherwise. Description int representing function's result
8.1.7.1.10.2.10 NResult.setLastError Method

For internal use only. Java public static int setLastError(Throwable error);
703
8.1 Java Reference
8.1.7.1.10.2.11 NResult.suppressError Method

For internal use only. Java public static void suppressError(Throwable error);
8.1.7.1.11 ParameterException Class

This type of exception appears when trying to perform unsupported operation with the parameter. Java public class ParameterException extends NeurotecExceptionBase; File ParameterException.java Methods Name ParameterException ( 704) see page Description Initializes a new instance of ParameterException class.
8.1.7.1.11.1 ParameterException Constructor

8.1.7.1.11.1.1 ParameterException.ParameterException Constructor ()
Initializes a new instance of ParameterException class. Java public ParameterException();
8.1.7.1.11.1.2 ParameterException.ParameterException Constructor (String)

Initializes a new instance of ParameterException class. Java public ParameterException(String message); Parameters Parameters String message Description The error message.
8.1.7.1.11.1.3 ParameterException.ParameterException Constructor (String, Throwable)

Initializes a new instance of ParameterException class. Java public ParameterException(String message, Throwable cause); Parameters Parameters String message Throwable cause Description The error message. Cause of the exception.
8.1.7.1.12 ParameterReadOnlyException Class

This type of exception appears when trying to change parameter's value that is read only.
704
public final class ParameterReadOnlyException extends ParameterException; File ParameterReadOnlyException.java Methods Name ParameterException ( 704) ParameterReadOnlyException Class Name ParameterReadOnlyException ( see page 705) Description Initializes a new instance of ParameterReadOnlyException. see page Description Initializes a new instance of ParameterException class.
8.1.7.1.12.1 ParameterReadOnlyException Constructor

8.1.7.1.12.1.1 ParameterReadOnlyException.ParameterReadOnlyException Constructor ()
Initializes a new instance of ParameterReadOnlyException. Java public ParameterReadOnlyException();
8.1.7.1.12.1.2 ParameterReadOnlyException.ParameterReadOnlyException Constructor (String)

Initializes a new instance of ParameterReadOnlyException. Java public ParameterReadOnlyException(String message); Parameters Parameters String message Description The error message.
8.1.7.1.12.1.3 ParameterReadOnlyException.ParameterReadOnlyException Constructor (String, Throwable)

Initializes a new instance of ParameterReadOnlyException. Java public ParameterReadOnlyException(String message, Throwable cause); Parameters Parameters String message Throwable cause Description The error message. Cause of the exception.
8.1.7.2 Interfaces
8.1.7.2.1 NDisposable Interface
Provides a method to release allocated resources. Java public interface NDisposable; 705
8.1 Java Reference File NDisposable.java
com.neurotec.licensing Package
8.1.8 com.neurotec.licensing Package

Provides functionality for getting, releasing licenses. Module Java Reference ( Classes Name NLicense ( see page 706) see page 712) see page 713) see page Description This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. Manages licensing services. see page 59)
NLicenseInfo ( NLicensing (
NLicensingService ( 714)
8.1.8.1 Classes
8.1.8.1.1 NLicense Class
This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. Java public final class NLicense; File NLicense.java NLicense Methods Name activateOnline ( see page 707) Description Activates specified Id (that was obtained through calling GenerateId method or using ActivationWizardDotNet) and obtains license file for this Id via internet. Deactivates specified license via internet. Deactivates specified license via internet using specified deactivation Id. Generates deactivation Id for specified provided product on current computer. Generates deactivation Id for specified license on current computer. Generates Id for activation from serial number for a particular machine. Retrieves license information of specified product. see page Retrieves license information of specified component.
deactivateOnline (
deactivateOnlineWithID ( page 707) generateDeactivationID ( page 708)
generateDeactivationIDForLicense ( see page 708) generateID ( getInfo ( see page 709) see page 709)
getInfoForComponent ( 710) isComponentActivated ( 710)
8
see page Checks if component specified by name is activated.
706
8.1 Java Reference nativeTypeOf ( obtain (
Retrieves a function that retrieves NType object for the enclosing type. Obtains license. Obtains license. Releases license. Releases license.
see page 710)
obtainComponents ( 711) release ( releaseComponents ( 712)
8.1.8.1.1.1 NLicense Methods

8.1.8.1.1.1.1 NLicense.activateOnline Method
Activates specified Id (that was obtained through calling GenerateId method or using ActivationWizardDotNet) and obtains license file for this Id via internet. Java public static String activateOnline(String id) throws IOException; Parameters Parameters String id Returns String containing activated license data. throw IOException Description Id generated from serial number.
8.1.8.1.1.1.2 deactivateOnline Method 8.1.8.1.1.1.2.1 NLicense.deactivateOnline Method (String)

Deactivates specified license via internet. Java public static void deactivateOnline(String license) throws IOException; Parameters Parameters String license Description String that contains activated license name.
8.1.8.1.1.1.2.2 NLicense.deactivateOnline Method (String, String)

Deactivates specified license via internet. Java public static void deactivateOnline(String idGenPath, String license) throws IOException; Parameters Parameters String idGenPath String license Description Path to Id generator program. String that contains activated license name.
8.1.8.1.1.1.3 NLicense.deactivateOnlineWithID Method

Deactivates specified license via internet using specified deactivation Id. Java public static void deactivateOnlineWithID(String license, String deactivationID) throws IOException;
707
8.1 Java Reference Parameters Parameters String license String deactivationID
Description String that contains activated license name. Deactivation Id.
8.1.8.1.1.1.4 generateDeactivationID Method 8.1.8.1.1.1.4.1 NLicense.generateDeactivationID Method (String)

Generates deactivation Id for specified provided product on current computer. Java public static String generateDeactivationID(String productName) throws IOException; Parameters Parameters String productName Returns Generated deactivation Id. Description Long product name (i.e. Face Extractor, Finger Matcher and etc.).
8.1.8.1.1.1.4.2 NLicense.generateDeactivationID Method (String, String)

Generates deactivation Id for specified provided product on current computer. Java public static String generateDeactivationID(String idGenPath, String productName) throws IOException; Parameters Parameters String idGenPath String productName Returns Generated deactivation Id. Description Path to Id generator program. Long product name (i.e. Face Extractor, Finger Matcher and etc.).
8.1.8.1.1.1.5 generateDeactivationIDForLicense Method 8.1.8.1.1.1.5.1 NLicense.generateDeactivationIDForLicense Method (String)

Generates deactivation Id for specified license on current computer. Java public static String generateDeactivationIDForLicense(String license) throws IOException; Parameters Parameters String license Returns Generated deactivation Id. Description License to be deactivated.
708
8.1 Java Reference
8.1.8.1.1.1.5.2 NLicense.generateDeactivationIDForLicense Method (String, String)

Generates deactivation Id for specified license on current computer. Java public static String generateDeactivationIDForLicense(String idGenPath, String license) throws IOException; Parameters Parameters String idGenPath String license Returns Generated deactivation Id. Description Path to Id generator program. License to be deactivated.
8.1.8.1.1.1.6 generateID Method 8.1.8.1.1.1.6.1 NLicense.generateID Method (String)

Generates Id for activation from serial number for a particular machine. Java public static String generateID(String serialNumber) throws IOException; Parameters Parameters String serialNumber Returns Generated Id. Description Serial number used for generating Id.
8.1.8.1.1.1.6.2 NLicense.generateID Method (String, String)

Generates Id for activation from serial number for a particular machine. Java public static String generateID(String idGenPath, String serialNumber) throws IOException; Parameters Parameters String idGenPath String serialNumber Returns Generated Id. Description Path to Id generator program. Serial number used for generating Id.
8.1.8.1.1.1.7 NLicense.getInfo Method

Retrieves license information of specified product. Java public static NLicenseInfo getInfo(String product) throws IOException; Parameters Parameters String product Description String that contains name of a product to retrieve license information 709
8.1 Java Reference Returns NLicenseInfo (
see page 712) object that contains properties for retrieving license information.
8.1.8.1.1.1.8 NLicense.getInfoForComponent Method

Retrieves license information of specified component. Java public static NLicenseInfo getInfoForComponent(String component) throws IOException; Parameters Parameters String component Returns NLicenseInfo ( see page 712) object that contains properties for retrieving license information. Description String that contains name of a component to retrieve license information.
8.1.8.1.1.1.9 NLicense.isComponentActivated Method

Checks if component specified by name is activated. Java public static boolean isComponentActivated(String name) throws IOException; Parameters Parameters String name Returns Bool value indicating if the specified component was activated. Description String which contains component name.
8.1.8.1.1.1.10 NLicense.nativeTypeOf Method

8.1.8.1.1.1.11 obtain Method 8.1.8.1.1.1.11.1 NLicense.obtain Method (String, String, String)

Obtains license. Java public static boolean obtain(String address, String port, String products) throws IOException; Parameters Parameters String address Description Server address where license manager is installed as a server. "/local" is used for this parameter when license is tied with the computer using serial number. License manager server port. 710
String port
8.1 Java Reference String products Returns
String which contains license name.
Returns true if license available; otherwise, false.
8.1.8.1.1.1.11.2 NLicense.obtain Method (String, int, String)

Obtains license. Java public static boolean obtain(String address, int port, String products) throws IOException; Parameters Parameters String address Description Server address where license manager is installed as a server. "/local" is used for this parameter when license is tied with the computer using serial number. License manager server port. String which contains license name.
int port String products Returns Returns true if license available; otherwise, false.
8.1.8.1.1.1.12 obtainComponents Method 8.1.8.1.1.1.12.1 NLicense.obtainComponents Method (String, String, String)

Obtains license. Java public static boolean obtainComponents(String address, String port, String components) throws IOException; Parameters Parameters String address Description Server address where license manager is installed as a server. "/local" is used for this parameter when license is tied with the computer using serial number. License manager server port. String which contains license name.
String port String components Returns Returns true if license available; otherwise, false.
8.1.8.1.1.1.12.2 NLicense.obtainComponents Method (String, int, String)

Obtains component license from the specified server. Java public static boolean obtainComponents(String address, int port, String components) throws IOException; Parameters Parameters String address Description Server address where license manager is installed as a server. "/local" is used for this parameter when license is tied with the computer using serial number. License manager server port (String value). 711
int port
8.1 Java Reference String components Returns
String which contains component license name.
Returns true if component license available; otherwise, false.
8.1.8.1.1.1.13 NLicense.release Method

Releases license. Java public static void release(String products) throws IOException; Parameters Parameters String products Description Name of a product to release its license.
8.1.8.1.1.1.14 NLicense.releaseComponents Method

Releases license. Java public static void releaseComponents(String components) throws IOException; Parameters Parameters String components Remarks This method should be called as many times as method obtainComponents ( see page 711) was called. Description Name of a component to release ( license. see page 712) its
8.1.8.1.2 NLicenseInfo Class

This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. Java public final class NLicenseInfo; File NLicenseInfo.java Methods Name NLicenseInfo ( NLicenseInfo Fields Name distributorId ( obtained ( serialNumber ( see page 713) see page 713) see page 713) Description Distributor id. True if license is obtained; otherwise, false. Serial number. see page 712) Description Initializes a new instance of the NLicenseInfo class.
8.1.8.1.2.1 NLicenseInfo.NLicenseInfo Constructor

Initializes a new instance of the NLicenseInfo class. Java public NLicenseInfo(); 712
8.1 Java Reference
8.1.8.1.2.2 NLicenseInfo Fields

8.1.8.1.2.2.1 NLicenseInfo.distributorId Field
Distributor id. Java public int distributorId;
8.1.8.1.2.2.2 NLicenseInfo.obtained Field

True if license is obtained; otherwise, false. Java public boolean obtained;
8.1.8.1.2.2.3 NLicenseInfo.serialNumber Field

Serial number. Java public int serialNumber;
8.1.8.1.3 NLicensing Class

This class supports internal Neurotechnology libraries infrastructure and should not be used directly in your code. Java public final class NLicensing; File NLicensing.java NLicensing Fields Name DLL_NAME ( see page 713) see page NATIVE_LIBRARY ( 713) NLicensing Methods Name nativeModuleOf ( see page 714) Description Retrieves a function that retrieves NModule object for the enclosing module. Description Name of DLL containing unmanaged part of this component. The object incapsulating the native library.
8.1.8.1.3.1 NLicensing Fields

8.1.8.1.3.1.1 NLicensing.DLL_NAME Field
Name of DLL containing unmanaged part of this component. Java public static final String DLL_NAME = "NLicensing";
8.1.8.1.3.1.2 NLicensing.NATIVE_LIBRARY Field

713
8.1 Java Reference
8.1.8.1.3.2 NLicensing Methods

8.1.8.1.3.2.1 NLicensing.nativeModuleOf Method
8.1.8.1.4 NLicensingService Class

Manages licensing services. Java public final class NLicensingService; File NLicensingService.java NLicensingService Methods Name getBinPath ( getConfPath ( getStatus ( install ( isTrial ( start ( stop ( see page 714) see page 714) see page 715) Description Gets the binary path to the license. Gets the installation configuration. Gets the status of the licensing service. Installs the license. Checks whether the license is trial. Retrieves a function that retrieves NType object for the enclosing type. Starts the licensing service. Stops the licensing service. Uninstalls the license.
nativeTypeOf (
uninstall (
8.1.8.1.4.1 NLicensingService Methods

8.1.8.1.4.1.1 NLicensingService.getBinPath Method
Gets the binary path to the license. Java public static String getBinPath(); Returns The binary path to the license.
8.1.8.1.4.1.2 NLicensingService.getConfPath Method

Gets the installation configuration. Java public static String getConfPath(); Returns The installation configuration.
714
8.1 Java Reference
8.1.8.1.4.1.3 NLicensingService.getStatus Method

Gets the status of the licensing service. Java public static NLicensingServiceStatus getStatus(); Returns NLicensingServiceStatus object.
8.1.8.1.4.1.4 install Method 8.1.8.1.4.1.4.1 NLicensingService.install Method (String)

Installs the license. Java public static void install(String binPath) throws IOException; Parameters Parameters String binPath Description Path to the license.
8.1.8.1.4.1.4.2 NLicensingService.install Method (String, String)

Installs the license. Java public static void install(String binPath, String confPath) throws IOException; Parameters Parameters String binPath String confPath Description Path to the license. Path to configuration file.
8.1.8.1.4.1.5 NLicensingService.isTrial Method

Checks whether the license is trial. Java public static boolean isTrial(); Returns true if the license is trial; else false.
8.1.8.1.4.1.6 NLicensingService.nativeTypeOf Method

8.1.8.1.4.1.7 NLicensingService.start Method

Starts the licensing service.
715
8.1 Java Reference Java public static void start();
com.neurotec.media Package
8.1.8.1.4.1.8 NLicensingService.stop Method

Stops the licensing service. Java public static void stop();
8.1.8.1.4.1.9 NLicensingService.uninstall Method

Uninstalls the license. Java public static void uninstall();
8.1.9 com.neurotec.media Package

Provides functionality for working with various type of media items: images, audio and video. Module Java Reference ( Classes Name NMedia ( see page 716) see page 717) see page 718) see page 726) see page 731) NMediaFormat ( NMediaReader ( NMediaSource ( NVideoFormat ( Description Provides information about NMedia library. Provides methods to retrieve information about media formats. Provides methods which can be used to read media data. Provides methods for working with media source. Class represents video format. Each video source supports one or more video formats. Video format is used to decode (encode) video stream and extract (encode) each video frame. see page 59)
8.1.9.1 Classes
8.1.9.1.1 NMedia Class
Provides information about NMedia library. Java public final class NMedia; File NMedia.java NMedia Fields Name DLL_NAME ( see page 717) see page NATIVE_LIBRARY ( 717) Description Name of DLL containing unmanaged part of this component. The object incapsulating the native library.
716
8.1 Java Reference NMedia Methods Name nativeModuleOf (
Description see page 717) Retrieves a function that retrieves NModule object for the enclosing module.
8.1.9.1.1.1 NMedia Fields

8.1.9.1.1.1.1 NMedia.DLL_NAME Field
Name of DLL containing unmanaged part of this component. Java public static final String DLL_NAME = "NMedia";
8.1.9.1.1.1.2 NMedia.NATIVE_LIBRARY Field

8.1.9.1.1.2 NMedia Methods

8.1.9.1.1.2.1 NMedia.nativeModuleOf Method
8.1.9.1.2 NMediaFormat Class

Provides methods to retrieve information about media formats. Java public class NMediaFormat extends NObject implements Cloneable; File NMediaFormat.java NMediaFormat Methods Name getMediaSubtype ( getMediaType ( nativeTypeOf ( isCompatibleWith ( setMediaSubtype ( see page 718) see page 718) Description see page 717) Gets media subtype from/for specified media format. Gets media type from/for specified NMediaFormat. Retrieves a function that retrieves NType object for the enclosing type. see page 718) Checks if media format is compatible with other media format. see page 718) Sets media subtype from/for specified media format.
8.1.9.1.2.1 NMediaFormat Methods

8.1.9.1.2.1.1 NMediaFormat.getMediaSubtype Method
Gets media subtype from/for specified media format.
717
public final int getMediaSubtype(); Returns Subtype constant to set.
8.1.9.1.2.1.2 NMediaFormat.getMediaType Method

Gets media type from/for specified NMediaFormat ( Java public final NMediaType getMediaType(); Returns One of media type values. At the moment only Audio and Video can be used. see page 717).
8.1.9.1.2.1.3 NMediaFormat.isCompatibleWith Method

Checks if media format is compatible with other media format. Java public final boolean isCompatibleWith(NMediaFormat other); Parameters Parameters Other Returns True if both media formats are compatible. Otherwise, False. Description media format to check if it is compatible with the first one.
8.1.9.1.2.1.4 NMediaFormat.nativeTypeOf Method

8.1.9.1.2.1.5 NMediaFormat.setMediaSubtype Method

Sets media subtype from/for specified media format. Java public final void setMediaSubtype(int value); Parameters Parameters int value Description Media subtype from/for specified media format.
8.1.9.1.3 NMediaReader Class

Provides methods which can be used to read media data. Java public final class NMediaReader extends NObject;
718
8.1 Java Reference File NMediaReader.java Methods Name NMediaReader ( NMediaReader Classes Name ReadResult ( NMediaReader Methods Name getLength ( getPosition ( getSource ( getState ( isLive ( pause ( see page 724) see page 724) see page 724) see page 725)
Description see page 719) Creates new instance of NMediaReader.
Description see page 723) Bean that contains NMediaReader results.
Description Gets file length when NMediaReader source is file. Gets NMediaReader position in media source (file). Gets media source (file or device) of the NMediaReader. Gets NMediaReader state. Checks if media source which is used by NMediaReader is live. Retrieves a function that retrieves NType object for the enclosing type. Pauses specified NMediaReader.
nativeTypeOf (
readAudioSample ( readVideoSample ( setPosition ( start ( stop (
see page 725) Reads audio sample to NSoundBuffer. see page 725) Reads video sample using NMediaReader. Sets NMediaReader position in media source (file). Starts NMediaReader. Stops NMediaReader.
see page 726)
8.1.9.1.3.1 NMediaReader Constructor

8.1.9.1.3.1.1 NMediaReader.NMediaReader Constructor (NMediaSource, EnumSet<NMediaType>, boolean)
Creates new instance of NMediaReader. Java public NMediaReader(NMediaSource source, EnumSet<NMediaType> mediaTypes, boolean isLive); Parameters Parameters NMediaSource source EnumSet<NMediaType> mediaTypes boolean isLive Description Media source from which NMediaReader will be created. Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files.
8.1.9.1.3.1.2 NMediaReader.NMediaReader Constructor (NMediaSource, EnumSet<NMediaType>, boolean, int)

Creates new instance of NMediaReader. 719
public NMediaReader(NMediaSource source, EnumSet<NMediaType> mediaTypes, boolean isLive, int flags); Parameters Parameters NMediaSource source EnumSet<NMediaType> mediaTypes boolean isLive Description Media source from which NMediaReader will be created. Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files. Flags controlling NMediaReader. These flags can be used (for flags parameter): FlagDoNotUseDirectShow FlagDoNotUseWindowsMediaFoundation FlagPreferDirectShow These flags work only on Windows OS.
int flags
8.1.9.1.3.1.3 NMediaReader.NMediaReader Constructor (String, EnumSet<NMediaType>, boolean)

Creates new instance of NMediaReader from specified file. Java public NMediaReader(String fileName, EnumSet<NMediaType> mediaTypes, boolean isLive) throws IOException; Parameters Parameters String fileName EnumSet<NMediaType> mediaTypes boolean isLive Description File name. The specified file should contain media source. Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files.
8.1.9.1.3.1.4 NMediaReader.NMediaReader Constructor (String, EnumSet<NMediaType>, boolean, boolean)

Creates new instance of NMediaReader from specified file or Url. Java public NMediaReader(String fileNameOrUrl, EnumSet<NMediaType> mediaTypes, boolean isLive, boolean isUrl) throws IOException;
720
8.1 Java Reference Parameters Parameters String fileNameOrUrl EnumSet<NMediaType> mediaTypes boolean isLive
Description String representation of file name or URL. The specified file should contain media source. Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files. Flag indicating if media source is from Url (IP camera).
boolean isUrl
8.1.9.1.3.1.5 NMediaReader.NMediaReader Constructor (String, EnumSet<NMediaType>, boolean, boolean, int)

Creates new instance of NMediaReader from specified file or Url. Java public NMediaReader(String fileNameOrUrl, EnumSet<NMediaType> mediaTypes, boolean isLive, boolean isUrl, int flags) throws IOException; Parameters Parameters String fileNameOrUrl EnumSet<NMediaType> mediaTypes boolean isLive Description String representation of file name or URL. The specified file should contain media source. Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files. Flag indicating if media source is from Url (IP camera). Flags controlling NMediaReader. These flags can be used (for flags parameter): FlagDoNotUseDirectShow FlagDoNotUseWindowsMediaFoundation FlagPreferDirectShow These flags work only on Windows OS.
boolean isUrl int flags
8.1.9.1.3.1.6 NMediaReader.NMediaReader Constructor (String, EnumSet<NMediaType>, boolean, int)

Creates new instance of NMediaReader from specified file. Java public NMediaReader(String fileName, EnumSet<NMediaType> mediaTypes, boolean isLive, int flags) throws IOException; 721
8.1 Java Reference Parameters Parameters String fileName EnumSet<NMediaType> mediaTypes boolean isLive
Description File name. The specified file should contain media source. Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files. Flags controlling NMediaReader. These flags can be used (for flags parameter): FlagDoNotUseDirectShow FlagDoNotUseWindowsMediaFoundation FlagPreferDirectShow These flags work only on Windows OS.
int flags
8.1.9.1.3.1.7 NMediaReader.NMediaReader Constructor (URI, EnumSet<NMediaType>, boolean)

Creates new instance of NMediaReader from specified Url. Java public NMediaReader(URI url, EnumSet<NMediaType> mediaTypes, boolean isLive) throws IOException; Parameters Parameters URI url EnumSet<NMediaType> mediaTypes boolean isLive Description Uniform resource identifier (URI) which contains URL address (address of IP camera). Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files.
8.1.9.1.3.1.8 NMediaReader.NMediaReader Constructor (URI, EnumSet<NMediaType>, boolean, int)

Creates new instance of NMediaReader from specified Url. Java public NMediaReader(URI url, EnumSet<NMediaType> mediaTypes, boolean isLive, int flags) throws IOException;
722
8.1 Java Reference Parameters Parameters URI url EnumSet<NMediaType> mediaTypes boolean isLive
Description Uniform resource identifier (URI) which contains URL address (address of IP camera). Media types supported by NMediaReader. Can be Audio and Video (only one at a time or both). Flag indicating if media source is live. If set to true media from source will be read in real time (from devices). In this case video or audio samples will be dropped until user calls ReadAudioSample or ReadVideoSample functions. If user calls these functions too quickly they are blocked until new video frame or audio sample appears. If set to false video frames or audio samples are not dropped and user can read them in any speed (gets all samples/frames). When set to false, NMediaReader works only with video/audio data saved in files. Flags controlling NMediaReader. These flags can be used (for flags parameter): FlagDoNotUseDirectShow FlagDoNotUseWindowsMediaFoundation FlagPreferDirectShow These flags work only on Windows OS.
int flags
8.1.9.1.3.2 NMediaReader Classes

8.1.9.1.3.2.1 NMediaReader.ReadResult Class
Bean that contains NMediaReader ( Java public static final class ReadResult; File NMediaReader.java ReadResult Methods Name getDuration ( getImage ( see page 723) see page 724) see page 724) see page 724) Description Gets Video sample duration (100ns units). Gets NImage which contains video sample (frame). Gets NSoundBuffer which contains audio sample. Gets Time stamp (from the beginning). 100ns units. see page 718) results.
getSoundBuffer ( getTimeStamp (
8.1.9.1.3.2.1.1 ReadResult Methods 8.1.9.1.3.2.1.1.1 NMediaReader.ReadResult.getDuration Method

Gets Video sample duration (100ns units). Java public long getDuration(); Returns Video sample duration (100ns units).
723
8.1 Java Reference
8.1.9.1.3.2.1.1.2 NMediaReader.ReadResult.getImage Method

Gets NImage which contains video sample (frame). Java public NImage getImage(); Returns NImage which contains video sample (frame).
8.1.9.1.3.2.1.1.3 NMediaReader.ReadResult.getSoundBuffer Method

Gets NSoundBuffer which contains audio sample. Java public NSoundBuffer getSoundBuffer(); Returns NSoundBuffer which contains audio sample.
8.1.9.1.3.2.1.1.4 NMediaReader.ReadResult.getTimeStamp Method

Gets Time stamp (from the beginning). 100ns units. Java public long getTimeStamp(); Returns Time stamp (from the beginning). 100ns units.
8.1.9.1.3.3 NMediaReader Methods

8.1.9.1.3.3.1 NMediaReader.getLength Method
Gets file length when NMediaReader ( Java public long getLength(); Returns Time interval (TimeSpan) representing file length. see page 718) source is file.
8.1.9.1.3.3.2 NMediaReader.getPosition Method

Gets NMediaReader ( Java public long getPosition(); Returns Time interval (TimeSpan) representing NMediaReader ( see page 718) position in media source. see page 718) position in media source (file).
8.1.9.1.3.3.3 NMediaReader.getSource Method

Gets media source (file or device) of the NMediaReader ( Java public NMediaSource getSource(); see page 718).
724
Media source which type is NMediaSource (
see page 726).
8.1.9.1.3.3.4 NMediaReader.getState Method

Gets NMediaReader ( Java public NMediaState getState(); Returns One of NMediaState values. see page 718) state.
8.1.9.1.3.3.5 NMediaReader.isLive Method

Checks if media source which is used by NMediaReader ( Java public boolean isLive(); Returns true if media source is live; false otherwise. see page 718) is live.
8.1.9.1.3.3.6 NMediaReader.nativeTypeOf Method

8.1.9.1.3.3.7 NMediaReader.pause Method

Pauses specified NMediaReader ( Java public void pause(); see page 718).
8.1.9.1.3.3.8 NMediaReader.readAudioSample Method

Reads audio sample to NSoundBuffer. Java public ReadResult readAudioSample(); Returns NMediaReaderResult which contains audio sample sound buffer. Before using this method user should start ( see page 726) NMediaReader ( see page 718) using NMediaReader.start ( see page 726) method. For more information on how to use this method see ReadAudio and ReadAudioFromDevice tutorials.
8.1.9.1.3.3.9 NMediaReader.readVideoSample Method

Reads video sample using NMediaReader ( Java public ReadResult readVideoSample(); 725 see page 718).
NMediaReaderResult which contains video sample (frame), timespan and duration. Before using this method user should start ( see page 726) NMediaReader ( see page 718) using NMediaReader.start ( see page 726) method. For more information on how to use this method see ReadAudio and ReadAudioFromDevice tutorials.
8.1.9.1.3.3.10 NMediaReader.setPosition Method

Sets NMediaReader ( Java public void setPosition(long value); Parameters Parameters long value Description Time interval (TimeSpan) representing NMediaReader ( see page 718) position in media source. see page 718) position in media source (file).
8.1.9.1.3.3.11 NMediaReader.start Method

Starts NMediaReader ( Java public void start(); see page 718).
8.1.9.1.3.3.12 NMediaReader.stop Method

Stops NMediaReader ( Java public void stop(); see page 718).
8.1.9.1.4 NMediaSource Class

Provides methods for working with media source. Java public final class NMediaSource extends NObject implements Cloneable; File NMediaSource.java NMediaSource Fields Name FLAG_ALLOW_DUPLICATE_DEVICES ( see page 727) Description This field is used to allow enumerating duplicate devices. If this field was set and the same device is accessible through DirectShow and Windows Media Foundation (Windows 7) then this device will be enumerated twice. Used when user prefers not to use DirecShow for NMediaSource.
FLAG_DO_NOT_USE_DIRECT_SHOW (
see page 727)
FLAG_DO_NOT_USE_WINDOWS_MEDIA_FOUNDATION Used when user prefers not to use Windows ( see page 727) Media Foundation for NMediaSource. FLAG_PREFER_DIRECT_SHOW ( see page 727) Used when user prefers to use DirectShow for NMediaSource.
726
8.1 Java Reference NMediaSource Methods Name enumDevices ( fromFile ( fromUrl (
Description see page 727) Enumerates all source devices by specified media type. Creates NMediaSource from specified file. Creates NMediaSource from specified URL. Gets display name of specified media source. Gets media source formats. Gets the ID of the current media source. Gets media type of specified media source. Retrieves a function that retrieves NType object for the enclosing type. see page 728) see page 729) see page 730)
getCurrentFormat ( getDisplayName ( getFormats ( getId (
see page 730) Gets media source format for specified media type.
see page 730)
getMediaType ( nativeTypeOf (
setCurrentFormat (
see page 731) Sets media source format for specified media type.
8.1.9.1.4.1 NMediaSource Fields

8.1.9.1.4.1.1 NMediaSource.FLAG_ALLOW_DUPLICATE_DEVICES Field
This field is used to allow enumerating duplicate devices. If this field was set and the same device is accessible through DirectShow and Windows Media Foundation (Windows 7) then this device will be enumerated twice. Java public static final int FLAG_ALLOW_DUPLICATE_DEVICES = 0x00000008;
8.1.9.1.4.1.2 NMediaSource.FLAG_DO_NOT_USE_DIRECT_SHOW Field

Used when user prefers not to use DirecShow for NMediaSource ( Java public static final int FLAG_DO_NOT_USE_DIRECT_SHOW = 0x00000001; see page 726).
8.1.9.1.4.1.3 NMediaSource.FLAG_DO_NOT_USE_WINDOWS_MEDIA_FOUNDATION Field

Used when user prefers not to use Windows Media Foundation for NMediaSource ( Java public static final int FLAG_DO_NOT_USE_WINDOWS_MEDIA_FOUNDATION = 0x00000002; see page 726).
8.1.9.1.4.1.4 NMediaSource.FLAG_PREFER_DIRECT_SHOW Field

Used when user prefers to use DirectShow for NMediaSource ( Java public static final int FLAG_PREFER_DIRECT_SHOW = 0x00000004; see page 726).
8.1.9.1.4.2 NMediaSource Methods

8.1.9.1.4.2.1 enumDevices Method 8.1.9.1.4.2.1.1 NMediaSource.enumDevices Method (EnumSet<NMediaType>)
Enumerates all source devices by specified media type. Java public static NMediaSource enumDevices(EnumSet<NMediaType> mediaType);
727
8.1 Java Reference Parameters Parameters EnumSet<NMediaType> mediaType Returns Devices array of NMediaSource (
Description Device media type.
see page 726) type.
8.1.9.1.4.2.1.2 NMediaSource.enumDevices Method (EnumSet<NMediaType>, int)

Enumerates all source devices by specified media type. Java public static NMediaSource enumDevices(EnumSet<NMediaType> mediaType, int flags); Parameters Parameters EnumSet<NMediaType> mediaType int flags Returns Devices array of NMediaSource ( see page 726) type. Description Device media type. Flags controlling NMediaSource ( see page 726).
8.1.9.1.4.2.2 fromFile Method 8.1.9.1.4.2.2.1 NMediaSource.fromFile Method (String)

Creates NMediaSource ( Java public static NMediaSource fromFile(String fileName) throws IOException; Parameters Parameters String fileName Returns Media source from file. Description String containing file name. see page 726) from specified file.
8.1.9.1.4.2.2.2 NMediaSource.fromFile Method (String, int)

Creates NMediaSource ( Java public static NMediaSource fromFile(String fileName, int flags) throws IOException; Parameters Parameters String fileName int flags Returns Media source from file. Notes these flags work only on Windows OS. Description String containing file name. Flags controlling NMediaSource ( see page 726). see page 726) from specified file.
728
8.1 Java Reference
8.1.9.1.4.2.3 fromUrl Method 8.1.9.1.4.2.3.1 NMediaSource.fromUrl Method (String)

Creates NMediaSource ( Java public static NMediaSource fromUrl(String fileName) throws IOException; Parameters Parameters String fileName Returns Media source from file. Description String containing URL. see page 726) from specified URL.
8.1.9.1.4.2.3.2 NMediaSource.fromUrl Method (String, int)

Creates NMediaSource ( Java public static NMediaSource fromUrl(String url, int flags) throws IOException; Parameters Parameters String url int flags Returns Media source from file. Description String containing URL. Flags controlling NMediaSource ( see page 726). see page 726) from specified URL.
8.1.9.1.4.2.3.3 NMediaSource.fromUrl Method (URI)

Creates NMediaSource ( Java public static NMediaSource fromUrl(URI url) throws IOException; Parameters Parameters URI url Returns Media source from file. Description URI containing URL. see page 726) from specified URL.
8.1.9.1.4.2.3.4 NMediaSource.fromUrl Method (URI, int)

Creates NMediaSource ( Java public static NMediaSource fromUrl(URI url, int flags) throws IOException; Parameters Parameters URI url int flags Description URI containing URL. Flags controlling NMediaSource ( see page 726). see page 726) from specified URL.
729
8.1 Java Reference Returns Media source from file.
8.1.9.1.4.2.4 NMediaSource.getCurrentFormat Method

Gets media source format for specified media type. Java public NMediaFormat getCurrentFormat(NMediaType mediaType); Parameters Parameters NMediaType mediaType Returns NMediaFormat ( see page 717) which defines format of current media source. Description Media type to retrieve its format.
8.1.9.1.4.2.5 NMediaSource.getDisplayName Method

Gets display name of specified media source. Java public String getDisplayName(); Returns Zero terminated string containing media source display name.
8.1.9.1.4.2.6 NMediaSource.getFormats Method

Gets media source formats. Java public NMediaFormat getFormats(NMediaType mediaType); Parameters Parameters NMediaType mediaType Returns An array of formats. Description Media type to retrieve its formats.
8.1.9.1.4.2.7 NMediaSource.getId Method

Gets the ID of the current media source. Java public String getId(); Returns A string contain the ID.
8.1.9.1.4.2.8 NMediaSource.getMediaType Method

Gets media type of specified media source. Java public EnumSet<NMediaType> getMediaType();
730
NMediaType which contains the type of current media source.
8.1.9.1.4.2.9 NMediaSource.nativeTypeOf Method

8.1.9.1.4.2.10 NMediaSource.setCurrentFormat Method

Sets media source format for specified media type. Java public void setCurrentFormat(NMediaType mediaType, NMediaFormat format); Parameters Parameters NMediaType mediaType NMediaFormat format Description Media type for which format should be set. Media format to set.
8.1.9.1.5 NVideoFormat Class

Class represents video format. Each video source supports one or more video formats. Video format is used to decode (encode) video stream and extract (encode) each video frame. Java public final class NVideoFormat extends NMediaFormat; File NVideoFormat.java Methods NVideoFormat Class Name NVideoFormat ( NVideoFormat Fields NVideoFormat Class Name AI44 ( AYUV ( DV25 ( DV50 ( DVC ( DVH1 ( DVHD ( DVSD ( see page 733) see page 733) see page 733) see page 734) see page 734) see page 734) see page 734) see page 734) see page 734) ARGB32 ( Description Value for video format AI44. Value for video format RGB, 32 bpp with alpha channel. Value for video format AYUV. Value for video format DVCPRO 25 (525-60 or 625-50). Value for video format DVCPRO 50 (525-60 or 625-50). Value for video format DVC/DV Video. Value for video format DVC ( see page 734)/DV Video. Value for video format HD-DVCR (1125-60 or 1250-50). Value for video format SDL-DVCR (525-60 or 625-50). see page 733) Description Default NVideoFormat constructor. NVideoFormat object can be constructed to setup video device in user defined format.
731
8.1 Java Reference DVSL ( DX50 ( H264 ( I420 ( IYUV ( L16 ( L8 ( M4S2 ( MJPG ( MP43 ( MP4S ( MP4V ( MPG1 ( MSS1 ( MSS2 ( NV11 ( NV12 ( P010 ( P016 ( P210 ( P216 ( RGB24 ( RGB32 ( RGB555 ( RGB565 ( RGB8 ( UYVY ( V210 ( V216 ( V410 ( WMV1 ( WMV2 ( WMV3 ( WVC1 ( Y210 ( Y216 ( Y410 ( Y416 ( Y41P ( Y41T ( Y42T ( YUY2 ( YV12 ( YVU9 ( YVYU ( see page 734) see page 734) see page 734) see page 734) see page 735) see page 735) see page 735) see page 735) see page 735) see page 735) see page 735) see page 735) see page 735) see page 736) see page 736) see page 736) see page 736) see page 736) see page 736) see page 736) see page 736) see page 736) see page 736) see page 737) see page 737)
Value for video format SD-DVCR (525-60 or 625-50). Value for video format DX50. Value for video format H.264. Value for video format I420. Value for video format IYUV. Value for video format L16. Value for video format L8. Value for video format MPEG-4 part 2 video. Value for video format Motion JPEG. Value for video format Microsoft MPEG 4 codec version 3. Value for video format ISO MPEG 4 codec version 1. Value for video format MPEG-4 part 2 video. Value for video format MPEG-1 video. Value for video format Windows Media Screen codec version 1. Value for video format Windows Media Video 9 Screen codec. Value for video format NV11. Value for video format NV12. Value for video format P010. Value for video format P016. Value for video format P210. Value for video format P216. Value for video format RGB, 24 bpp. Value for video format RGB, 32 bpp. Value for video format RGB 555, 16 bpp. Value for video format RGB 565, 16 bpp. Value for video format RGB, 8bpp. Value for unknown video format. Value for video format UYVY. Value for video format V210. Value for video format V216. Value for video format V40. Value for video format Windows Media Video codec version 7. Value for video format Windows Media Video 8 codec. Value for video format Windows Media Video 9 codec. Value for video format SMPTE 421M ("VC-1"). Value for video format Y210. Value for video format Y216. Value for video format Y40. Value for video format Y416. Value for video format Y41P. Value for video format Y41T. Value for video format Y42T. Value for video format YUY2. Value for video format YV12. Value for video format YVU9. Value for video format YVYU.
see page 737) see page 737) see page 737) see page 737) see page 737) see page 737) see page 737) see page 738) see page 738) see page 738) see page 738) see page 738) see page 738) see page 738) see page 738) see page 738) see page 738) see page 739) see page 739) see page 739) see page 739)
UNKNOWN (
732
8.1 Java Reference NMediaFormat Methods Name getMediaSubtype ( getMediaType ( nativeTypeOf ( isCompatibleWith ( setMediaSubtype ( NVideoFormat Class Name getFrameRate ( getHeight (
Description see page 717) Gets media subtype from/for specified media format. Gets media type from/for specified NMediaFormat ( see page 717). see page 718) Checks if media format is compatible with other media format. Retrieves a function that retrieves NType object for the enclosing type. see page 718) Sets media subtype from/for specified media format. see page 718) see page 718)
Description see page 739) Gets video format frame rate. Gets video format frame height. Gets video format frame aspect ratio. Gets video format frame width. see page 739) see page
getInterlaceMode (
see page 739) Gets video interlace mode.
getPixelAspectRatio ( 740) getWidth (
see page 740)
mediaSubtypeToString ( 740) nativeTypeOf ( setFrameRate ( setHeight (
see page Creates media subtype representing string. Retrieves a function that retrieves NType object for the enclosing type. Sets video format frame height. Sets video format frame height. Sets video format frame aspect ratio. Sets video format frame width.
setInterlaceMode (
see page 741) Sets video interlace mode.
setPixelAspectRatio ( 741) setWidth (
see page 741)
8.1.9.1.5.1 NVideoFormat.NVideoFormat Constructor

Default NVideoFormat constructor. NVideoFormat object can be constructed to setup video device in user defined format. Java public NVideoFormat();
8.1.9.1.5.2 NVideoFormat Fields

8.1.9.1.5.2.1 NVideoFormat.AI44 Field
Value for video format AI44. Java public static final int AI44 = 0x34344941;
8.1.9.1.5.2.2 NVideoFormat.ARGB32 Field

Value for video format RGB, 32 bpp with alpha channel. Java public static final int ARGB32 = 21;
8.1.9.1.5.2.3 NVideoFormat.AYUV Field

Value for video format AYUV. Java public static final int AYUV = 0x56555941;
733
8.1 Java Reference
8.1.9.1.5.2.4 NVideoFormat.DV25 Field

Value for video format DVCPRO 25 (525-60 or 625-50). Java public static final int DV25 = 0x35327664;
8.1.9.1.5.2.5 NVideoFormat.DV50 Field

Value for video format DVCPRO 50 (525-60 or 625-50). Java public static final int DV50 = 0x30357664;
8.1.9.1.5.2.6 NVideoFormat.DVC Field

Value for video format DVC/DV Video. Java public static final int DVC = 0x20637664;
8.1.9.1.5.2.7 NVideoFormat.DVH1 Field

Value for video format DVC ( Java public static final int DVH1 = 0x31687664; see page 734)/DV Video.
8.1.9.1.5.2.8 NVideoFormat.DVHD Field

Value for video format HD-DVCR (1125-60 or 1250-50). Java public static final int DVHD = 0x64687664;
8.1.9.1.5.2.9 NVideoFormat.DVSD Field

Value for video format SDL-DVCR (525-60 or 625-50). Java public static final int DVSD = 0x64737664;
8.1.9.1.5.2.10 NVideoFormat.DVSL Field

Value for video format SD-DVCR (525-60 or 625-50). Java public static final int DVSL = 0x6C737664;
8.1.9.1.5.2.11 NVideoFormat.DX50 Field

Value for video format DX50. Java public static final int DX50 = 0x30355844;
8.1.9.1.5.2.12 NVideoFormat.H264 Field

Value for video format H.264. Java public static final int H264 = 0x34363248;
8.1.9.1.5.2.13 NVideoFormat.I420 Field

Value for video format I420. 734
public static final int I420 = 0x30323449;
8.1.9.1.5.2.14 NVideoFormat.IYUV Field

Value for video format IYUV. Java public static final int IYUV = 0x56555949;
8.1.9.1.5.2.15 NVideoFormat.L16 Field

Value for video format L16. Java public static final int L16 = 81;
8.1.9.1.5.2.16 NVideoFormat.L8 Field

Value for video format L8. Java public static final int L8 = 50;
8.1.9.1.5.2.17 NVideoFormat.M4S2 Field

Value for video format MPEG-4 part 2 video. Java public static final int M4S2 = 0x3253344D;
8.1.9.1.5.2.18 NVideoFormat.MJPG Field

Value for video format Motion JPEG. Java public static final int MJPG = 0x47504A4D;
8.1.9.1.5.2.19 NVideoFormat.MP43 Field

Value for video format Microsoft MPEG 4 codec version 3. Java public static final int MP43 = 0x3334504D;
8.1.9.1.5.2.20 NVideoFormat.MP4S Field

Value for video format ISO MPEG 4 codec version 1. Java public static final int MP4S = 0x5334504D;
8.1.9.1.5.2.21 NVideoFormat.MP4V Field

Value for video format MPEG-4 part 2 video. Java public static final int MP4V = 0x5634504D;
8.1.9.1.5.2.22 NVideoFormat.MPG1 Field

Value for video format MPEG-1 video. Java public static final int MPG1 = 0x3147504D; 735
8.1 Java Reference
8.1.9.1.5.2.23 NVideoFormat.MSS1 Field

Value for video format Windows Media Screen codec version 1. Java public static final int MSS1 = 0x3153534D;
8.1.9.1.5.2.24 NVideoFormat.MSS2 Field

Value for video format Windows Media Video 9 Screen codec. Java public static final int MSS2 = 0x3253534D;
8.1.9.1.5.2.25 NVideoFormat.NV11 Field

Value for video format NV11. Java public static final int NV11 = 0x3131564E;
8.1.9.1.5.2.26 NVideoFormat.NV12 Field

Value for video format NV12. Java public static final int NV12 = 0x3231564E;
8.1.9.1.5.2.27 NVideoFormat.P010 Field

Value for video format P010. Java public static final int P010 = 0x30313050;



8.1.9.1.5.2.31 NVideoFormat.RGB24 Field

Value for video format RGB, 24 bpp. Java public static final int RGB24 = 20;

Value for video format RGB, 32 bpp. 736
public static final int RGB32 = 22;

Value for video format RGB 555, 16 bpp. Java public static final int RGB555 = 24;

Value for video format RGB 565, 16 bpp. Java public static final int RGB565 = 23;

Value for video format RGB, 8bpp. Java public static final int RGB8 = 41;
8.1.9.1.5.2.36 NVideoFormat.UNKNOWN Field

Value for unknown video format. Java public static final int UNKNOWN = 0;
8.1.9.1.5.2.37 NVideoFormat.UYVY Field

Value for video format UYVY. Java public static final int UYVY = 0x59565955;
8.1.9.1.5.2.38 NVideoFormat.V210 Field

Value for video format V210. Java public static final int V210 = 0x30313276;


8.1.9.1.5.2.41 NVideoFormat.WMV1 Field

Value for video format Windows Media Video codec version 7. Java public static final int WMV1 = 0x31564D57; 737
8.1 Java Reference

Value for video format Windows Media Video 8 codec. Java public static final int WMV2 = 0x32564D57;

Value for video format Windows Media Video 9 codec. Java public static final int WMV3 = 0x33564D57;
8.1.9.1.5.2.44 NVideoFormat.WVC1 Field

Value for video format SMPTE 421M ("VC-1"). Java public static final int WVC1 = 0x31435657;
8.1.9.1.5.2.45 NVideoFormat.Y210 Field

Value for video format Y210. Java public static final int Y210 = 0x30313259;



8.1.9.1.5.2.49 NVideoFormat.Y41P Field

Value for video format Y41P. Java public static final int Y41P = 0x50313459;
8.1.9.1.5.2.50 NVideoFormat.Y41T Field

Value for video format Y41T. Java public static final int Y41T = 0x54313459;
8.1.9.1.5.2.51 NVideoFormat.Y42T Field

Value for video format Y42T. 738
public static final int Y42T = 0x54323459;
8.1.9.1.5.2.52 NVideoFormat.YUY2 Field

Value for video format YUY2. Java public static final int YUY2 = 0x32595559;
8.1.9.1.5.2.53 NVideoFormat.YV12 Field

Value for video format YV12. Java public static final int YV12 = 0x32315659;
8.1.9.1.5.2.54 NVideoFormat.YVU9 Field

Value for video format YVU9. Java public static final int YVU9 = 0x39555659;
8.1.9.1.5.2.55 NVideoFormat.YVYU Field

Value for video format YVYU. Java public static final int YVYU = 0x55595659;
8.1.9.1.5.3 NVideoFormat Methods

8.1.9.1.5.3.1 NVideoFormat.getFrameRate Method
Gets video format frame rate. Java public NRational getFrameRate(); Returns Value represents video frames per second rate.
8.1.9.1.5.3.2 NVideoFormat.getHeight Method

Gets video format frame height. Java public int getHeight(); Returns Value represents video frame height in pixels.
8.1.9.1.5.3.3 NVideoFormat.getInterlaceMode Method

Gets video interlace mode. Java public NVideoInterlaceMode getInterlaceMode(); Returns Value represents video interlace mode. 739
8.1 Java Reference
8.1.9.1.5.3.4 NVideoFormat.getPixelAspectRatio Method

Gets video format frame aspect ratio. Java public NRational getPixelAspectRatio(); Returns Value represents pixel aspect ratio.
8.1.9.1.5.3.5 NVideoFormat.getWidth Method

Gets video format frame width. Java public int getWidth(); Returns Value represents video frame width in pixels.
8.1.9.1.5.3.6 mediaSubtypeToString Method 8.1.9.1.5.3.6.1 NVideoFormat.mediaSubtypeToString Method (int)

Creates media subtype representing string. Java public String mediaSubtypeToString(int value); Parameters Parameters int value Returns Media subtype representing string. Description Video format value.
8.1.9.1.5.3.6.2 NVideoFormat.mediaSubtypeToString Method (int, String)

Converts media subtype to string. Java public static String mediaSubtypeToString(int value, String format); Parameters Parameters int value String format Returns String which contains subtype string value. Description Subtype value (int). Reserved.
8.1.9.1.5.3.7 NVideoFormat.nativeTypeOf Method

Retrieves a function that retrieves NType object for the enclosing type. Java public static NType nativeTypeOf();
740
com.neurotec.plugins Package
The function that retrieves NType object for the enclosing type.
8.1.9.1.5.3.8 NVideoFormat.setFrameRate Method

Sets video format frame height. Java public void setFrameRate(NRational value); Parameters Parameters NRational value Description Value represents video frames per second rate.
8.1.9.1.5.3.9 NVideoFormat.setHeight Method

Sets video format frame height. Java public void setHeight(int value); Parameters Parameters int value Description Value represents video frame height in pixels.
8.1.9.1.5.3.10 NVideoFormat.setInterlaceMode Method

Sets video interlace mode. Java public void setInterlaceMode(NVideoInterlaceMode value); Parameters Parameters NVideoInterlaceMode value Description Value represents video interlace mode.
8.1.9.1.5.3.11 NVideoFormat.setPixelAspectRatio Method

Sets video format frame aspect ratio. Java public void setPixelAspectRatio(NRational value); Parameters Parameters NRational value Description Value represents pixel aspect ratio.
8.1.9.1.5.3.12 NVideoFormat.setWidth Method

Sets video format frame width. Java public void setWidth(int value); Parameters Parameters int value Description Value represents video frame width in pixels.
741
8.1 Java Reference
8.1.10 com.neurotec.plugins Package

Classes under this package provides plugins management framework for use in other Neurotechnology components. Module Java Reference ( Classes Name NPlugin ( see page 742) see page 745) see page 750) Description Plug-in management framework for use in other Neurotechnology components. Provides functions for working with plugins. Provides methods to retrieve information about plugins. see page 59)
NPluginManager ( NPluginModule (
8.1.10.1 Classes
8.1.10.1.1 NPlugin Class
Plug-in management framework for use in other Neurotechnology components. Java public final class NPlugin extends NObject; File NPlugin.java NPlugin Methods Name addChangeListener ( 743) disable ( enable ( getError ( see page Description Adds user specified listener for any plugin changes event ( 751). Disables NPlugin. Enables NPlugin. Returns the most recent exception of NPlugin. Gets plug ( Gets plug ( see page 744)-in library name. see page 744)-in load time in milliseconds. see page 750) object. see page 744) time in see page
getFileName ( getLoadTime ( getModule ( getOwner ( getPlugTime (
Gets NPluginModule (
Gets the manager of the plugin. Gets plug ( see page 744)-in plug ( milliseconds.
getSelectedInterfaceVersion ( page 744) getState ( plug ( see page 744) see page 744) see nativeTypeOf (
see Gets current version of plugin interface. Gets the state of specified plugin. Retrieves a function that retrieves NType object for the enclosing type. Plugs specified plug-in to the system. Removes user specified listener from any plugin changes event ( page 751). Unplugs specified plug ( see page 744)-in from the system. see
see page 744)
removeChangeListener ( page 745) unplug ( see page 745)
8.1.10.1.1.1 NPlugin Methods

742
8.1 Java Reference
8.1.10.1.1.1.1 NPlugin.addChangeListener Method

Adds user specified listener for any plugin changes event ( Java public void addChangeListener(NChangeListener listener); Parameters Parameters NChangeListener listener Description User specified listener. see page 751).
8.1.10.1.1.1.2 NPlugin.disable Method

Disables NPlugin ( Java public void disable(); see page 742).
8.1.10.1.1.1.3 NPlugin.enable Method

Enables NPlugin ( Java public void enable(); see page 742).
8.1.10.1.1.1.4 NPlugin.getError Method

Returns the most recent exception of NPlugin ( Java public Throwable getError(); Returns The most recent exception from NPlugin ( see page 742). see page 742).
8.1.10.1.1.1.5 NPlugin.getFileName Method

Gets plug ( Java public String getFileName(); Returns String which contains plug ( see page 744)-in file name. see page 744)-in library name.
8.1.10.1.1.1.6 NPlugin.getLoadTime Method

Gets plug ( Java public long getLoadTime(); Returns Type long object which represents load time in milliseconds. see page 744)-in load time in milliseconds.
8.1.10.1.1.1.7 NPlugin.getModule Method

Gets NPluginModule ( Java public NPluginModule getModule(); 743 see page 750) object.
8.1 Java Reference Returns NPluginModule ( see page 750) object.
8.1.10.1.1.1.8 NPlugin.getOwner Method

Gets the manager of the plugin. Java public final NPluginManager getOwner(); Returns NPluginManager ( see page 745) object.
8.1.10.1.1.1.9 NPlugin.getPlugTime Method

Gets plug ( Java public long getPlugTime(); Returns Type long object which represents plug ( see page 744) time in milliseconds. see page 744)-in plug ( see page 744) time in milliseconds.
8.1.10.1.1.1.10 NPlugin.getSelectedInterfaceVersion Method

Gets current version of plugin interface. Java public NVersion getSelectedInterfaceVersion(); Returns NVersion value.
8.1.10.1.1.1.11 NPlugin.getState Method

Gets the state of specified plugin. Java public NPluginState getState(); Returns NPluginState object.
8.1.10.1.1.1.12 NPlugin.nativeTypeOf Method

8.1.10.1.1.1.13 NPlugin.plug Method

Plugs specified plug-in to the system. Java public void plug();
744
8.1 Java Reference
8.1.10.1.1.1.14 NPlugin.removeChangeListener Method

Removes user specified listener from any plugin changes event ( Java public void removeChangeListener(NChangeListener listener); Parameters Parameters NChangeListener listener Description User specified listener. see page 751).
8.1.10.1.1.1.15 NPlugin.unplug Method

Unplugs specified plug ( Java public void unplug(); see page 744)-in from the system.
8.1.10.1.2 NPluginManager Class

Provides functions for working with plugins. Java public final class NPluginManager extends NObject; File NPluginManager.java NPluginManager Classes Name DisabledPluginCollection ( page 746) PluginCollection ( NPluginManager Methods Name addDisabledPluginsChangeListener ( see page 747) addPluginsChangeListener ( page 747) see see Description Adds user specified listener for disabled plugins adding changed event ( see page 751). Adds user specified listener for plugins adding changed event ( page 751). see see Description Represents collection of disabled plugins. Represents collection of plugins.
see page 746)
ensurePluginSearchPerformed ( page 747) getDisabledPlugins ( getInstances (
Checks if initial plugin search was performed and if not calls Refresh. Gets disabled plugins collection. Retrieves an array of NPluginManager instances. Gets NPluginManager interface type name. Returns the range of supported interface versions by specified NPluginManager. Gets collection of all plugins in NPluginManager.
see page 747)
getInterfaceType (
getInterfaceVersions ( getPlugins (
see page 748)
getPluginSearchPath ( isAllowsUnplug ( nativeTypeOf ( plugAll ( refresh (
see page 748) Gets plugins and its dependencies search path. Checks whether PlugAll and UnplugAll methods work. Retrieves a function that retrieves NType object for the enclosing type. Plugs all plugins into the system. Refreshes plugins list.
745
8.1 Java Reference
removeDisabledPluginsChangeListener Removes user specified listener from disabled plugins adding ( see page 749) changed event ( see page 751). removePluginsChangeListener ( page 749) setPluginSearchPath ( unplugAll ( see page 749) see Removes user specified listener from plugins adding changed event ( see page 751). Unplugs all plugins.
see page 749) Sets plugins and its dependencies search path.
8.1.10.1.2.1 NPluginManager Classes

8.1.10.1.2.1.1 NPluginManager.DisabledPluginCollection Class
Represents collection of disabled plugins. Java public final class DisabledPluginCollection extends StringCollection; File NPluginManager.java
8.1.10.1.2.1.2 NPluginManager.PluginCollection Class

Represents collection of plugins. Java public final class PluginCollection extends NObjectReadOnlyCollection<NPlugin>; File NPluginManager.java PluginCollection Methods Name add ( see page 746) Description Adds plugin and its dependencies (if exist) from specified directory.
8.1.10.1.2.1.2.1 PluginCollection Methods 8.1.10.1.2.1.2.1.1 add Method 8.1.10.1.2.1.2.1.1.1 NPluginManager.PluginCollection.add Method (NPluginModule, String)
Adds plugin and its dependencies (if exist) from specified directory. Java public NPlugin add(NPluginModule module, String directory); Parameters Parameters NPluginModule module String directory Returns Added plugin. Description Plugin module. Directory where plugin and its dependencies (if exist) are saved.
8.1.10.1.2.1.2.1.1.2 NPluginManager.PluginCollection.add Method (String)

Adds plugin from user specified file.
746
public NPlugin add(String fileName); Parameters Parameters String fileName Returns Added plugin. Remarks This method automatically searches for additional libraries (specified in fileName) and loads them. Description File name where plugin is saved.
8.1.10.1.2.2 NPluginManager Methods

8.1.10.1.2.2.1 NPluginManager.addDisabledPluginsChangeListener Method
Adds user specified listener for disabled plugins adding changed event ( Java public void addDisabledPluginsChangeListener(NChangeListener listener); Parameters Parameters NChangeListener listener Description User specified listener. see page 751).
8.1.10.1.2.2.2 NPluginManager.addPluginsChangeListener Method

Adds user specified listener for plugins adding changed event ( Java public void addPluginsChangeListener(NPluginsChangeListener listener); Parameters Parameters NPluginsChangeListener listener Description User specified listener. see page 751).
8.1.10.1.2.2.3 NPluginManager.ensurePluginSearchPerformed Method

Checks if initial plugin search was performed and if not calls Refresh. Java public void ensurePluginSearchPerformed();
8.1.10.1.2.2.4 NPluginManager.getDisabledPlugins Method

Gets disabled plugins collection. Java public DisabledPluginCollection getDisabledPlugins(); Returns Disabled plugins collection.
8.1.10.1.2.2.5 NPluginManager.getInstances Method

Retrieves an array of NPluginManager ( see page 745) instances.
747
public static NPluginManager getInstances(); Returns An array of NPLuginManager instances.
8.1.10.1.2.2.6 NPluginManager.getInterfaceType Method

Gets NPluginManager ( Java public String getInterfaceType(); Returns String with NPluginManager ( see page 745) interface name. see page 745) interface type name.
8.1.10.1.2.2.7 NPluginManager.getInterfaceVersions Method

Returns the range of supported interface versions by specified NPluginManager ( Java public NVersionRange getInterfaceVersions(); Returns NVersionRange array with all supported interface version values. see page 745).
8.1.10.1.2.2.8 NPluginManager.getPlugins Method

Gets collection of all plugins in NPluginManager ( Java public PluginCollection getPlugins(); Returns Plugins collection. see page 745).
8.1.10.1.2.2.9 NPluginManager.getPluginSearchPath Method

Gets plugins and its dependencies search path. Java public String getPluginSearchPath(); Returns Plugin search path.
8.1.10.1.2.2.10 NPluginManager.isAllowsUnplug Method

Checks whether PlugAll and UnplugAll methods work. Java public boolean isAllowsUnplug(); Returns Boolean value.
8.1.10.1.2.2.11 NPluginManager.nativeTypeOf Method

748
8.1.10.1.2.2.12 NPluginManager.plugAll Method

Plugs all plugins into the system. Java public void plugAll();
8.1.10.1.2.2.13 NPluginManager.refresh Method

Refreshes plugins list. Java public void refresh();
8.1.10.1.2.2.14 NPluginManager.removeDisabledPluginsChangeListener Method

Removes user specified listener from disabled plugins adding changed event ( Java public void removeDisabledPluginsChangeListener(NChangeListener listener); Parameters Parameters NChangeListener listener Description User specified listener. see page 751).
8.1.10.1.2.2.15 NPluginManager.removePluginsChangeListener Method

Removes user specified listener from plugins adding changed event ( Java public void removePluginsChangeListener(NPluginsChangeListener listener); Parameters Parameters NPluginsChangeListener listener Description User specified listener. see page 751).
8.1.10.1.2.2.16 NPluginManager.setPluginSearchPath Method

Sets plugins and its dependencies search path. Java public void setPluginSearchPath(String value); Parameters Parameters String value Description Plugin search path.
8.1.10.1.2.2.17 NPluginManager.unplugAll Method

Unplugs all plugins. Java public void unplugAll();
749
8.1 Java Reference
8.1.10.1.3 NPluginModule Class

Provides methods to retrieve information about plugins. Java public final class NPluginModule extends NModule; File NPluginModule.java NPluginModule Methods Name getIncompatiblePlugins ( page 750) getInterfaceType ( getInterfaceVersions ( 750) getPluginName ( getPriority ( nativeTypeOf ( see Description Gets the list of incompatible plugins. Gets plugin interface type name. Returns the range of supported interface versions by current NPluginModule object. Gets plugin name. Gets plugin priority over other plugins. Retrieves a function that retrieves NType object for the enclosing type.
see page 751)
8.1.10.1.3.1 NPluginModule Methods

8.1.10.1.3.1.1 NPluginModule.getIncompatiblePlugins Method
Gets the list of incompatible plugins. Java public String getIncompatiblePlugins(); Returns String with incompatible plugin names. Plugin names are separated by semicolons (;).
8.1.10.1.3.1.2 NPluginModule.getInterfaceType Method

Gets plugin interface type name. Java public String getInterfaceType(); Returns Plugin interface type name.
8.1.10.1.3.1.3 NPluginModule.getInterfaceVersions Method

Returns the range of supported interface versions by current NPluginModule ( Java public NVersionRange getInterfaceVersions(); Returns NVersionRange array with all supported interface version values. see page 750) object.
8.1.10.1.3.1.4 NPluginModule.getPluginName Method

Gets plugin name.
750
8.1 Java Reference Java public String getPluginName(); Returns Plugin name.
com.neurotec.plugins.event Package
8.1.10.1.3.1.5 NPluginModule.getPriority Method

Gets plugin priority over other plugins. Java public int getPriority(); Returns Plugin priority over other plugins. Remarks Priority influences plugins adding to the system. If two or more plugins are incompatible or duplicate plugins exist plugin with higher priority will be added to the system. Priority is set during plugin compilation. Default plugin priority is 0.
8.1.10.1.3.1.6 NPluginModule.nativeTypeOf Method

8.1.11 com.neurotec.plugins.event Package

Classes under this package provides methods for working with plugin events. Module Java Reference ( Classes Name NPluginEvent ( Interfaces Name NPluginsChangeListener ( page 752) see Description Event listener for NPluginsChange event. see page 751) Description Structure for handling NPlugin ( see page 742) events. see page 59)
8.1.11.1 Classes
8.1.11.1.1 NPluginEvent Class
Structure for handling NPlugin ( see page 742) events.
751
com.neurotec.plugins.event Package
public class NPluginEvent extends EventObject; File NPluginEvent.java Methods Name NPluginEvent ( NPluginEvent Methods Name getPlugin ( see page 752) Description Retrieves the NPlugin ( see page 742) object. see page 752) Description Initializes a new instance of the ErrorSupressedEvent class.
8.1.11.1.1.1 NPluginEvent.NPluginEvent Constructor

Initializes a new instance of the ErrorSupressedEvent class. Java public NPluginEvent(Object source, NPlugin plugin); Parameters Parameters Object source NPlugin plugin Description Source NPlugin ( see page 742) object.
8.1.11.1.1.2 NPluginEvent Methods

8.1.11.1.1.2.1 NPluginEvent.getPlugin Method
Retrieves the NPlugin ( Java public final NPlugin getPlugin(); Returns NPlugin ( see page 742) object. see page 742) object.
8.1.11.2 Interfaces
8.1.11.2.1 NPluginsChangeListener Interface
Event listener for NPluginsChange event ( Java public interface NPluginsChangeListener extends NChangeListener; File NPluginsChangeListener.java see page 751).
752
Index A
About 1 ANASCIIBinaryRecord class 217 about ANASCIIBinaryRecord class 217 FIELD_DAT 218 FIELD_SRC 218 FIELD_UDF_FROM 219 FIELD_UDF_TO 219 getDate 219 getSourceAgency 220 MAX_QUALITY_METRIC_SCORE 219 MAX_SOURCE_AGENCY_LENGTH 219 MAX_SOURCE_AGENCY_LENGTH_V4 219 MIN_SOURCE_AGENCY_LENGTH 219 nativeTypeOf 220 QUALITY_METRIC_SCORE_FAILED 219 QUALITY_METRIC_SCORE_NOT_AVAILABLE 219 setDate 220 setSourceAgency 220 ANASCIIRecord class 220 about ANASCIIRecord class 220 MAX_FIELD_NUMBER 221 nativeTypeOf 222 ANBinaryRecord class 222 about ANBinaryRecord class 222 nativeTypeOf 223 ANCharset class 223 about ANCharset class 223 ANCharset 223 name 223 version 224 Android Activation 14 ANFAlternateSegment class 224 about ANFAlternateSegment class 224 ANFAlternateSegment 224 ANFAmputation class 224 about ANFAmputation class 224 ANFAmputation 225 type 225
ANFCore class 225 about ANFCore class 225 ANFCore 225 y 226 ANFDelta class 226 about ANFDelta class 226 ANFDelta 226 x 226 y 227 ANField class 227 about ANField class 227 getItems 228 getNumber 228 getSubFields 228 getValue 229 nativeTypeOf 229 setValue 229 ANField.ItemCollection class 227 about ANField.ItemCollection class 227 ANField.SubFieldCollection class 227 about ANField.SubFieldCollection class 227 add 228 ANFImageBinaryRecord class 229 about ANFImageBinaryRecord class 229 FIELD_CA 231 FIELD_FGP 231 FIELD_IMP 232 getImpressionType 232 getPositions 232 MAX_POSITION_COUNT 232 nativeTypeOf 232 setImpressionType 232 ANFImageBinaryRecord.PositionCollection class 231 about ANFImageBinaryRecord.PositionCollection class 231 ANFPatternClass class 233 about ANFPatternClass class 233 ANFPatternClass 233 value 233 vendorValue 233 ANFPImageASCIIBinaryRecord class 234 about ANFPImageASCIIBinaryRecord class 234 FIELD_FGP 239 a
9 FIELD_IMP 239 FIELD_PD 239 FIELD_PPC 239 getImpressionType 239 getPositions 240 getPrintPositions 240 getQualityMetrics 240 MAX_POSITION_COUNT 239 MAX_PRINT_POSITION_COUNT 239 nativeTypeOf 240 setImpressionType 240
score 247 ANFPrintPosition class 247 about ANFPrintPosition class 247 ANFPrintPosition 248 bottom 248 fingerView 248 left 249 right 249 segment 249 top 249 ANFSegment class 249 about ANFSegment class 249 ANFSegment 250 bottom 250 left 250 position 250 right 250 top 250 ANImageASCIIBinaryRecord class 250 about ANImageASCIIBinaryRecord class 250 FIELD_BPX 254 FIELD_CGA 254 FIELD_COM 254 FIELD_CSP 255 FIELD_DMM 255 FIELD_HLL 255 FIELD_HPS 255 FIELD_IQM 255 FIELD_SHPS 255 FIELD_SLC 255 FIELD_SVPS 255 FIELD_VLL 256 FIELD_VPS 256 getBitsPerPixel 258 getColorSpace 258 getComment 258 getCompressionAlgorithm 258 getDeviceMonitoringMode 259 getHorzLineLength 259 getHorzPixelScale 259 getScaleUnits 259 getScanHorzPixelScale 259
ANFPImageASCIIBinaryRecord.PositionCollection class 238 about ANFPImageASCIIBinaryRecord.PositionCollection class 238 ANFPImageASCIIBinaryRecord.PrintPositionCollection class 238 about ANFPImageASCIIBinaryRecord.PrintPositionCollection class 238 ANFPImageASCIIBinaryRecord.QualityMetricCollection class 238 about ANFPImageASCIIBinaryRecord.QualityMetricCollection class 238 ANFPMinutia class 240 about ANFPMinutia class 240 ANFPMinutia 241, 242, 243 getTheta 244 quality 244 setTheta 244 theta 244 type 244 x 244 y 244 ANFPositionDescriptor class 245 about ANFPositionDescriptor class 245 ANFPositionDescriptor 245 portion 245 position 246 ANFPQualityMetric class 246 about ANFPQualityMetric class 246 algorithmProductId 247 algorithmVendorId 247 ANFPQualityMetric 246 position 247
9 getScanVertPixelScale 259 getVendorCompressionAlgorithm 260 getVertLineLength 260 getVertPixelScale 260 MAX_COMMENT_LENGTH 256 MAX_LINE_LENGTH 256 MAX_PIXEL_SCALE 256
about ANIrisImageProperties class 265 ANIrisImageProperties 265 horzOrientation 266 scanType 266 vertOrientation 266 ANNISTQualityMetric class 266 about ANNISTQualityMetric class 266 ANNISTQualityMetric 266, 267 position 267 score 267 ANPenVector class 267 about ANPenVector class 267 ANPenVector 268 pressure 268 x 268 y 268 ANQualityMetric class 268 about ANQualityMetric class 268 algorithmProductId 269 algorithmVendorId 269 ANQualityMetric 269 score 270 ANRecord class 270 about ANRecord class 270 beginUpdate 273 endUpdate 273 FIELD_DATA 272 FIELD_IDC 272 FIELD_LEN 273 FLAG_MERGE_DUBLICATE_FIELDS 273 FLAG_RECOVER_FROM_BINARY_DATA 273 getData 273 getFields 274 getIdc 274 getRecordType 274 isValidated 274 MAX_FIELD_NUMBER 273 MAX_IDC 273 nativeTypeOf 274 setData 275 setIdc 275 size 275
MAX_VENDOR_COMPRESSION_ALGORITHM_LENGT H 256 MIN_LATENT_PIXEL_SCALE_PPCM 256 MIN_LATENT_PIXEL_SCALE_PPI 256 MIN_LATENT_PIXEL_SCALE_V4_PPCM 257 MIN_LATENT_PIXEL_SCALE_V4_PPI 257 MIN_LATENT_SCAN_PIXEL_SCALE_PPCM 257 MIN_LATENT_SCAN_PIXEL_SCALE_PPI 257 MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPCM 257 MIN_LATENT_SCAN_PIXEL_SCALE_V4_PPI 257 MIN_PIXEL_SCALE_PPCM 257 MIN_PIXEL_SCALE_PPI 257 MIN_SCAN_PIXEL_SCALE_PPCM 258 MIN_SCAN_PIXEL_SCALE_PPI 258 MIN_VENDOR_COMPRESSION_ALGORITHM_LENGT H 258 nativeTypeOf 260 setComment 260 setDeviceMonitoringMode 260 setScanHorzPixelScale 261 setScanVertPixelScale 261 toNImage 261 ANImageBinaryRecord class 261 about ANImageBinaryRecord class 261 AN_IMAGE_BINARY_RECORD_FIELD_HLL 263 AN_IMAGE_BINARY_RECORD_FIELD_ISR 263 AN_IMAGE_BINARY_RECORD_FIELD_VLL 263 getHorzLineLength 263 getImageResolution 263 getImageScanResolutionValue 264 getVertLineLength 264 isImageScanResolution 264 nativeTypeOf 264 toNImage 264, 265 ANIrisImageProperties class 265
9 ANRecord.FieldCollection class 271
about ANRecordType.RecordTypeCollection class 276 ANSMT class 283 about ANSMT class 283 ANSMT 284 description 284 source 284 tattooClass 284 tattooSubclass 284 ANSubField class 285 about ANSubField class 285 getItems 285 getValue 285 nativeTypeOf 286 setValue 286 ANSubField.ItemCollection class 285 about ANSubField.ItemCollection class 285 ANTemplate class 286 about ANTemplate class 286 ANTemplate 287, 288, 289, 290 FLAG_LEAVE_INVALID_RECORDS_UNVALIDATED 316 FLAG_USE_NIST_MINUTIA_NEIGHBORS 316 getRecords 317 getValidationLevel 317 getVersion 317 getVersionName 317 getVersions 318 isVersionSupported 318 nativeTypeOf 318 save 318, 319 setVersion 319 toNTemplate 319 VERSION_20 316 VERSION_21 316 VERSION_30 317 VERSION_40 317 VERSION_CURRENT 317 ANTemplate.RecordCollection class 290 about ANTemplate.RecordCollection class 290 add 291 addType10 292, 293 addType13 294, 295 addType14 296, 297 d
about ANRecord.FieldCollection class 271 add 271 contains 272 getByNumber 272 indexOf 272 ANRecordType class 275 about ANRecordType class 275 getDataType 277 getFieldId 277 getFieldName 277 getFieldNumberById 278 getMaxFieldNumber 278 getName 278 getNumber 278 getStandardFieldNumbers 278 getType1 279 getType10 279 getType13 279 getType14 279 getType15 279 getType16 279 getType17 280 getType2 280 getType3 280 getType4 280 getType5 280 getType6 280 getType7 281 getType8 281 getType9 281 getType99 281 getTypeByNumber 281 getTypes 282 getUserDefinedFieldNumbers 282 getVersion 282 isFieldKnown 282 isFieldMandatory 282 isFieldStandard 283 MAX_NUMBER 277 nativeTypeOf 283 ANRecordType.RecordTypeCollection class 276
9 addType15 297, 298 addType16 299, 300 addType17 301, 302 addType2 303 addType3 303, 304 addType4 305, 306 addType5 307, 308 addType6 308, 309, 310 addType7 310, 311 addType8 311, 312, 313 addType9 313, 314, 315 addType99 315, 316 ANType10Record class 320 about ANType10Record class 320 FIELD_COL 330 FIELD_CSP 330 FIELD_FFP 330 FIELD_IMT 330 FIELD_PAS 330 FIELD_PHD 330 FIELD_POA 330 FIELD_POS 330 FIELD_PXS 330 FIELD_SAP 331 FIELD_SEC 331 FIELD_SHC 331 FIELD_SMD 331 FIELD_SMS 331 FIELD_SMT 331 FIELD_SPA 331 FIELD_SQS 331 FIELD_SXS 332 getBaldSubjectHairColor 335 getFacialFeaturePoints 335 getImageType 335 getNCICDesignationCodes 335 getOtherPhotoCharacteristics 335 getPhotoAcquisitionSource 335 getPhotoAttributes 336 getPhotoDate 336 getPhysicalPhotoCharacteristics 336 getPoseOffsetAngle 336
getSMTs 336 getSMTsColors 336 getSubjectAcquisitionProfile 337 getSubjectEyeColor 337 getSubjectFacialAttributes 337 getSubjectFacialCharacteristics 337 getSubjectFacialExpression 337 getSubjectHairColor 337 getSubjectHairColorEx 338 getSubjectPose 338 getSubjectPoseAngles 338 getSubjectPoseAnglesPitch 338 getSubjectPoseAnglesPitchUncertainty 338 getSubjectPoseAnglesRoll 338 getSubjectPoseAnglesRollUncertainty 339 getSubjectPoseAnglesYaw 339 getSubjectPoseAnglesYawUncertainty 339 getSubjectQualityScores 339 getVendorPhotoAcquisitionSource 339 MAX_FACIAL_FEATURE_POINT_COUNT 332 MAX_NCIC_DESIGNATION_CODE_COUNT 332 MAX_NCIC_DESIGNATION_CODE_LENGTH 332 MAX_OTHER_PHOTO_CHARACTERISTIC_LENGTH 332 MAX_PHOTO_DESCRIPTION_COUNT 332 MAX_PHYSICAL_PHOTO_CHARACTERISTIC_LENGTH 332 MAX_QUALITY_METRIC_COUNT 332 MAX_SMT_COUNT 332 MAX_SMT_SIZE 333 MAX_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH 333 MAX_SUBJECT_FACIAL_DESCRIPTION_COUNT 333 MAX_VENDOR_PHOTO_ACQUISITION_SOURCE_LEN GTH 333 MIN_NCIC_DESIGNATION_CODE_LENGTH 333 MIN_SUBJECT_FACIAL_CHARACTERISTIC_LENGTH 333 nativeTypeOf 339 SAP_ANSI_FULL_FRONTAL_FACIAL_IMAGE 333 SAP_ANSI_TOKEN_FACIAL_IMAGE 333 SAP_BPA_LEVEL_30 333 SAP_BPA_LEVEL_40 333 e
9 SAP_BPA_LEVEL_50 334 SAP_BPA_LEVEL_51 334
ANType10Record.SubjectQualityScoreCollection class 329 about ANType10Record.SubjectQualityScoreCollection class 329 ANType13Record class 342 about ANType13Record class 342 FIELD_LCD 348 FIELD_LQM 348 FIELD_SPD 348 getLatentCaptureDate 348 getSearchPositionDescriptors 348 MAX_QUALITY_METRIC_COUNT 348 MAX_SEARCH_POSITION_DESCRIPTOR_COUNT 348 nativeTypeOf 349 setLatentCaptureDate 349 ANType13Record.SearchPositionDescriptorCollection class 347 about ANType13Record.SearchPositionDescriptorCollection class 347 ANType14Record class 349 about ANType14Record class 349 FIELD_AMP 356 FIELD_ASEG 356 FIELD_FCD 356 FIELD_FQM 356 FIELD_NQM 357 FIELD_PPD 357 FIELD_SEG 357 FIELD_SQM 357 getAlternateSegments 358 getAlternateSegmentsVertices 359 getAmputations 359 getFingerprintCaptureDate 359 getNISTQualityMetrics 359 getPrintPositionDescriptor 359 getSegmentationQualityMetrics 359 getSegments 360 MAX_ALTERNATE_SEGMENT_COUNT 357 MAX_ALTERNATE_SEGMENT_VERTEX_COUNT 357 MAX_AMPUTATION_COUNT 357 MAX_NIST_QUALITY_METRIC_COUNT 357 MIN_ALTERNATE_SEGMENT_VERTEX_COUNT 358 nativeTypeOf 360 NIST_QUALITY_METRIC_SCORE_EXCELLENT 358 f
SAP_DRIVERS_LICENSE_IMAGE 334 SAP_ISO_FULL_FRONTAL_FACIAL_IMAGE 334 SAP_ISO_TOKEN_FACIAL_IMAGE 334 SAP_LEGACY_MUGSHOT 334 SAP_PIV_FACIAL_IMAGE 334 SAP_SURVEILLANCE_FACIAL_IMAGE 334 SAP_UNKNOWN 334 setPhotoAcquisitionSource 340 setPhotoAttributes 340 setPhotoDate 340 setPoseOffsetAngle 340 setSubjectAcquisitionProfile 340 setSubjectEyeColor 341 setSubjectFacialAttributes 341 setSubjectFacialExpression 341 setSubjectHairColor 341 setSubjectPose 342 setSubjectPoseAngles 342 ANType10Record.FacialFeaturePointCollection class 327 about ANType10Record.FacialFeaturePointCollection class 327 ANType10Record.NCICDesignationCodeCollection class 327 about ANType10Record.NCICDesignationCodeCollection class 327 ANType10Record.OtherPhotoCharacteristicCollection class 328 about ANType10Record.OtherPhotoCharacteristicCollection class 328 ANType10Record.PhysicalPhotoCharacteristicCollection class 328 about ANType10Record.PhysicalPhotoCharacteristicCollection class 328 ANType10Record.SMTCollection class 328 about ANType10Record.SMTCollection class 328 add 328, 329 ANType10Record.SMTColorsCollection class 329 about ANType10Record.SMTColorsCollection class 329 ANType10Record.SubjectFacialCharacteristicCollection class 329 about ANType10Record.SubjectFacialCharacteristicCollection class 329
NIST_QUALITY_METRIC_SCORE_FAILED 358 NIST_QUALITY_METRIC_SCORE_FAIR 358 NIST_QUALITY_METRIC_SCORE_GOOD 358 NIST_QUALITY_METRIC_SCORE_NOT_AVAILABLE 358 NIST_QUALITY_METRIC_SCORE_POOR 358 NIST_QUALITY_METRIC_SCORE_VERY_GOOD 358 setFingerprintCaptureDate 360 setPrintPositionDescriptor 360 ANType14Record.AlternateSegmentCollection class 355 about ANType14Record.AlternateSegmentCollection class 355 ANType14Record.AlternateSegmentVerticesCollection class 355 about ANType14Record.AlternateSegmentVerticesCollection class 355 ANType14Record.AmputationCollection class 355 about ANType14Record.AmputationCollection class 355 ANType14Record.NISTQualityMetricCollection class 356 about ANType14Record.NISTQualityMetricCollection class 356 ANType14Record.SegmentationQualityMetricCollection class 356 about ANType14Record.SegmentationQualityMetricCollection class 356 ANType14Record.SegmentCollection class 356 about ANType14Record.SegmentCollection class 356 ANType15Record class 360 about ANType15Record class 360 FIELD_PCD 365 FIELD_PLP 365 FIELD_PQM 365 getPalmprintCaptureDate 366 MAX_QUALITY_METRIC_COUNT 366 nativeTypeOf 366 setPalmprintCaptureDate 366 ANType16Record class 366 about ANType16Record class 366 FIELD_UDI 371 FIELD_UQS 371 FIELD_UTD 371 getUserDefinedImage 371 getUserDefinedQualityScore 371 getUserDefinedTestingDate 371
MAX_USER_DEFINED_IMAGE_LENGTH 371 nativeTypeOf 372 setUserDefinedImage 372 setUserDefinedQualityScore 372 setUserDefinedTestingDate 372 ANType17Record class 372 about ANType17Record class 372 FIELD_ALS 378 FIELD_COM 378 FIELD_DUI 378 FIELD_ECL 378 FIELD_FID 378 FIELD_GUI 378 FIELD_ICD 378 FIELD_IPC 379 FIELD_IQS 379 FIELD_IRD 379 FIELD_MMS 379 FIELD_RAE 379 FIELD_RAU 379 FIELD_SHPS 379 FIELD_SVPS 379 getAcquisitionLightingSpectrum 380 getDeviceUniqueIdentifier 380 getEyeColor 380 getFeatureIdentifier 381 getImageProperties 381 getImageQualityScore 381 getIrisCaptureDate 381 getIrisDiameter 381 getMake 381 getModel 382 getRotationAngle 382 getRotationAngleUncertainty 382 getSerialNumber 382 getUuid 382 MAX_IRIS_DIAMETER 380 MAX_MAKE_LENGTH 380 MAX_MODEL_LENGTH 380 MAX_SERIAL_NUMBER_LENGTH 380 nativeTypeOf 382 setAcquisitionLightingSpectrum 383
9 setDeviceUniqueIdentifier 383 setEyeColor 383 setFeatureIdentifier 383 setImageProperties 383 setImageQualityScore 383 setIrisCaptureDate 384 setIrisDiameter 384 setMakeModelSerialNumber 384 setRotationAngle 384 setRotationAngleUncertainty 384 setUuid 385 ANType1Record class 385 about ANType1Record class 385 CHARSET_ASCII 390 CHARSET_LATIN 390 CHARSET_UNICODE 390
getPriority 395 getStandardCharsetDescription 395 getStandardCharsetIndexByName 395 getStandardCharsetIndexes 396 getStandardCharsetName 396 getTransactionControl 396 getTransactionControlReference 396 getTransactionType 397 isCharsetKnown 397 isCharsetStandard 397 isCharsetUserDefined 397 MAX_HIGH_TRANSMITTING_RESOLUTION 392 MAX_LOW_TRANSMITTING_RESOLUTION 392 MAX_PRIORITY 392 MAX_PRIORITY_V3 393 MAX_RESOLUTION 393 MAX_RESOLUTION_V4 393 MAX_TRANSACTION_TYPE_LENGTH_V4 393 MIN_HIGH_TRANSMITTING_RESOLUTION 393 MIN_LOW_TRANSMITTING_RESOLUTION 393 MIN_NATIVE_SCANNING_RESOLUTION 393 MIN_SCANNING_RESOLUTION 393 MIN_TRANSACTION_TYPE_LENGTH_V4 393 nativeTypeOf 398 setDate 398 setDestinationAgency 398 setDomain 398 setGmt 399 setOriginatingAgency 399 setPriority 399 setTransactionControl 399 setTransactionControlReference 399 setTransactionType 399 ANType1Record.CharsetCollection class 389 about ANType1Record.CharsetCollection class 389 add 389 contains 389 ANType2Record class 400 about ANType2Record class 400 FIELD_UDF_FROM 401 FIELD_UDF_TO 401 FIELD_UDF_TO_V4 401
CHARSET_USER_DEFINED_FROM 390 CHARSET_USER_DEFINED_TO 390 CHARSET_UTF_8 390 FIELD_CNT 390 FIELD_DAI 391 FIELD_DAT 391 FIELD_DCS 391 FIELD_DOM 391 FIELD_GMT 391 FIELD_NSR 391 FIELD_NTR 391 FIELD_ORI 391 FIELD_PRY 392 FIELD_TCN 392 FIELD_TCR 392 FIELD_TOT 392 FIELD_VER 392 getCharsets 394 getDate 394 getDestinationAgency 394 getDomainName 394 getDomainVersion 394 getGmt 394 getNativeScanningResolution 395 getNominalTransmittingResolution 395 getOriginatingAgency 395
9 nativeTypeOf 401 ANType3Record class 401 about ANType3Record class 401 FIELD_GCA 404 getUserDefinedQualityScore 404 getVendorCompressionAlgorithm 404 nativeTypeOf 404 ANType4Record class 404 about ANType4Record class 404 FIELD_GCA 406 getUserDefinedQualityScore 406 getVendorCompressionAlgorithm 407 nativeTypeOf 407 ANType5Record class 407 about ANType5Record class 407 FIELD_BCA 409 getUserDefinedQualityScore 409 getVendorCompressionAlgorithm 409 nativeTypeOf 409 ANType6Record class 410 about ANType6Record class 410 FIELD_BCA 412 getUserDefinedQualityScore 412 getVendorCompressionAlgorithm 412 nativeTypeOf 412 ANType7Record class 412 about ANType7Record class 412 FIELD_UDF 413 nativeTypeOf 414 ANType8Record class 414 about ANType8Record class 414 FIELD_SIG 419 FIELD_SRT 419 getPenVectors 419 getSignatureRepresentationType 419 getSignatureType 419 nativeTypeOf 420 setSignatureType 420
FIELD_BCD 422 FIELD_BDB 422 FIELD_BDQ 422 FIELD_BFO 423 FIELD_BFT 423 FIELD_BTY 423 FIELD_HDV 423 getBdbFormatOwner 423 getBdbFormatType 424 getBiometricCreationDate 424 getBiometricDataQuality 424 getBiometricType 424 getHeaderVersion 424 HEADER_VERSION_1_0 423 HEADER_VERSION_1_1 423 nativeTypeOf 424 setBiometricCreationDate 425 setBiometricDataQuality 425 ANType9Record class 425 about ANType9Record class 425 FIELD_ALL_FROM 429 FIELD_ALL_TO 429 FIELD_CRP 429 FIELD_DLT 429 FIELD_FGP 429 FIELD_FMT 430 FIELD_FPC 430 FIELD_IMP 430 FIELD_MIN 430 FIELD_MRC 430 FIELD_OFR 430 FIELD_RDG 430 FIELD_STANDARD_FORMAT_FEATURES_FROM 430 FIELD_STANDARD_FORMAT_FEATURES_TO 430 FIELD_VENDOR_DEFINED_FEATURES_FROM 431 FIELD_VENDOR_DEFINED_FEATURES_TO 431 getCores 432 getDeltas 432 getImpressionType 432 getMinutiae 432 getMinutiaeNeighbors 432 getOFRSEquipment 432
ANType8Record.PenVectorCollection class 419 about ANType8Record.PenVectorCollection class 419 ANType99Record class 420 about ANType99Record class 420
9 getOFRSMethod 433 getOFRSName 433 getPatternClasses 433 getPositions 433 isHasMinutiae 433 isHasMinutiaeRidgeCounts 434
y 437 BDIFFPMinutiaNeighbor class 437 about BDIFFPMinutiaNeighbor class 437 BDIFFPMinutiaNeighbor 437 EMPTY 438 index 438 ridgeCount 438
isHasMinutiaeRidgeCountsIndicator 434 isMinutiaFormat 434 MAX_FINGERPRINT_X 431 MAX_FINGERPRINT_Y 431 MAX_PALMPRINT_X 431 MAX_PALMPRINT_Y 431 MINUTIA_QUALITY_BEST 431 MINUTIA_QUALITY_MANUAL 431 MINUTIA_QUALITY_NOT_AVAILABLE 431 MINUTIA_QUALITY_WORST 431 nativeTypeOf 434 setImpressionType 434 setOFRS 435 toNFRecord 435 ANType9Record.CoreCollection class 428 about ANType9Record.CoreCollection class 428 ANType9Record.DeltaCollection class 428 about ANType9Record.DeltaCollection class 428 ANType9Record.MinutiaCollection class 428 about ANType9Record.MinutiaCollection class 428 ANType9Record.MinutiaNeighborsCollection class 428 about ANType9Record.MinutiaNeighborsCollection class 428 ANType9Record.PatternClassCollection class 428 about ANType9Record.PatternClassCollection class 428 add 429 ANType9Record.PositionCollection class 429 about ANType9Record.PositionCollection class 429 API Reference 58
C
CBEFFBDBFormatIdentifiers class 438 about CBEFFBDBFormatIdentifiers class 438 BIOLOGICA_SISTEMAS_ISO_19794_2_BIOUNISTATIO N 438 BIOLOGICA_SISTEMAS_ISO_19794_4_BIOUNISTATIO N 439 BIOLOGICA_SISTEMAS_ISO_19794_5_BIOUNISTATIO N 439 FEDERAL_OFFICE_FOR_INFORMATION_SECURITY_ TR_BIOMETRICS_XML_FACE_1_0 439 FEDERAL_OFFICE_FOR_INFORMATION_SECURITY_ TR_BIOMETRICS_XML_FINGER_1_0 439 ID3_SEMICONDUCTORS_COMPACT_CARD_EXTENSI ON 439 INCITS_TC_M1_BIOMETRICS_AVI_MEDIA 439 INCITS_TC_M1_BIOMETRICS_BIOMETRIC_FUSION_D ATA 439 INCITS_TC_M1_BIOMETRICS_BMP_IMAGE 439 INCITS_TC_M1_BIOMETRICS_EBTS 440 INCITS_TC_M1_BIOMETRICS_FACE_IMAGE 440 INCITS_TC_M1_BIOMETRICS_FINGER_IMAGE 440 INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_N 440 INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_U 440 INCITS_TC_M1_BIOMETRICS_FINGER_MINUTIAE_X 440
B
BDIFFaceFeaturePoint class 435 about BDIFFaceFeaturePoint class 435 BDIFFaceFeaturePoint 436 code 436 type 437 x 437
INCITS_TC_M1_BIOMETRICS_FINGER_PATTERN_N 440 INCITS_TC_M1_BIOMETRICS_GENERIC_FBI_EFTS_R ECORD 440 INCITS_TC_M1_BIOMETRICS_GIF89A_IMAGE 441 j
INCITS_TC_M1_BIOMETRICS_HAND_GEOMETRY_N 441 INCITS_TC_M1_BIOMETRICS_HAND_GEOMETRY_X 441 INCITS_TC_M1_BIOMETRICS_IRIS_POLAR 441 INCITS_TC_M1_BIOMETRICS_IRIS_RECTILINEAR 441 INCITS_TC_M1_BIOMETRICS_JPEG_IMAGE 441 INCITS_TC_M1_BIOMETRICS_JPEG2000_IMAGE 441 INCITS_TC_M1_BIOMETRICS_MPEG_MEDIA 441 INCITS_TC_M1_BIOMETRICS_MPEG1_PART_3_MEDI A 441 INCITS_TC_M1_BIOMETRICS_NIEM 442 INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE _10_RECORD 442 INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE _13_RECORD 442 INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE _14_RECORD 442 INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE _15_RECORD 442 INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE _16_RECORD 442 INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_2000_TYPE _4_RECORD 442 INCITS_TC_M1_BIOMETRICS_NIST_ITL_1_200X_REC ORD_COLLECTION_FOR_TENPRINT_CAPTURE 443 INCITS_TC_M1_BIOMETRICS_NIST_ITL1_2007_TYPE_ 10_RECORD 443 INCITS_TC_M1_BIOMETRICS_NIST_ITL1_2007_TYPE_ 14_RECORD 443 INCITS_TC_M1_BIOMETRICS_NIST_ITL1_2007_TYPE_ 17_RECORD 443 INCITS_TC_M1_BIOMETRICS_PNG_IMAGE 443 INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_CO MMON_FEATURE_DATA_N 443 INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_CO MMON_FEATURE_DATA_X 444 INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RA W_AND_COMMON_FEATURE_DATA_N 444
INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RA W_AND_COMMON_FEATURE_DATA_X 444 INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RA W_DATA_N 444 INCITS_TC_M1_BIOMETRICS_SIGNATURE_SIGN_RA W_DATA_X 444 INCITS_TC_M1_BIOMETRICS_TIFF_IMAGE 444 INCITS_TC_M1_BIOMETRICS_VRML_3D_OBJECT_DA TA 445 INCITS_TC_M1_BIOMETRICS_WAV_AUDIO 445 INCITS_TC_M1_BIOMETRICS_WSQ_IMAGE 445 ISO_IEC_JTC_1_SC_27_IT_SECURITY_TECHNIQUES_ BIOMETRIC_REFERENCE_TEMPLATE_CERTIFICATE 445 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FACE_IMAGE 445 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_IMAG E 445 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_COMPACT_N 445 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_COMPACT_R_H 446 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_COMPACT_V 446 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_COMPACT_V_H 446 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_NORMAL_N 446 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_NORMAL_R_NH 446 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_NORMAL_V 446 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_CARD_NORMAL_V_NH 447 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_RECORD_N 447 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_MINU TIAE_RECORD_X 447 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATT k
ERN_SKELETAL_DATA_CARD_COMPACT 447 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATT ERN_SKELETAL_DATA_CARD_NORMAL 447 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATT ERN_SKELETAL_DATA_RECORD 447 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATT ERN_SPECTRAL_DISCRETE_FOURIER_TRANSFORM 448 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATT ERN_SPECTRAL_GABOR_FILTER 448 ISO_IEC_JTC_1_SC_37_BIOMETRICS_FINGER_PATT ERN_SPECTRAL_QUANTIZED_CO_SINUSOIDAL_TRIP LET 448 ISO_IEC_JTC_1_SC_37_BIOMETRICS_HAND_GEOME TRY_SILHOUETTE 448 ISO_IEC_JTC_1_SC_37_BIOMETRICS_IRIS_IMAGE_P OLAR 448 ISO_IEC_JTC_1_SC_37_BIOMETRICS_IRIS_IMAGE_R ECTILINEAR 448 ISO_IEC_JTC_1_SC_37_BIOMETRICS_SIGNATURE_SI GN_TIME_SERIES_COMPACT 449 ISO_IEC_JTC_1_SC_37_BIOMETRICS_SIGNATURE_SI GN_TIME_SERIES_FULL 449 ISO_IEC_JTC_1_SC_37_BIOMETRICS_VASCULAR_IM AGE_DATA 449 NEUROTECHNOLOGIJA_NERECORD_1 449 NEUROTECHNOLOGIJA_NLRECORD_3 449 NEUROTECHNOLOGIJA_NTEMPLATE 449 CBEFFBiometricOrganizations class 449 _123ID 453 A_4_VISION 453 about CBEFFBiometricOrganizations class 449 ACSYS_BIOMETRICS 453 ACTIVCARD 453 ANTHEUS_TECHNOLOGY 453 AOPTIX 453 ATMEL 453 AURORA_WIRELESS_TECHNOLOGIES 453 AUTHEN_TEC 454 AWARE 454
BIO_WISE 454 BIOKEY_INTERNATIONAL 454 BIOKEY_INTERNATIONAL_2 454 BIOLINK_TECHNOLOGIES_INTERNATIONAL 454 BIOLOGICA_SISTEMAS 454 BIOSCRYPT 454 BIOVISION 454 COGENT_SYSTEMS 455 CROSS_MATCH_TECHNOLOGIES 455 CRYPTO_METRICS 455 CYBER_SIGN 455 DERMALOG_IDENTIFICATION_SYSTEMS 455 DIGENT 455 DIGITALPERSONA 455 EAST_SHORE_TECHNOLOGIES 455 EASTERN_GOLDEN_FINGER_TECHNOLOGY_BEIJIN G 455 ECRYP 455 FEDERAL_OFFICE_FOR_INFORMATION_SECURITY 456 FINGERPRINT_CARDS 456 FUJITSU 456 GERMAN_INSTITUTE_FOR_STANDARDIZATION 456 GREEN_BIT_AMERICAS 456 GRIAULE_TECNOLOGIA 456 GUARDWARE_SYSTEMS 456 HITACHI 456 HUMANSCAN 456 ID3_SEMICONDUCTORS 457 IDENTIX 457 IDENTIX_2 457 IMAGE_WARE_SYSTEMS 457 INCITS_TC_M1_BIOMETRICS 457 INFINEON_TECHNOLOGIES 457 INNOVATRICS 457 INTERNATIONAL_BIOMETRIC_GROUP 457 INVESTORSHELPERS 457 IRIDIAN_TECHNOLOGIES 458 ISO_IEC_JTC_1_SC_27_IT_SECURITY_TECHNIQUES 458 ISO_IEC_JTC_1_SC_37_BIOMETRICS 458 JANUS_ASSOCIATES 458 LG_ELECTRONICS_USA 458 l
LOGICO_SMARTCARD_SOLUTIONS 458 LUMIDIGM 458 MOTOROLA 458 NEC_SOLUTIONS_AMERICA 458 NEUROTECHNOLOGIJA 458 NIST 459 NITGEN 459 NOT_FOR_USE 459 OMNIPERCEPTION 459 PRECISE_BIOMETRICS 459 PRIVATE 459 RECOGNITION_SYSTEMS 459 SAFLINK 459 SAGEM_MORPHO 459 SECUGEN 460 SECURE_DESIGN 460 SILEX_TECHNOLOGY 460 SONDA_TECHNOLOGIES 460 STARTEK_ENGINEERING 460 SUPREMA 460 TESTING_1 460 TESTING_2 460 THALES_IDENITFICATION 460 ULTRA_SCAN 460 UPEK 461 VALIDITY 461 VERIDICOM 461 VERIDT 461 VIISAGE 461 WARWICK_WARP 461 XTEC 461 com.neurotec.biometrics package 60 com.neurotec.biometrics.standards package 214 com.neurotec.biometrics.tools package 556 com.neurotec.devices package 559 com.neurotec.images package 586 com.neurotec.jna package 659 com.neurotec.lang package 663 com.neurotec.licensing package 706 com.neurotec.media package 716 com.neurotec.plugins package 742 com.neurotec.plugins.event package 751
E
Embedded Face Extractor 7 Embedded Face Matcher 8 Embedded Fingerprint Extractor 7 Embedded Fingerprint Matcher 7 Embedded Voice Extractor 8 Embedded Voice Matcher 8 ErrorCreator class 663 about ErrorCreator class 663 ExternalException class 664 about ExternalException class 664 ExternalException 664, 665 getExternalError 665
F
Face BSS 10 FCRecord class 461 about FCRecord class 461 calculateSize 466 FCRecord 462, 463, 464 FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY 466 getFaceImages 466 getStandard 466 MAX_FACE_IMAGE_COUNT 466 nativeTypeOf 467 FCRecord.FaceImageCollection class 464 about FCRecord.FaceImageCollection class 464 add 464, 465 FCRFaceImage class 467 about FCRFaceImage class 467 calculateSize 469 FLAG_SKIP_FEATURE_POINTS 469 getDeviceType 469 getExpression 470 getEyeColor 470 getFaceImageType 470 getFeaturePoints 470 getGender 470 getHeight 470 getImageColorSpace 471 getImageData 471 m
9 getImageDataType 471 getPoseAnglePitch 471 getPoseAnglePitchRaw 471 getPoseAngleRoll 471 getPoseAngleRollRaw 472 getPoseAngleUncertaintyPitch 472
about FCRFaceImage.FeaturePointCollection class 469 Fingerprint BSS 9 Fingerprint Scanners 11 FIRecord class 479 about FIRecord class 479 calculateSize 485 calculateSizeWithFingers 485 FIRecord 480, 481, 482, 483 FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY 485 getCaptureDeviceId 486 getCBEFFProductId 486 getFingers 486 getFingerViews 486 getHorzImageResolution 486 getHorzScanResolution 486 getImageAcquisitionLevel 487 getImageCompressionAlgorithm 487 getPixelDepth 487 getScaleUnits 487 getStandard 487 getVertImageResolution 487 getVertScanResolution 488 MAX_FACE_IMAGE_COUNT 485 nativeTypeOf 488 setCaptureDeviceId 488 setCBEFFProductId 488 FIRecord.FingerCollection class 483 about FIRecord.FingerCollection class 483 add 483, 484 FIRecord.FingerViewCollection class 485 about FIRecord.FingerViewCollection class 485 FIRFinger class 488 about FIRFinger class 488 calculateSize 491 FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY 490 getFingerViews 491 getPosition 491 MAX_FINGER_VIEW_COUNT 491 nativeTypeOf 491 setPosition 492 FIRFinger.FingerViewCollection class 489 about FIRFinger.FingerViewCollection class 489
getPoseAngleUncertaintyPitchRaw 472 getPoseAngleUncertaintyRoll 472 getPoseAngleUncertaintyRollRaw 472 getPoseAngleYaw 472 getPoseAngleYawRaw 473 getProperties 473 getQuality 473 getSourceType 473 getVendorExpression 473 getVendorImageColorSpace 473 getVendorSourceType 474 getWidth 474 MAX_FEATURE_POINT_COUNT 469 nativeTypeOf 474 poseAngleUncertaintyYaw 474 poseAngleUncertaintyYawRaw 474 setDeviceType 474 setExpression 475 setEyeColor 475 setGender 475 setImageData 476 setPoseAngle 476 setPoseAnglePitch 476 setPoseAnglePitchRaw 476 setPoseAngleRaw 477 setPoseAngleRoll 477 setPoseAngleRollRaw 477 setPoseAngleUncertainty 477 setPoseAngleUncertaintyRaw 477 setPoseAngleYaw 478 setPoseAngleYawRaw 478 setProperties 478 setQuality 478 setSourceType 478, 479 toNImage 479 FCRFaceImage.FeaturePointCollection class 469
9 add 489, 490 FIRFingerView class 492 about FIRFingerView class 492 calculateSize 492 getHorzLineLength 493 getImageData 493 getImageQuality 493 getImpressionType 493 getPosition 493 getVertLineLength 493 getViewCount 494 getViewNumber 494 nativeTypeOf 494 setImageData 494 setImageQuality 495 setImpressionType 495 toNImage 495 FMCard class 495 about FMCard class 495 DEFAULT_MAX_ENROLL_MC 496 DEFAULT_MAX_VERIFY_MC 496 DEFAULT_MIN_ENROLL_MC 496 DEFAULT_MIN_VERIFY_MC 496 nativeTypeOf 497 readCompactSizeMinutiae 497 readNormalSizeMinutiae 498 writeCompactSizeMinutiae 499, 500 writeNormalSizeMinutiae 500, 501 FMCBDTTags class 502 about FMCBDTTags class 502 CELL_QUALITY_DATA 502 CORE_POINT_DATA 502 DELTA_POINT_DATA 502 FINGER_MINUTIAE_DATA 502 RIDGE_COUNT_DATA 502 FMCBITBHTBAPTTags class 503
angle 505 FMRCore 504, 505 getAngle 505 getAnsiAngle 505 getIsoAngle 506 setAngle 506 setAnsiAngle 506 setIsoAngle 506 x 505 y 505 FMRDelta class 506 about FMRDelta class 506 angle1 508 angle2 508 angle3 508 FMRDelta 507, 508 getAngle1 509 getAngle2 509 getAngle3 509 getAnsiAngle1 509 getAnsiAngle2 510 getAnsiAngle3 510 getIsoAngle1 510 getIsoAngle2 510 getIsoAngle3 510 setAngle1 510 setAngle2 511 setAngle3 511 setAnsiAngle1 511 setAnsiAngle2 511 setAnsiAngle3 511 setIsoAngle1 512 setIsoAngle2 512 setIsoAngle3 512 x 508 y 509 FMRecord class 512 about FMRecord class 512 calculateSize 517 calculateSizeWithFingers 518 FLAG_PROCESS_FIRST_FACE_IMAGE_ONLY 517 FMRecord 513, 514, 515, 516
about FMCBITBHTBAPTTags class 503 FEATURE_HANDLING_INDICATOR 503 MINUTIAE_ORDER 503 NUMBER_OF_MINUTIAE 503 FMRCore class 503 about FMRCore class 503
9 getCaptureEquipmentCompliance 518 getCaptureEquipmentId 518 getCBEFFProductId 518 getFingers 518 getFingerViews 518 getResolutionX 519 getResolutionY 519 getSizeX 519 getSizeY 519 getStandard 519 MAX_FACE_IMAGE_COUNT 517 nativeTypeOf 519 setCaptureEquipmentCompliance 520 setCaptureEquipmentId 520 setCBEFFProductId 520 toNFTemplate 520 toNTemplate 521 FMRecord.FingerCollection class 516
getDeltas 527 getFingerQuality 527 getImpressionType 528 getMaxSize 528 getMinutiae 529 getMinutiaeEightNeighbors 529 getMinutiaeFourNeighbors 529 getPosition 529 getViewCount 529 getViewNumber 530 isHasEightNeighborRidgeCounts 530 isHasFourNeighborRidgeCounts 530 MAX_CORE_COUNT 527 MAX_DELTA_COUNT 527 MAX_DIMENSION 527 MAX_MINUTIA_COUNT 527 nativeTypeOf 530 setFingerQuality 530 setHasEightNeighborRidgeCounts 531 setHasFourNeighborRidgeCounts 531 setImpressionType 531 toNFRecord 531 FMRFingerView.CoreCollection class 525 about FMRFingerView.CoreCollection class 525 FMRFingerView.DeltaCollection class 525 about FMRFingerView.DeltaCollection class 525 FMRFingerView.MinutiaCollection class 525 about FMRFingerView.MinutiaCollection class 525 FMRFingerView.MinutiaEightNeighborsCollection class 526 about FMRFingerView.MinutiaEightNeighborsCollection class 526 FMRFingerView.MinutiaFourNeighborsCollection class 526 about FMRFingerView.MinutiaFourNeighborsCollection class 526 FMRMinutia class 532 about FMRMinutia class 532 angle 534 FMRMinutia 532, 533 getAngle 534 getAnsiAngle 534 getIsoAngle 535 quality 534 setAngle 535 p
about FMRecord.FingerCollection class 516 add 516 FMRecord.FingerViewCollection class 517 about FMRecord.FingerViewCollection class 517 FMRFinger class 521 about FMRFinger class 521 calculateSize 523 FLAG_PROCESS_FIRST_FINGER_VIEW_ONLY 523 getFingerViews 523 getPosition 523 MAX_FINGER_VIEW_COUNT 523 nativeTypeOf 523 setPosition 524 FMRFinger.FingerViewCollection class 522 about FMRFinger.FingerViewCollection class 522 add 522 FMRFingerView class 524 about FMRFingerView class 524 FLAG_PROCESS_ALL_EXTENDED_DATA 526 FLAG_SKIP_NEUROTEC_FIELDS 526 FLAG_SKIP_RIDGE_COUNTS 526 FLAG_SKIP_SINGULAR_POINTS 526 FLAG_USE_NEUROTEC_FIELDS 526 getCores 527
9 setAnsiAngle 535 setIsoAngle 535 type 534 x 534 y 534
setIrisBoundaryExtraction 545 setIrisDiameter 546 setIrisHorzOrientation 546 setIrisOcclusionFilling 546 setIrisOcclusions 546 setIrisScanType 546
H
HNObject class 660 about HNObject class 660 HNObject 660
setIrisVertOrientation 547 IIRecord.IrisCollection class 539 about IIRecord.IrisCollection class 539 add 539, 540 IIRecord.IrisImageCollection class 540
I
IIRecord class 535 about IIRecord class 535 calculateSize 541 getCaptureDeviceId 541 getCBEFFProductId 541 getDeviceUniqueIdentifier 541 getGUID 542 getImageFormat 542 getImageTransformation 542 getIntensityDepth 542 getIrisBoundaryExtraction 542 getIrisDiameter 542 getIrises 543 getIrisHorzOrientation 543 getIrisImages 543 getIrisOcclusionFilling 543 getIrisOcclusions 543 getIrisScanType 543 getIrisVertOrientation 544 getRawImageHeight 544 getRawImageWidth 544 getStandard 544 IIRecord 537, 538, 539 MAX_IRIS_IMAGE_COUNT 541 nativeTypeOf 544 setCaptureDeviceId 544 setCBEFFProductId 545 setDeviceUniqueIdentifier 545 setGUID 545 setImageTransformation 545
about IIRecord.IrisImageCollection class 540 IIRIris class 547 about IIRIris class 547 calculateSize 549 FLAG_PROCESS_FIRST_IRIS_IMAGE_ONLY 549 getIrisImages 549 getPosition 550 MAX_IRIS_IMAGE_COUNT 549 nativeTypeOf 550 setPosition 550 IIRIris.IrisImageCollection class 547 about IIRIris.IrisImageCollection class 547 add 548, 549 IIRIrisImage class 550 about IIRIrisImage class 550 calculateSize 551 getImageCount 551 getImageData 551 getImageNumber 552 getPosition 552 getQuality 552 getRotationAngle 552 getRotationAngleRaw 552 getRotationAngleUncertainty 552 getRotationAngleUncertaintyRaw 553 nativeTypeOf 553 setImageData 553 setQuality 553 setRotationAngle 553 setRotationAngleRaw 554 setRotationAngleUncertainty 554
9 setRotationAngleUncertaintyRaw 554 toNImage 554 Installation 3 Iris BSS 10
setSpoofDetection 562 NBiometrics class 63 about NBiometrics class 63 DLL_NAME 63 NATIVE_LIBRARY 63
J
Java Reference 59 Java Samples Compilation 50
nativeModuleOf 63 NBiometricStandards class 555 about NBiometricStandards class 555 DLL_NAME 555
L
Licensing 1
NATIVE_LIBRARY 555 nativeModuleOf 555 NBiometricTools class 556 about NBiometricTools class 556 DLL_NAME 556 NATIVE_LIBRARY 556 nativeModuleOf 557
M
Matching Threshold and FAR/FRR 21
N
NAbstractDisposable class 665 about NAbstractDisposable class 665 dispose 665 isDisposed 666 NativeSize class 660 about NativeSize class 660 NativeSize 661 SIZE 661 NBiometricAttributes class 61 about NBiometricAttributes class 61 getBiometricType 61 getQuality 62 getStatus 62 nativeTypeOf 62 setQuality 62 setStatus 62 NBiometricDevice class 560 about NBiometricDevice class 560 cancel 561 getBiometricType 561 getProductId 561 getVendorId 561 isSpoofDetection 561 isSpoofDetectionSupported 561 nativeTypeOf 562
NBiometricTypes class 63 about NBiometricTypes class 63 isQualityValid 64 PHRASE_ID_UNKNOWN 64 QUALITY_FAILED 64 QUALITY_MAX 64 QUALITY_MIN 64 QUALITY_UNKNOWN 64 NCamera class 562 about NCamera class 562 getFrame 563 nativeTypeOf 563 NCaptureDevice class 563 about NCaptureDevice class 563 addCapturingChangedListener 564 getCurrentFormat 564 getFormats 565 isCapturing 565 nativeTypeOf 565 removeCapturingChangedListener 565 setCurrentFormat 565 startCapturing 565 stopCapturing 566 NCore class 666 about NCore class 666 addErrorSuppressedListener 667
9 addShutdownHook 668 alloc 668 calloc 668, 669 clear 669 compare 669, 670 copy 670 DLL_NAME 667 fill 671 free 671, 672 getByteTypeConstructor 672 getEnumGetMethod 672 getIntTypeConstructor 672 getLongTypeConstructor 673 getObjectFromPointer 673 getObjectsFromPointerArray 673 getPointerForCallback 673 getPointerFreeProc 674 getShortTypeConstructor 674 move 674 NATIVE_LIBRARY 667 nativeModuleOf 675 realloc 675 refPointer 675, 676 removeErrorSuppressedListener 676 removeShutdownHook 676 shutdown 676 shutdownThread 676 STRING_ENCODING 667 toCharArray 676 toDate 677 toNativeDate 677 toString 677 unrefPointer 677 NDevice class 566 about NDevice class 566 getChildren 566 getDeviceType 567 getDisplayName 567 getId 567 getMake 567 getModel 567 getOwner 567
getParent 568 getPlugin 568 getSerialNumber 568 isAvailable 568 isPrivate 568 nativeTypeOf 568 NDevice.ChildCollection class 566 about NDevice.ChildCollection class 566 NDeviceManager class 569 about NDeviceManager class 569 addDevicesChangeListener 571 getDevices 571 getDeviceTypes 572 getPluginManager 572 isAutoUpdate 572 nativeTypeOf 572 NDeviceManager 569, 570 refresh 572 removeDevicesChangeListener 572 NDeviceManager.DeviceCollection class 570 about NDeviceManager.DeviceCollection class 570 get 571 indexOf 571 NDevices class 573 about NDevices class 573 DLL_NAME 573 NATIVE_LIBRARY 573 nativeModuleOf 573 NDisposable interface 705 about NDisposable interface 705 NEAttributes class 65 about NEAttributes class 65 getBoundingRect 65 getImageIndex 66 getPosition 66 nativeTypeOf 66 NEAttributes 65 setBoundingRect 66 setImageIndex 66 NEESegmentationDetails class 67 about NEESegmentationDetails class 67 BOUNDARY_POINT_COUNT 67
9 getInnerBoundaryPoints 68 getOuterBoundaryPoints 68 innerBoundaryAvailable 67 NEESegmentationDetails 67 outerBoundaryAvailable 67 NEExtractor class 68 about NEExtractor class 68 compress 71 extract 71, 72 getInnerBoundaryFrom 72 getInnerBoundaryTo 72 getOuterBoundaryFrom 72 getOuterBoundaryTo 72 getTemplateSize 73 isDeinterlace 73 isUseFlexibleBoundaryModel 73 nativeTypeOf 73 NEExtractor 69 PARAMETER_DEINTERLACE 70
check 77 getCBEFFProductType 77 getHeight 77 getPosition 78 getQuality 78 getSize 79 getWidth 79 nativeTypeOf 79 NERecord 76 setCBEFFProductType 79 setPosition 80 setQuality 80 NError class 678 about NError class 678 get 678 getDefaultMessage 678 getLast 679 getMessage 679 setLast 679 suppress 679 NETemplate class 80 about NETemplate class 80 calculateSize 82 check 82 getRecordCount 82 getRecords 83 getSize 83 MAX_RECORD_COUNT 82 NETemplate 81 PROCESS_FIRST_RECORD_ONLY 82 NETemplate.RecordCollection class 82 about NETemplate.RecordCollection class 82 NeurotecException class 680 about NeurotecException class 680 NFAttributes class 83 about NFAttributes class 83 getImageIndex 84 getImpressionType 84 getPosition 84 nativeTypeOf 84 NFAttributes 84 setImageIndex 85
PARAMETER_INNER_BOUNDARY_FROM 70 PARAMETER_INNER_BOUNDARY_TO 70 PARAMETER_OUTER_BOUNDARY_FROM 71 PARAMETER_OUTER_BOUNDARY_TO 71 PARAMETER_TEMPLATE_SIZE 71 PARAMETER_USE_FLEXIBLE_BOUNDARY_MODEL 71 setDeinterlace 73 setInnerBoundaryFrom 73 setInnerBoundaryTo 74 setOuterBoundaryFrom 74 setOuterBoundaryTo 74 setTemplateSize 74 setUseFlexibleBoundaryModel 74 NEExtractor.ExtractResult class 69 about NEExtractor.ExtractResult class 69 getRecord 70 getSegmentationDetails 70 getStatus 70 NEMatchingDetails class 75 about NEMatchingDetails class 75 nativeTypeOf 75 NERecord class 75 about NERecord class 75
9 NFClassifier class 557 about NFClassifier class 557 classify 558 nativeTypeOf 558 NFClassifier 557 NFClassifier.ClassifyResult class 557
getMinMinutiaCount 100 getMode 100 getQualityThreshold 100 getReturnedImage 100 getTemplateSize 100 isExtractCurvatures 101 isExtractGs 101 isExtractQualities 101 isPalm 101 isTemplateSmall 101 isUseQuality 101 makeLightTemplate 102 makeSmallTemplate 102 MODE_ATMEL_FINGER_CHIP 94 MODE_AUTHENTEC_AES2501B 94 MODE_AUTHENTEC_AES4000 94 MODE_AUTHENTEC_AFS2 94 MODE_BIOMETRIKA_FX2000 95 MODE_BIOMETRIKA_FX3000 95 MODE_BMF_BLP100 95 MODE_CROSS_MATCH_VERIFIER_300 95 MODE_DIGENT_IZZIX 95 MODE_DIGITAL_PERSONA_U_ARE_U 95 MODE_ETHENTICA 95 MODE_FUJITSU_MBF200 95 MODE_FUTRONIC_FS80 95 MODE_GENERAL 96 MODE_IDENTICATOR_TECHNOLOGY_DF90 96 MODE_IDENTIX_DFR2090 96 MODE_IDENTIX_TOUCH_VIEW 96 MODE_KEYTRONIC_SECURE_DESKTOP 96 MODE_LIGHT_TUNING_LTT_C500 96 MODE_NITGEN_FINGKEY_HAMSTER 96 MODE_PRECISE_BIOMETRICS_100CS 96 MODE_SECUGEN_HAMSTER 96 MODE_STARTEK_FM200 96 MODE_TACOMA_CMOS 97 MODE_TESTECH_BIO_I 97 MODE_UPEK_TOUCH_CHIP 97 NFExtractor 94 PARAMETER_EXTRACT_CURVATURES 97 PARAMETER_EXTRACT_GS 97
about NFClassifier.ClassifyResult class 557 getConfidence 558 getPatternClass 558 NFCore class 85 about NFCore class 85 angle 86 getAngle 86 NFCore 85, 86 setAngle 86 x 86 y 86 NFDelta class 87 about NFDelta class 87 angle1 88 angle2 88 angle3 89 getAngle1 89 getAngle2 89 getAngle3 89 NFDelta 87, 88 setAngle1 89 setAngle2 90 setAngle3 90 y 89 NFDoubleCore class 90 about NFDoubleCore class 90 NFDoubleCore 90 y 91 NFExtractor class 91 about NFExtractor class 91 extract 98 generalize 99 getExtractedRidgeCounts 99 getGeneralizationMaximalRotation 99 getGeneralizationMinMinutiaCount 99 getGeneralizationThreshold 100
PARAMETER_EXTRACT_QUALITIES 97 PARAMETER_EXTRACTED_RIDGE_COUNTS 97 PARAMETER_GENERALIZATION_MAXIMAL_ROTATIO N 97 PARAMETER_GENERALIZATION_MIN_MINUTIA_COU NT 97 PARAMETER_GENERALIZATION_THRESHOLD 98 PARAMETER_MIN_MINUTIA_COUNT 98 PARAMETER_MODE 98 PARAMETER_QUALITY_THRESHOLD 98 PARAMETER_RETURNED_IMAGE 98 PARAMETER_TEMPLATE_SIZE 98 PARAMETER_USE_QUALITY 98 setExtractCurvatures 102 setExtractedRidgeCounts 102 setExtractGs 103 setExtractQualities 103 setGeneralizationMaximalRotation 103 setGeneralizationMinMinutiaCount 103 setGeneralizationThreshold 103 setMinMinutiaCount 104 setMode 104 setQualityThreshold 104 setReturnedImage 104 setTemplateSize 104 setUseQuality 105 updateTemplate 105 NFingerScanner class 573 about NFingerScanner class 573 nativeTypeOf 575 NFIQ class 558 about NFIQ class 558 compute 559 nativeTypeOf 559 NFMatchingDetails class 105 about NFMatchingDetails class 105 getCenterX 105 getCenterY 106 getMatedMinutiae 106 getRotation 106 getTranslationX 106 getTranslationY 106
NFMinutia class 106 about NFMinutia class 106 angle 108 curvature 108 g 109 getAngle 109 NFMinutia 107, 108 quality 109 setAngle 109 type 109 y 109 NFMinutiaNeighbor class 110 about NFMinutiaNeighbor class 110 EMPTY 110 NFMinutiaNeighbor 110 ridgeCount 110 NFRecord class 110 about NFRecord class 110 check 118 FLAG_ALLOW_OUT_OF_BOUNDS_FEATURES 116 FLAG_SAVE_BLOCKED_ORIENTS 116 FLAG_SAVE_V1 116 FLAG_SAVE_V2 116 FLAG_SAVE_V3 116 FLAG_SKIP_BLOCKED_ORIENTS 116 FLAG_SKIP_CURVATURES 116 FLAG_SKIP_GS 116 FLAG_SKIP_QUALITIES 116 FLAG_SKIP_RIDGE_COUNTS 117 FLAG_SKIP_SINGULAR_POINTS 117 getCBEFFProductType 118, 119 getCores 119 getDeltas 119 getDoubleCores 119 getG 119, 120 getHeight 120 getHorzResolution 120 getImpressionType 121 getMaxSize 121, 122 getMaxSizeV1 122 getMinutiae 123 getMinutiaeNeighbors 123
9 getMinutiaFormat 123 getPatternClass 123, 124 getPosition 124 getPossiblePositions 124 getQuality 125 getRidgeCountsType 125 getSize 125 getSizeV1 125, 126 getVertResolution 126 getWidth 126 MAX_FINGER_CORE_COUNT 117 MAX_FINGER_DELTA_COUNT 117 MAX_FINGER_DIMENSION 117
NFRecord.MinutiaCollection class 115 about NFRecord.MinutiaCollection class 115 NFRecord.MinutiaNeighborsCollection class 115 about NFRecord.MinutiaNeighborsCollection class 115 NFRecord.PossiblePositionCollection class 115 about NFRecord.PossiblePositionCollection class 115 NFScanner class 575 about NFScanner class 575 addPreviewListener 577 capture 577, 578 getSupportedImpressionTypes 579 getSupportedPositions 579 nativeTypeOf 579 removePreviewListener 579 NFScanner.CaptureResult class 576 about NFScanner.CaptureResult class 576 getImage 576 getObjects 577 getStatus 577 NFTemplate class 130 about NFTemplate class 130 calculateSize 133 check 133 getRecordCount 133 getRecords 134 getSize 134 isPalm 134 MAX_RECORD_COUNT 132 nativeTypeOf 135 NFTemplate 131, 132 PROCESS_FIRST_RECORD_ONLY 132 NFTemplate.RecordCollection class 132 about NFTemplate.RecordCollection class 132 NFunctionMapper class 661 about NFunctionMapper class 661 NGrayscaleImage class 587 about NGrayscaleImage class 587 get 589 nativeTypeOf 589 set 589 NImage class 589 about NImage class 589
MAX_FINGER_DOUBLE_CORE_COUNT 117 MAX_FINGER_MINUTIA_COUNT 117 MAX_PALM_CORE_COUNT 117 MAX_PALM_DELTA_COUNT 117 MAX_PALM_DIMENSION 118 MAX_PALM_DOUBLE_CORE_COUNT 118 MAX_PALM_MINUTIA_COUNT 118 MAX_POSSIBLE_POSITION_COUNT 118 nativeTypeOf 127 NFRecord 113, 114 RESOLUTION 118 saveV1 127, 128 setCBEFFProductType 128 setG 128 setImpressionType 128 setMinutiaFormat 128 setPatternClass 129 setPosition 129 setQuality 129 setRidgeCountsType 129 sortMinutiae 129 truncateMinutiae 130 truncateMinutiaeByQuality 130 NFRecord.CoreCollection class 115 about NFRecord.CoreCollection class 115 NFRecord.DeltaCollection class 115 about NFRecord.DeltaCollection class 115 NFRecord.DoubleCoreCollection class 115 about NFRecord.DoubleCoreCollection class 115
9 copy 592, 593 copyFrom 594, 595, 596 copyTo 596, 597, 598 create 599 crop 600
toImage 622 toMonochrome 622 toRgb 622 NImage.PlaneCollection class 591 about NImage.PlaneCollection class 591 NImageFormat class 622 about NImageFormat class 622 createInfo 623, 624 getBMP 624 getDefaultFileExtension 624 getDefaultInternetMediaType 624 getFileFilter 624 getFormats 625 getIHead 625 getInternetMediaType 625 getJPEG 625 getJPEG2K 625 getName 625 getPNG 626 getTIFF 626 getWSQ 626 isCanRead 626 isCanWrite 626 isCanWriteMultiple 627 nativeTypeOf 627 openReader 627, 628, 629 openWriter 629, 630, 631 select 631 selectByInternetMediaType 631 selectReader 632, 633 NImageFormat.ImageFormatCollection class 623 about NImageFormat.ImageFormatCollection class 623 NImageInfo class 634 about NImageInfo class 634 getFormat 634 nativeTypeOf 634 NImages class 634 about NImages class 634 getGrayscaleColorWrapper 635 getOpenFileFilter 635 getOpenFileFilterString 635 getSaveFileFilter 636
FLAG_DST_ALPHA_CHANNEL_FIRST 591 FLAG_DST_BOTTOM_TO_TOP 591 FLAG_DST_SWAP_CHANNELS 591 FLAG_SRC_ALPHA_CHANNEL_FIRST 591 FLAG_SRC_BOTTOM_TO_TOP 591 FLAG_SRC_SWAP_CHANNELS 592 flipDiagonally 600 flipHorizontally 600 flipVertically 600 fromChannel 600, 601, 602 fromData 602, 603, 604 fromFile 605, 606 fromImage 606, 607 fromInputStream 608, 609 fromMemory 610, 611 getHeight 611 getHorzResolution 612 getImageSize 612 getLongImageSize 612 getLongPlaneSize 612 getLongStride 612 getPixelFormat 613 getPixels 613 getPlanes 613 getPlaneSize 613 getStride 613 getVertResolution 614 getWidth 614 getWrapper 614, 615, 616 isResolutionIsAspectRatio 617 nativeTypeOf 617 rotateFlip 617 save 618, 619, 620 setHorzResolution 621 setResolutionIsAspectRatio 621 setVertResolution 621 toGrayscale 621
9 getSaveFileFilterString 636 nativeTypeOf 636 NIrisScanner class 579 about NIrisScanner class 579 addPreviewListener 582 capture 582, 583 getSupportedPositions 583 nativeTypeOf 583 removePreviewListener 583 NIrisScanner.CaptureResult class 581
reservedConfidence3 138 reservedConfidence4 138 reservedConfidence5 138 reservedConfidence6 138 reservedConfidence7 138 reservedConfidence8 138 reservedConfidence9 138 NLEEyes class 140 about NLEEyes class 140 firstConfidence 141 getFirst 141 getSecond 141 NLEEyes 141 secondConfidence 141 NLEFace class 141 about NLEFace class 141 confidence 142 getRotation 142 NLEFace 142 NLERotation class 142 about NLERotation class 142 NLERotation 143 pitch 143 roll 143 yaw 143 NLExtractor class 143 about NLExtractor class 143 compress 151 detectFace 151 detectFaces 152 detectFacialFeatures 152 extract 152 extractEnd 152 extractNext 153 extractStart 153 extractUsingDetails 153 generalize 153 getFaceConfidenceThreshold 153 getFaceDetectionScaleCount 154 getFaceQualityThreshold 154 getFaceRollAngleBase 154 getGenderConfidenceThreshold 154
about NIrisScanner.CaptureResult class 581 CaptureResult 581 getImage 581 getObjects 581 getStatus 582 NLAttributes class 135 about NLAttributes class 135 nativeTypeOf 135 NLAttributes 135 NLEDetectionDetails class 136 about NLEDetectionDetails class 136 expression 137 expressionConfidence 137 faceAvailable 137 gender 137 genderConfidence 137 getFace 139 getLeftEyeCenter 139 getMouthCenter 139 getNoseTip 139 getPoints 139 getReserved1 139 getReserved2 140 getReserved3 140 getReserved4 140 getRightEyeCenter 140 glassesConfidence 137 NLEDetectionDetails 137 POINT_COUNT 137 properties 138 reservedConfidence1 138 reservedConfidence2 138
9 getLivenessThreshold 154 getMaxIod 155 getMaxRecordsPerTemplate 155 getMaxRollAngleDeviation 155 getMaxStreamDurationInFrames 155 getMaxYawAngleDeviation 155 getMinIod 156 getTemplateSize 156 isDetectAllFeaturePoints 156 isDetectBaseFeaturePoints 156 isDetectGender 156 isDetectMoreFaces 156 isFavorLargestFace 157 isUseLivenessCheck 157 nativeTypeOf 157 NLExtractor 147
setFaceDetectionScaleCount 158 setFaceQualityThreshold 159 setFaceRollAngleBase 159 setFavorLargestFace 159 setGenderConfidenceThreshold 159 setLivenessThreshold 159 setMaxIod 160 setMaxRecordsPerTemplate 160 setMaxRollAngleDeviation 160 setMaxStreamDurationInFrames 160 setMaxYawAngleDeviation 161 setMinIod 161 setTemplateSize 161 setUseLivenessCheck 161 NLExtractor.ExtractResult class 147 about NLExtractor.ExtractResult class 147 getBaseIndex 148 getDetectionDetails 148 getStatus 148 getTemplate 148 NLFeaturePoint class 161 about NLFeaturePoint class 161 code 163 confidence 163 NLFeaturePoint 162 x 163 y 163 NLibrary interface 663 about NLibrary interface 663 NLicense class 706 about NLicense class 706 activateOnline 707 deactivateOnline 707 deactivateOnlineWithID 707 generateDeactivationID 708 generateDeactivationIDForLicense 708, 709 generateID 709 getInfo 709 getInfoForComponent 710 isComponentActivated 710 nativeTypeOf 710 obtain 710, 711
PARAMETER_DETECT_ALL_FEATURE_POINTS 148 PARAMETER_DETECT_BASE_FEATURE_POINTS 148 PARAMETER_DETECT_GENDER 149 PARAMETER_DETECT_MORE_FACES 149 PARAMETER_FACE_CONFIDENCE_THRESHOLD 149 PARAMETER_FACE_DETECTION_SCALE_COUNT 149 PARAMETER_FACE_QUALITY_THRESHOLD 149 PARAMETER_FACE_ROLL_ANGLE_BASE 149 PARAMETER_FAVOR_LARGEST_FACE 149 PARAMETER_GENDER_CONFIDENCE_THRESHOLD 150 PARAMETER_LIVENESS_THRESHOLD 150 PARAMETER_MAX_IOD 150 PARAMETER_MAX_RECORDS_PER_TEMPLATE 150 PARAMETER_MAX_ROLL_ANGLE_DEVIATION 150 PARAMETER_MAX_STREAM_DURATION_IN_FRAMES 150 PARAMETER_MAX_YAW_ANGLE_DEVIATION 150 PARAMETER_MIN_IOD 151 PARAMETER_TEMPLATE_SIZE 151 PARAMETER_USE_LIVENESS_CHECK 151 setDetectAllFeaturePoints 157 setDetectBaseFeaturePoints 157 setDetectGender 158 setDetectMoreFaces 158 setFaceConfidenceThreshold 158
9 obtainComponents 711 release 712 releaseComponents 712 NLicenseInfo class 712 about NLicenseInfo class 712 distributorId 713 NLicenseInfo 712 obtained 713 serialNumber 713 NLicensing class 713 about NLicensing class 713 DLL_NAME 713 NATIVE_LIBRARY 713 nativeModuleOf 714 NLicensingService class 714 about NLicensingService class 714 getBinPath 714 getConfPath 714 getStatus 715 install 715 isTrial 715 nativeTypeOf 715 start 715 stop 716 uninstall 716 NLMatchingDetails class 163 about NLMatchingDetails class 163 nativeTypeOf 163 NLRecord class 163 about NLRecord class 163 check 165 getCBEFFProductType 165 getQuality 166 getSize 166 nativeTypeOf 166 NLRecord 164, 165 setCBEFFProductType 166 setQuality 167 NLTemplate class 167 about NLTemplate class 167 calculateSize 169 check 169
getRecordCount 169 getRecords 169 getSize 170 MAX_RECORD_COUNT 169 nativeTypeOf 170 NLTemplate 168 PROCESS_FIRST_RECORD_ONLY 169 NLTemplate.RecordCollection class 168 about NLTemplate.RecordCollection class 168 NMatcher class 170 about NMatcher class 170 FINGERS_MODE_ATMEL_FINGER_CHIP 175 FINGERS_MODE_AUTHENTEC_AES2501B 175 FINGERS_MODE_AUTHENTEC_AES4000 176 FINGERS_MODE_AUTHENTEC_AFS2 176 FINGERS_MODE_BIOMETRIKA_FX2000 176 FINGERS_MODE_BIOMETRIKA_FX3000 176 FINGERS_MODE_BMF_BLP100 176 FINGERS_MODE_CROSS_MATCH_VERIFIER_300 176 FINGERS_MODE_DIGENT_IZZIX 176 FINGERS_MODE_DIGITAL_PERSONA_U_ARE_U 176 FINGERS_MODE_ETHENTICA 176 FINGERS_MODE_FUJITSU_MBF200 177 FINGERS_MODE_FUTRONIC_FS80 177 FINGERS_MODE_GENERAL 177 FINGERS_MODE_IDENTICATOR_TECHNOLOGY_DF9 0 177 FINGERS_MODE_IDENTIX_DFR2090 177 FINGERS_MODE_IDENTIX_TOUCH_VIEW 177 FINGERS_MODE_KEYTRONIC_SECURE_DESKTOP 177 FINGERS_MODE_LIGH_TUNING_LTTC500 177 FINGERS_MODE_NITGEN_FINGKEY_HAMSTER 177 FINGERS_MODE_PRECISE_BIOMETRICS_100CS 177 FINGERS_MODE_SECUGEN_HAMSTER 178 FINGERS_MODE_STARTEK_FM200 178 FINGERS_MODE_TACOMA_CMOS 178 FINGERS_MODE_TESTECH_BIO_I 178 FINGERS_MODE_UPEK_TOUCH_CHIP 178 getFacesMatchingSpeed 182 getFacesMatchingThreshold 182 getFingersMatchingSpeed 182
aa
9 getFingersMaximalRotation 182 getFingersMinMatchedCount 182
180 PARAMETER_PALMS_MATCHING_SPEED 180 PARAMETER_PALMS_MAXIMAL_ROTATION 180 PARAMETER_PALMS_MIN_MATCHED_COUNT 181 PARAMETER_PALMS_MIN_MATCHED_COUNT_THRE SHOLD 181 PARAMETER_VOICES_UNIQUE_PHRASES_ONLY 181 PART_FACES 181 PART_FINGERS 181 PART_IRISES 181 PART_NONE 181 PART_PALMS 182 prepareTemplate 186 setFacesMatchingSpeed 187 setFacesMatchingThreshold 187 setFingersMatchingSpeed 187 setFingersMaximalRotation 187 setFingersMinMatchedCount 187 setFingersMinMatchedCountThreshold 188 setFingersMode 188 setFusionType 188 setIrisesMatchingSpeed 188 setIrisesMatchingThreshold 188 setIrisesMaximalRotation 189 setIrisesMinMatchedCount 189 setIrisesMinMatchedCountThreshold 189 setMatchingThreshold 189 setPalmsMatchingSpeed 189 setPalmsMaximalRotation 190 setPalmsMinMatchedCount 190 setPalmsMinMatchedCountThreshold 190 setVoicesUniquePhrasesOnly 190 verify 190 verifyWithMD 191 NMatchingDetails class 191 about NMatchingDetails class 191 getFaces 194 getFacesMatchedIndex 194 getFacesScore 195 getFingers 195 getFingersScore 195 getIrises 195 bb
getFingersMinMatchedCountThreshold 183 getFingersMode 183 getFusionType 183 getIrisesMatchingSpeed 183 getIrisesMatchingThreshold 183 getIrisesMaximalRotation 183 getIrisesMinMatchedCount 184 getIrisesMinMatchedCountThreshold 184 getMatchingThreshold 184 getPalmsMatchingSpeed 184 getPalmsMaximalRotation 184 getPalmsMinMatchedCount 184 getPalmsMinMatchedCountThreshold 185 identifyEnd 185 identifyNext 185 identifyStart 186 identifyStartWithMD 186 isVoicesUniquePhrasesOnly 186 nativeTypeOf 186 NMatcher 175 PARAMETER_FACES_MATCHING_SPEED 178 PARAMETER_FACES_MATCHING_THRESHOLD 178 PARAMETER_FINGERS_FILL_FULL_MATCHING_DET AILS 178 PARAMETER_FINGERS_MATCHING_SPEED 179 PARAMETER_FINGERS_MAXIMAL_ROTATION 179 PARAMETER_FINGERS_MIN_MATCHED_COUNT 179 PARAMETER_FINGERS_MIN_MATCHED_COUNT_TH RESHOLD 179 PARAMETER_FINGERS_MODE 179 PARAMETER_FUSION_TYPE 179 PARAMETER_IRISES_MATCHING_SPEED 179 PARAMETER_IRISES_MATCHING_THRESHOLD 179 PARAMETER_IRISES_MAXIMAL_ROTATION 180 PARAMETER_IRISES_MIN_MATCHED_COUNT 180 PARAMETER_IRISES_MIN_MATCHED_COUNT_THRE SHOLD 180 PARAMETER_MATCHING_THRESHOLD 180 PARAMETER_PALMS_FILL_FULL_MATCHING_DETAIL S
9 getIrisesScore 195 getPalms 195 getPalmsScore 196 getVoices 196 getVoicesScore 196 nativeTypeOf 196 NMatchingDetails 192, 193 NMatchingDetails.FaceCollection class 193
NMediaReader 719, 720, 721, 722 pause 725 readAudioSample 725 readVideoSample 725 setPosition 726 start 726 stop 726 NMediaReader.ReadResult class 723 about NMediaReader.ReadResult class 723 getDuration 723 getImage 724 getSoundBuffer 724 getTimeStamp 724 NMediaSource class 726 about NMediaSource class 726 enumDevices 727, 728 FLAG_ALLOW_DUPLICATE_DEVICES 727 FLAG_DO_NOT_USE_DIRECT_SHOW 727 FLAG_DO_NOT_USE_WINDOWS_MEDIA_FOUNDATIO N 727 FLAG_PREFER_DIRECT_SHOW 727 fromFile 728 fromUrl 729 getCurrentFormat 730 getDisplayName 730 getFormats 730 getId 730 getMediaType 730 nativeTypeOf 731 setCurrentFormat 731 NMemory class 661 about NMemory class 661 dispose 662 NMemory 662 NMicrophone class 584 about NMicrophone class 584 getSoundSample 585 nativeTypeOf 585 NModule class 680 about NModule class 680 getActivated 681 getCompany 681 cc
about NMatchingDetails.FaceCollection class 193 NMatchingDetails.FingerCollection class 194 about NMatchingDetails.FingerCollection class 194 NMatchingDetails.IrisCollection class 194 about NMatchingDetails.IrisCollection class 194 NMatchingDetails.PalmCollection class 194 about NMatchingDetails.PalmCollection class 194 NMatchingDetails.VoiceCollection class 194 about NMatchingDetails.VoiceCollection class 194 NMatchingDetailsBase class 196 about NMatchingDetailsBase class 196 getBiometricType 197 getScore 197 nativeTypeOf 197 NMedia class 716 about NMedia class 716 DLL_NAME 717 NATIVE_LIBRARY 717 nativeModuleOf 717 NMediaFormat class 717 about NMediaFormat class 717 getMediaSubtype 717 getMediaType 718 isCompatibleWith 718 nativeTypeOf 718 setMediaSubtype 718 NMediaReader class 718 about NMediaReader class 718 getLength 724 getPosition 724 getSource 724 getState 725 isLive 725 nativeTypeOf 725
9 getCopyright 681 getDependences 682 getLoadedModules 682 getName 682 getOptions 682 getProduct 682 getTitle 682 getVersion 683 nativeTypeOf 683 NObject class 683 about NObject class 683 copyParameters 684 disposeArray 684 FLAG_REF_RET 684 fromHandle 685 getFlags 685 getHandle 685 getNativeType 685 getOwner 686 getParameter 686, 687 getSize 687 getSizeMany 687, 688 nativeTypeOf 688 ref 688 reset 688 save 688, 689, 690 saveMany 690, 691, 692 setParameter 692, 693 toHandle 693 unref 693 unrefArray 694 unrefElements 694 NPalmScanner class 585 about NPalmScanner class 585 nativeTypeOf 586 NPixelFormat class 636 about NPixelFormat class 636 calcRowLongSize 650 calcRowSize 651 getBitsPerPixel 651 getBytesPerPixel 651 getIndexed 652
getNonIndexed 652 getNonSeparated 652 getPaletteSize 652 getPixelType 652 getRowLongSize 653 getRowSize 653 getSeparated 654 getWithExtraChannel 654 GRAYSCALE_16S 641 GRAYSCALE_16U 641 GRAYSCALE_1U 641 GRAYSCALE_2U 641 GRAYSCALE_32F 642 GRAYSCALE_32S 642 GRAYSCALE_32U 642 GRAYSCALE_4U 642 GRAYSCALE_64F 642 GRAYSCALE_64S 642 GRAYSCALE_64U 642 GRAYSCALE_8S 642 GRAYSCALE_8U 643 GRAYSCALE_A_16S 643 GRAYSCALE_A_16U 643 GRAYSCALE_A_32F 643 GRAYSCALE_A_32S 643 GRAYSCALE_A_32U 643 GRAYSCALE_A_64F 643 GRAYSCALE_A_64S 643 GRAYSCALE_A_64U 644 GRAYSCALE_A_8S 644 GRAYSCALE_A_8U 644 GRAYSCALE_PA_16S 644 GRAYSCALE_PA_16U 644 GRAYSCALE_PA_32F 644 GRAYSCALE_PA_32S 644 GRAYSCALE_PA_32U 644 GRAYSCALE_PA_64F 645 GRAYSCALE_PA_64S 645 GRAYSCALE_PA_64U 645 GRAYSCALE_PA_8S 645 GRAYSCALE_PA_8U 645 isValid 654
dd
9 NPixelFormat 640, 641 RGB_16S 645 RGB_16U 645 RGB_32F 645 RGB_32S 646 RGB_32U 646 RGB_64F 646 RGB_64S 646 RGB_64U 646 RGB_8S 646 RGB_8U 646 RGB_8U_INDEXED_1 646 RGB_8U_INDEXED_2 647 RGB_8U_INDEXED_4 647 RGB_8U_INDEXED_8 647 RGB_A_16S 647 RGB_A_16U 647 RGB_A_32F 647 RGB_A_32S 647 RGB_A_32U 647 RGB_A_64F 648 RGB_A_64S 648 RGB_A_64U 648 RGB_A_8S 648 RGB_A_8U 648 RGB_A_8U_INDEXED_1 648 RGB_A_8U_INDEXED_2 648 RGB_A_8U_INDEXED_4 648 RGB_A_8U_INDEXED_8 649 RGB_PA_16S 649 RGB_PA_16U 649 RGB_PA_32F 649 RGB_PA_32S 649 RGB_PA_32U 649 RGB_PA_64F 649 RGB_PA_64S 649 RGB_PA_64U 650 RGB_PA_8S 650 RGB_PA_8U 650 UNDEFINED 650 NPlugin class 742 about NPlugin class 742
addChangeListener 743 disable 743 enable 743 getError 743 getFileName 743 getLoadTime 743 getModule 743 getOwner 744 getPlugTime 744 getSelectedInterfaceVersion 744 getState 744 nativeTypeOf 744 plug 744 removeChangeListener 745 unplug 745 NPluginEvent class 751 about NPluginEvent class 751 getPlugin 752 NPluginEvent 752 NPluginManager class 745 about NPluginManager class 745 addDisabledPluginsChangeListener 747 addPluginsChangeListener 747 ensurePluginSearchPerformed 747 getDisabledPlugins 747 getInstances 747 getInterfaceType 748 getInterfaceVersions 748 getPlugins 748 getPluginSearchPath 748 isAllowsUnplug 748 nativeTypeOf 748 plugAll 749 refresh 749 removeDisabledPluginsChangeListener 749 removePluginsChangeListener 749 setPluginSearchPath 749 unplugAll 749 NPluginManager.DisabledPluginCollection class 746 about NPluginManager.DisabledPluginCollection class 746 NPluginManager.PluginCollection class 746 about NPluginManager.PluginCollection class 746 ee
9 add 746 NPluginModule class 750 about NPluginModule class 750 getIncompatiblePlugins 750 getInterfaceType 750 getInterfaceVersions 750 getPluginName 750 getPriority 751 nativeTypeOf 751 NPluginsChangeListener interface 752
E_FILE_LOAD 699 E_FILE_NOT_FOUND 699 E_FORMAT 699 E_INDEX_OUT_OF_RANGE 699 E_INVALID_CAST 699 E_INVALID_ENUM_ARGUMENT 699 E_INVALID_OPERATION 699 E_IO 699 E_JVM 699 E_MAC 700 E_NOT_ACTIVATED 700 E_NOT_IMPLEMENTED 700 E_NOT_SUPPORTED 700 E_NULL_REFERENCE 700 E_OUT_OF_MEMORY 700 E_OVERFLOW 700 E_PARAMETER 700 E_PARAMETER_READ_ONLY 700 E_PATH_TOO_LONG 701 E_SECURITY 701 E_SOCKET 701 E_SYS 701 E_TARGET_INVOCATION 701 E_TIMEOUT 701 E_WIN32 701 getError 703 isFailed 703 isSucceeded 703 OK 701 setLastError 703 suppressError 704 NRGB class 654 about NRGB class 654 blue 655 green 655 NRGB 655 red 655 NRGBImage class 655 about NRGBImage class 655 get 657 getMin 658 nativeTypeOf 658
about NPluginsChangeListener interface 752 NRational class 694 about NRational class 694 denominator 695 NRational 694 numerator 695 NResult class 695 about NResult class 695 check 701 checkAll 702 checkIO 702 checkNet 702 checkTimeout 702 checkUnchecked 703 E_ABANDONED_MUTEX 697 E_ARGUMENT 697 E_ARGUMENT_NULL 697 E_ARGUMENT_OUT_OF_RANGE 697 E_ARITHMETIC 697 E_BAD_IMAGE_FORMAT 697 E_CLR 697 E_COM 697 E_CORE 698 E_CPP 698 E_DIRECTORY_NOT_FOUND 698 E_DLL_NOT_FOUND 698 E_DRIVE_NOT_FOUND 698 E_END_OF_STREAM 698 E_ENTRY_POINT_NOT_FOUND 698 E_EXTERNAL 698 E_FAILED 698 E_FILE_FORMAT 699
ff
9 set 658 NSAttributes class 197 about NSAttributes class 197 getPhraseId 198 nativeTypeOf 198 NSAttributes 198 NSExtractor class 198 about NSExtractor class 198 extract 200 extractEnd 201 extractNext 201 extractStart 201 getMaxPauseDurationRaw 201 getMaxPhraseDurationRaw 201 getMinPhraseDurationRaw 202 getUseSpeakerDetection 202 nativeTypeOf 202 NSExtractor 199
setPhraseId 206 NSTemplate class 207 about NSTemplate class 207 calculateSize 209 check 209 getRecordCount 209 getRecords 209 getSize 209 MAX_RECORD_COUNT 208 nativeTypeOf 210 NSTemplate 207, 208 PROCESS_FIRST_RECORD_ONLY 208 NSTemplate.RecordCollection class 208 about NSTemplate.RecordCollection class 208 NTemplate class 210 about NTemplate class 210 calculateSize 211 check 212 clear 212 getFaces 212 getFingers 212 getIrises 212 getPalms 212 getSize 213 getVoices 213 nativeTypeOf 213 NTemplate 210, 211 setFaces 213 setFingers 213 setIrises 213 setPalms 214 setVoices 214 NVideoFormat class 731 about NVideoFormat class 731 AI44 733 ARGB32 733 AYUV 733 DV25 734 DV50 734 DVC 734 DVH1 734 DVHD 734
PARAMETER_MAX_PAUSE_DURATION 200 PARAMETER_MAX_PHRASE_DURATION 200 PARAMETER_MIN_PHRASE_DURATION 200 PARAMETER_USE_SPEAKER_DETECTION 200 setMaxPauseDurationRaw 202 setMaxPhraseDurationRaw 202 setMinPhraseDurationRaw 203 setUseSpeakerDetection 203 NSExtractor.ExtractResult class 199 about NSExtractor.ExtractResult class 199 getRecord 200 getStatus 200 NSMatchingDetails class 203 about NSMatchingDetails class 203 nativeTypeOf 203 NSRecord class 203 about NSRecord class 203 check 205 getCBEFFProductType 205 getPhraseId 205, 206 getSize 206 nativeTypeOf 206 NSRecord 204 setCBEFFProductType 206
gg
9 DVSD 734 DVSL 734 DX50 734 getFrameRate 739 getHeight 739 getInterlaceMode 739 getPixelAspectRatio 740 getWidth 740 H264 734 I420 734 IYUV 735 L16 735 L8 735 M4S2 735 mediaSubtypeToString 740 MJPG 735 MP43 735 MP4S 735 MP4V 735 MPG1 735 MSS1 736 MSS2 736 nativeTypeOf 740 NV11 736 NV12 736 NVideoFormat 733 P010 736 P016 736 P210 736 P216 736 RGB24 736 RGB32 736 RGB555 737 RGB565 737 RGB8 737 setFrameRate 741 setHeight 741 setInterlaceMode 741 setPixelAspectRatio 741 setWidth 741 UNKNOWN 737 UYVY 737
V210 737 V216 737 V410 737 WMV1 737 WMV2 738 WMV3 738 WVC1 738 Y210 738 Y216 738 Y410 738 Y416 738 Y41P 738 Y41T 738 Y42T 738 YUY2 739 YV12 739 YVU9 739 YVYU 739
O
Overview 7
P
ParameterException class 704 about ParameterException class 704 ParameterException 704 ParameterReadOnlyException class 704 about ParameterReadOnlyException class 704 ParameterReadOnlyException 705 PNGInfo class 658 about PNGInfo class 658 DEFAULT_COMPRESSION_LEVEL 659 getCompressionLevel 659 nativeTypeOf 659 setCompressionLevel 659
Q
Quick Start 23
R
Required Libraries 11
hh
S
Samples 26 SDK Components 7 Supported Biometric Standards 8 Supported Devices 11 System Requirements 1 System Setup Instructions 13
T
Tutorials 24
U
Using 13
V
VeriEye 45 VeriFinger 32 VeriLook 27 VeriSpeak 40
W
What's New 4
ii

Programas Biometricos de Seguridad PDF

Transféré par

Informations du document

Description originale:

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Programas Biometricos de Seguridad PDF

Transféré par

Droits d'auteur :

Formats disponibles

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2, VeriLook Embedded 1.2, VeriEye Embedded 1.

1 and VeriSpeak Embedded 1.1 SDK for Android

Copyright 2011-2013 Neurotechnology. All rights reserved.

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

Table of Contents 1 About

2 Installation 3 What's New 4 Overview

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

1.1 System Requirements

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

3 Fixed minor bugs in samples. February 28, 2012

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

4.1 SDK Components

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

Embedded Face Extractor

4.1 SDK Components

4.1.1 Embedded Fingerprint Extractor

4.1.2 Embedded Fingerprint Matcher

4.1.3 Embedded Face Extractor

4.2 Supported Biometric Standards

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

4.1.4 Embedded Face Matcher

4.1.5 Embedded Voice Extractor

4.1.6 Embedded Voice Matcher

4.2 Supported Biometric Standards

4.2 Supported Biometric Standards CbeffBiometricOrganizations

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

4.2.1 Fingerprint BSS

4.2 Supported Biometric Standards

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

4.2.2 Face BSS

4.2.3 Iris BSS

4.4 Supported Devices SDK. These biometric standards are supported:

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

4.3 Required Libraries

see page 556)

neurotec-devices-android.jar neurotec-licensing-android.jar neurotec-media-android.jar see page 50) to

see page 716)

4.4 Supported Devices

4.4.1 Fingerprint Scanners

4.4 Supported Devices

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

Manufacturer Toplink Pacific

Model BlueFIN bluetooth fingerprint reader1

5.1 System Setup Instructions

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

5.1 System Setup Instructions

5.2 Android Activation Change directory to Android installation:

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

5.2 Android Activation

5.2 Android Activation

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

5.2 Android Activation

MegaMatcher Embedded 1.2, VeriFinger Embedded 1.2,

5.2 Android Activation