• Articles
Show / Hide Table of Contents
  • Getting started
    • Quickstart
  • Installation and configuration
    • Installation
    • Configuration
  • Usage
    • Web enablement
    • Javascript
    • Creating a client
  • Transact
    • Enrol an identity
    • Retrieve an identity
    • Verify an identity
    • Identify an identity
    • Update an identity
    • Delete an identity
    • Biometric samples
    • Biometric features
    • Current record
    • Manage adapters
    • Extensions
    • BioClient R2 reference
  • Reference information
    • BioClient.Web assemblies
    • BioClient adapters

Extract and convert features

Biometric features are extracted from biometric samples. Biometric features are binary, often proprietary representations of biometric samples, which allow comparisons between persons.

BioClient.Web offers these verbs for features:

capture-feature

This method captures a biometric sample from a sensor, extracts a biometric feature from the sample, and stores both the sample and feature in the current record.

Usage

Call the Javascript method bioClient.capture_feature(). This method is defined in bioclient-plugin.js and calls build_capture_feature to build the BioClient.Web command, and calls captured_feature to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class capture-feature. It is recommended to use these event handlers.

Remarks

Input parameters

Parameter Type Value Remark
command string capture-feature The command to be executed.
sensorName string The unique name of the sensor adapter to use. If null, the current adapter is used.
type BiometricType The biometric type of the sample to be captured.
subtype BiometricSubtype The biometric subtype of the sample to be captured.
featureClass int? The class of the feature to extract from the sample.
featureOptions string Options used by the feature extractor.

Output parameters

Parameter Type Value Remark
command string capture-feature The command which was executed.
status string Success The success or failure status.
capture_msg string A friendly result message, relating to biometrics.
capture_sev string success The severity of the biometrics result message.
feature feature The captured feature.

extract

This method extracts a biometric feature from a biometric sample.

Usage

Call the Javascript method bioClient.extract(). This method is defined bioclient-plugin.js and calls build_extract to build the BioClient.Web command, and calls extracted to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class extract. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string extract The command to be executed.
type BiometricType The biometric type of the feature to be extracted.
subtype BiometricSubtype The biometric subtype of the sample to be used for extraction.
featureClass int? The class of the feature to extract from the sample.
featureOptions string Options used by the feature extractor.

Output parameters

Parameter Type Value Remark
command string extract The command which was executed.
status string Success The success or failure status.
capture_msg string A friendly result message, relating to biometrics.
capture_sev string success The severity of the biometrics result message.
feature feature The extracted feature.

convert-feature

This method converts a biometric feature from one format to another.

Usage

Call the Javascript method bioClient.convert_feature(). This method is defined bioclient-plugin.js and calls build_convert_feature to build the BioClient.Web command, and calls converted_feature to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class convert-feature. It is recommended to use these event handlers.

References

  • See The BioClient Javascript plugin for how to use the BioClient Javascript plugin.
  • See Common parameters for common input and output structures and arrays.
  • Improve this Doc
Back to top Generated by DocFX