Applicant represent enrolled person. More...

#include <Applicant.h>

Collaboration diagram for Applicant:

Public Member Functions
std::vector< std::shared_ptr< ExtractedPrint > >	GetEnrolledPrints () const
	Function provides enrolled Prints.
std::vector< std::shared_ptr< ExtractedFace > >	GetEnrolledFaces () const
	Function provides enrolled Faces.
std::vector< std::shared_ptr< ExtractedIris > >	GetEnrolledIrises () const
	Function provides enrolled Irises.
std::shared_ptr< ModalitiesTemplate >	ToTemplate () const
	Converts Applicant to ModalitiesTemplate.
std::shared_ptr< ModalitiesICSTemplate >	ToICSTemplate () const
	Converts Applicant to ModalitiesICSTemplate.
std::shared_ptr< ModalitiesICSTemplate >	ToICSTemplate (ModalitiesICSTemplateFactory &factory) const
	Converts Applicant to ModalitiesICSTemplate.
ModalityScore	SimilarWith (const Applicant &gallery, ApplicantMatcher &matcher) const
	Calculates SimilarityScore for each modality.
std::shared_ptr< ExtractedPrint >	AddUniquePrint (std::shared_ptr< ExtractedPrint > print)
	Validates print according to default FlatteningValidation and adds Print when is valid.
bool	AddValidPrint (std::shared_ptr< ExtractedPrint > print, ApplicantPrintValidation &validation)
	Validates print according to given ApplicantPrintValidation and adds Print when is valid See Custom Print validation.
void	AddPrint (std::shared_ptr< ExtractedPrint > print)
	Adds Print to applicant.
void	AddSlap (std::shared_ptr< SlapCapture > slap)
	It adds SlapCapture to applicant.
void	AddThumbs (std::shared_ptr< ThumbsCapture > thumbs)
	It adds ThumbsCapture to applicant.
bool	AddValidFace (std::shared_ptr< ExtractedFace > face, ApplicantFaceValidation &validation)
	Validates Face according to given ApplicantFaceValidation and adds Face when is valid.
void	AddFace (std::shared_ptr< ExtractedFace > face)
	It adds Face to applicant.
void	AddIris (std::shared_ptr< ExtractedIris > iris)
	It adds Iris to applicant.
void	WriteTo (Writer &writer) const final
	It serializes applicant via provided Writer.
	Applicant ()
	Constructor uses GLobalLogger.

Detailed Description

Applicant represent enrolled person.

It holds person biometric data. It provides features:

Print

The Print can be added via functions

AddPrint - use no validation
AddUniquePrint - uses FlatteningValidation
AddValidPrint - use customized implementation of ApplicantPrintValidation, see Custom Print validation.

Face

The Face can be added via functions

AddFace - use no validation
AddValidFace - use customized implementation of ApplicantFaceValidation see Custom Face validation.

Iris

The Iris can be added via functions

AddIris - use no validation

Member Function Documentation

◆ AddFace()

void AddFace ( std::shared_ptr< ExtractedFace > face )

inline

It adds Face to applicant.

Parameters

face	ExtractedFace detected by FaceDetector and extracted

Exceptions

NullArgumentException when face is null object

◆ AddIris()

void AddIris ( std::shared_ptr< ExtractedIris > iris )

inline

It adds Iris to applicant.

Parameters

iris	Iris detected by IrisDetector

Exceptions

NullArgumentException when iris is null object

◆ AddPrint()

void AddPrint ( std::shared_ptr< ExtractedPrint > print )

inline

Adds Print to applicant.

Parameters

print print template calculated by PrintExtractor.

Exceptions

NullArgumentException when print is null

◆ AddSlap()

void AddSlap ( std::shared_ptr< SlapCapture > slap )

inline

It adds SlapCapture to applicant.

Parameters

slap	SlapCapture

Exceptions

NullArgumentException when slap is null

◆ AddThumbs()

void AddThumbs ( std::shared_ptr< ThumbsCapture > thumbs )

inline

It adds ThumbsCapture to applicant.

Parameters

thumbs ThumbsCapture

Exceptions

NullArgumentException when thumbs is null

◆ AddUniquePrint()

std::shared_ptr< ExtractedPrint > AddUniquePrint ( std::shared_ptr< ExtractedPrint > print )

inline

Validates print according to default FlatteningValidation and adds Print when is valid.

See Print flattening.

Parameters

print ExtractedPrint to be checked and added.

Returns: enrolled print that causes invalidity of currently enrolling Print; null when print is valid

Exceptions

NullArgumentException when FlatteningValidation throws

References AddValidPrint(), and FlatteningValidation::GetInvalidatingPrint().

Here is the call graph for this function:

◆ AddValidFace()

bool AddValidFace	(	std::shared_ptr< ExtractedFace >	face,
		ApplicantFaceValidation &	validation )

