FaceTemplate Class Reference

FaceTemplate is Innovatrics proprietary face template. More...

#include <Face.h>

Collaboration diagram for FaceTemplate:

Public Member Functions
FaceSimilarityScore	SimilarWith (const FaceTemplate &gallery) const
	Calculates FaceSimilarityScore for given FaceTemplate.
std::string	GetVersion () const
	Provides version information of Innovatrics proprietary algorithm used to create the face template.
void	WriteTo (Writer &writer) const override
	Function serializes FaceTemplate via provided Writer.
	FaceTemplate (std::vector< uint8_t > &&templ, std::shared_ptr< FaceExecutor > executor)
	Construct a new FaceTemplate object.
	FaceTemplate (std::vector< uint8_t > &&templ)
	Construct a new FaceTemplate object GlobalFaceExecutor is used.
	FaceTemplate (const std::vector< uint8_t > &templ, std::shared_ptr< FaceExecutor > executor)
	Construct a new FaceTemplate object, copy template data.
	FaceTemplate (const std::vector< uint8_t > &templ)
	Construct a new FaceTemplate object, copy template data GlobalFaceExecutor is used.

Public Attributes
const std::vector< uint8_t >	data
	Template data.

Detailed Description

FaceTemplate is Innovatrics proprietary face template.

The template can be used later for verification.

Constructor & Destructor Documentation

FaceTemplate() [1/4]

FaceTemplate ( std::vector< uint8_t > && templ, std::shared_ptr< FaceExecutor > executor )

inline

Construct a new FaceTemplate object.

Parameters

templ	template data
executor	is FaceExecutor

Exceptions

NullArgumentException	when executor is null
InvalidTemplateException	when Face template has no data

References data.

Referenced by SimilarWith().

Here is the caller graph for this function:

FaceTemplate() [2/4]

FaceTemplate ( std::vector< uint8_t > && templ )

inlineexplicit

Construct a new FaceTemplate object GlobalFaceExecutor is used.

Parameters

templ

template data

Exceptions

InvalidTemplateException

when Face template has no data

References data.

FaceTemplate() [3/4]

FaceTemplate ( const std::vector< uint8_t > & templ, std::shared_ptr< FaceExecutor > executor )

inline

Construct a new FaceTemplate object, copy template data.

Parameters

templ	template data
executor	is FaceExecutor

Exceptions

NullArgumentException	when executor is null
InvalidTemplateException	when Face template has no data

References data.

FaceTemplate() [4/4]

FaceTemplate ( const std::vector< uint8_t > & templ )

inlineexplicit

Construct a new FaceTemplate object, copy template data GlobalFaceExecutor is used.

Parameters

templ

template data

Exceptions

InvalidTemplateException

when Face template has no data

References data.

Member Function Documentation

GetVersion()

std::string GetVersion ( ) const

inlinenodiscard

Provides version information of Innovatrics proprietary algorithm used to create the face template.

Returns

version string

References data.

SimilarWith()

FaceSimilarityScore SimilarWith ( const FaceTemplate & gallery ) const

inlinenodiscard

Calculates FaceSimilarityScore for given FaceTemplate.

Parameters

gallery

FaceTemplate for score calculation

Returns

FaceSimilarityScore

Exceptions

EnrollmentException

when it is not possible to match templates

References data, and FaceTemplate().

Here is the call graph for this function:

WriteTo()

void WriteTo ( Writer & writer ) const

inlineoverridevirtual

Function serializes FaceTemplate via provided Writer.

Parameters

writer

used to serialize Face.

Implements Serializable.

References data, and Writer::WriteArray().

Referenced by ExtractedFace::WriteTo().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Face/Face.h