Package io.mosip.kernel.core.bioapi.spi

Interface IBioApi

public interface IBioApi

The Interface IBioApi.

Author:

Sanjay Murali, Manoj SP

Method Summary

Modifier and Type	Method	Description
Response<QualityScore>	checkQuality(BIR sample, KeyValuePair[] flags)	It checks the quality of the provided biometric image and render the respective quality score.
Response<BIR>	extractTemplate(BIR sample, KeyValuePair[] flags)	Extract template.
Response<MatchDecision[]>	match(BIR sample, BIR[] gallery, KeyValuePair[] flags)	It compares the biometrics and provide the respective matching scores.
Response<BIR[]>	segment(BIR sample, KeyValuePair[] flags)	It segment the single biometric image into multiple biometric images.

Method Detail

checkQuality

Response<QualityScore> checkQuality(BIR sample,
                                    KeyValuePair[] flags)

It checks the quality of the provided biometric image and render the respective quality score.

Parameters:

sample - the sample

flags - the flags

Returns:

the response

match

Response<MatchDecision[]> match(BIR sample,
                                BIR[] gallery,
                                KeyValuePair[] flags)

It compares the biometrics and provide the respective matching scores.

Parameters:

sample - the sample

gallery - the gallery

flags - the flags

Returns:

the response

extractTemplate

Response<BIR> extractTemplate(BIR sample,
                              KeyValuePair[] flags)

Extract template.

Parameters:

sample - the sample

flags - the flags

Returns:

the response

segment

Response<BIR[]> segment(BIR sample,
                        KeyValuePair[] flags)

It segment the single biometric image into multiple biometric images. Eg: Split the thumb slab into multiple fingers

Parameters:

sample - the sample

flags - the flags

Returns:

the response