inline

Validates Face according to given ApplicantFaceValidation and adds Face when is valid.

See Custom Face validation.

Parameters

face	ExtractedFace to be checked and added
validation	ApplicantFaceValidation to check Face validity

Returns: true when Face was added; false when Face do not pass ApplicantFaceValidation::Validate

Exceptions

NullArgumentException when probe is null

References ApplicantFaceValidation::Validate().

Here is the call graph for this function:

◆ AddValidPrint()

bool AddValidPrint	(	std::shared_ptr< ExtractedPrint >	print,
		ApplicantPrintValidation &	validation )

inline

Validates print according to given ApplicantPrintValidation and adds Print when is valid See Custom Print validation.

Parameters

print	ExtractedPrint to be checked and added
validation	ApplicantPrintValidation to check print validity

Returns: true when print was added; false when print do not pass ApplicantPrintValidation::Validate

Exceptions

NullArgumentException when print is null

References ApplicantPrintValidation::Validate().

Referenced by AddUniquePrint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEnrolledFaces()

std::vector< std::shared_ptr< ExtractedFace > > GetEnrolledFaces ( ) const

inline

Function provides enrolled Faces.

Returns: enrolled faces

◆ GetEnrolledIrises()

std::vector< std::shared_ptr< ExtractedIris > > GetEnrolledIrises ( ) const

inline

Function provides enrolled Irises.

Returns: enrolled irises

◆ GetEnrolledPrints()

std::vector< std::shared_ptr< ExtractedPrint > > GetEnrolledPrints ( ) const

inline

Function provides enrolled Prints.

Returns: enrolled prints

◆ SimilarWith()

ModalityScore SimilarWith	(	const Applicant &	gallery,
		ApplicantMatcher &	matcher ) const

inlinenodiscard

Calculates SimilarityScore for each modality.

This is convenient function to check similarity of applicants. It is not efficient because it always creates probe and gallery ModalitiesTemplate.

Parameters

gallery	applicant to compare with
matcher	is ApplicantMatcher used to calculate ModalityScore between probe (this Applicant) and given Applicant gallery.

Returns: ModalityScore which contains the similarity score for each modality

Exceptions

EnrollmentException when it is not possible to match applicants

References Applicant(), and ApplicantMatcher::Match().

Here is the call graph for this function:

◆ ToICSTemplate() [1/2]

std::shared_ptr< ModalitiesICSTemplate > ToICSTemplate ( ) const

inline

Converts Applicant to ModalitiesICSTemplate.

It gets all enrolled prints, faces, irises and converts them to ModalityICSTemplate. It uses default ModalitiesICSTemplateDefaultFactory for conversion.

Returns: ModalitiesICSTemplate with all enrolled modalities

References ToICSTemplate().

Referenced by ToICSTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToICSTemplate() [2/2]

std::shared_ptr< ModalitiesICSTemplate > ToICSTemplate ( ModalitiesICSTemplateFactory & factory ) const

inline

Converts Applicant to ModalitiesICSTemplate.

It gets all enrolled prints, faces, irises and converts them to ModalityICSTemplate.

Parameters

factory ModalitiesICSTemplateFactory used for conversion

Returns: ModalitiesICSTemplate with all enrolled modalities

References ModalitiesICSTemplateFactory::CreateModalitiesICSTemplate(), ExtractedPrint::ToICSTemplates(), ExtractedFace::ToTemplates(), and ExtractedIris::ToTemplates().

Here is the call graph for this function:

◆ ToTemplate()

std::shared_ptr< ModalitiesTemplate > ToTemplate ( ) const

inline

Converts Applicant to ModalitiesTemplate.

It gets all enrolled prints, faces, irises and converts them to ModalityTemplate. The ModalityTemplate can be later used in ModalitiesGallery as probe or candidate. The ModalityTemplate can be later used in ModalitiesVerifyMatcher as probe or reference for Applicant verification.

Returns: ModalitiesTemplate with all enrolled modalities

References ModalitiesTemplate::Create(), ExtractedFace::ToTemplates(), ExtractedIris::ToTemplates(), and ExtractedPrint::ToTemplates().

Here is the call graph for this function:

◆ WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

It serializes applicant via provided Writer.

Parameters

writer used to serialize Applicant.

Implements Serializable.

The documentation for this class was generated from the following file:

Applicant.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddFace()

◆ AddIris()

◆ AddPrint()

◆ AddSlap()

◆ AddThumbs()

◆ AddUniquePrint()

◆ AddValidFace()

◆ AddValidPrint()

◆ GetEnrolledFaces()

◆ GetEnrolledIrises()

◆ GetEnrolledPrints()

◆ SimilarWith()

◆ ToICSTemplate() [1/2]

◆ ToICSTemplate() [2/2]

◆ ToTemplate()

◆ WriteTo()