Capture and convert samples

Biometric samples are obtained from a capture device (commonly called sensor) for further processing within the biometric application. Biometric samples can be fingerprint images, facial images, voice recordings, or any other representation of a biometric mode.

BioClient.Web offers these verbs for samples:

capture-sample

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

Usage

Call the Javascript method bioClient.capture_sample(). This method is defined in bioclient-plugin.js and calls build_capture_sample to build the BioClient.Web command, and calls captured_sample 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-sample. It is recommended to use these event handlers.

Remarks

Input parameters

Parameter Type Value Remark
command string capture-sample 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.
sampleClass int? The class of the sample to capture.
sampleOptions string Options used by the sensor capturing the sample

Output parameters

Parameter Type Value Remark
command string capture-sample 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.
sample sample The captured sample.

convert-sample

This method converts a biometric sample from one format to another. It is often used to compress a biometric sample in its raw format (eg. BMP) to a compressed format (eg. WSQ for fingerprints).

Usage

Call the Javascript method bioClient.convert_sample(). This method is defined bioclient-plugin.js and calls build_convert_sample 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-sample. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string convert-sample The command to be executed.
type BiometricType The biometric type of the sample to be converted.
subtype BiometricSubtype The biometric subtype of the sample to be converted.
sampleClass int? The class of the sample to be converted to.
sampleOptions string Options used by the engine converting the sample

Output parameters

Parameter Type Value Remark
command string convert-sample 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.
sample sample The converted sample.

References