FRIF Namespace Reference

TE input/output types. More...

Namespaces
namespace	EFS
	Types (mostly) mirroring the ANSI/NIST-ITL Type 9 Extended Feature Set.
namespace	Evaluations
	Functionality unique to each of the NIST FRIF Technology Evaluations.

Classes
struct	Candidate
	Unique entry. More...
struct	CandidateListKeyHash
	Hash function for Candidate. More...
struct	ComparisonResult
	The results of comparing two templates. More...
struct	Coordinate
	Pixel location in an image. More...
struct	Correspondence
	Information about a probe/reference relationship. More...
struct	CreateTemplateResult
	Output from extracting features into a template . More...
struct	Image
	Data and metadata for an image. More...
struct	ProductIdentifier
	Identifying details about algorithm components for documentation. More...
struct	ReturnStatus
	Information about the result of calling a FRIF API function. More...
struct	SearchResult
	The results of a searching a database. More...
struct	TemplateArchive
	Collection of templates on disk. More...
struct	TemplateData
	Information possibly stored in a template. More...

Typedefs
using	Segment = std::tuple<Coordinate, Coordinate>
	Line segment.
using	CandidateList
	Representation of a list of likely candidates returned from a search.
using	CandidateListCorrespondence
	Representation to output Correspondence for each Candidate from a CandidateList.
using	Sample
	Convenience definition for a friction ridge sample.

Enumerations
enum class	TemplateType { Probe , Reference }
	Use for data extracted from Sample. More...

Variables
uint16_t	API_MAJOR_VERSION {0}
	API major version number.
uint16_t	API_MINOR_VERSION {0}
	API minor version number.
uint16_t	API_PATCH_VERSION {1}
	API patch version number.

Detailed Description

TE input/output types.

Typedef Documentation

Segment

using FRIF::Segment = std::tuple<Coordinate, Coordinate>

Line segment.

Definition at line 216 of file common.h.

CandidateList

using FRIF::CandidateList

Initial value:

 std::unordered_map<Candidate, double,
            CandidateListKeyHash>

Representation of a list of likely candidates returned from a search.

Key is a unique subject identifier and finger position from that subject, representing a reference identity. Value is a quantification of a probe's similarity to the friction ridge data represented by the key.

Note

This structure is used to disallow duplicate finger positions from the same subject identifier.

Definition at line 159 of file io.h.

CandidateListCorrespondence

using FRIF::CandidateListCorrespondence

Initial value:

 std::unordered_map<Candidate,
            std::vector<Correspondence>, CandidateListKeyHash>

Representation to output Correspondence for each Candidate from a CandidateList.

Key is a unique subject identifier and finger position from that subject, representing a reference identity. Value is a set of Correspondence that align features from the probe to features from the reference (the key).

Definition at line 172 of file io.h.

Sample

using FRIF::Sample

Initial value:

 std::tuple<std::optional<Image>,
            std::optional<EFS::Features>>

Convenience definition for a friction ridge sample.

Definition at line 276 of file io.h.

Enumeration Type Documentation

TemplateType

enum class FRIF::TemplateType

strong

Use for data extracted from Sample.

Enumerator
Probe	Item being compared to a reference or searched against a reference database.
Reference	Use within a database for search, or the initial capture during a comparison.

Definition at line 280 of file io.h.

Variable Documentation

API_MAJOR_VERSION

uint16_t FRIF::API_MAJOR_VERSION {0}

API major version number.

Definition at line 260 of file common.h.

API_MINOR_VERSION

uint16_t FRIF::API_MINOR_VERSION {0}

API minor version number.

Definition at line 262 of file common.h.

API_PATCH_VERSION

uint16_t FRIF::API_PATCH_VERSION {1}

API patch version number.

Definition at line 264 of file common.h.