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	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 TE API function. More...
struct	SearchSubjectPositionResult
	The results of a searching a database for subject finger positions. More...
struct	SearchSubjectResult
	The results of a searching a database for a subject, without respect to finger positions. More...
struct	SubjectPositionCandidate
	Candidate list entry identifying a specific region of a subject. More...
struct	SubjectPositionCandidateListKeyHash
	Hash function for SubjectPositionCandidate. 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	SubjectCandidate = std::string
	Candidate list entry identifying a subject without respect for region.
using	SubjectPositionCandidateList
	Representation of a list of likely candidates returned from a search.
using	SubjectCandidateList = std::unordered_map<std::string, double>
	Representation of a list of likely candidates returned from a search.
using	SubjectPositionCandidateListCorrespondence
	Representation to output Correspondence for each SubjectPositionCandidate from a SubjectPositionCandidateList.
using	SubjectCandidateListCorrespondence
	Representation to output Correspondence for each SubjectCandidate from a SubjectCandidateList.
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 {1}
	API major version number.
uint16_t	API_MINOR_VERSION {2}
	API minor version number.
uint16_t	API_PATCH_VERSION {0}
	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 250 of file common.h.

SubjectCandidate

using FRIF::SubjectCandidate = std::string

Candidate list entry identifying a subject without respect for region.

See also

SubjectPositionCandidate

Definition at line 141 of file io.h.

SubjectPositionCandidateList

using FRIF::SubjectPositionCandidateList

Initial value:

 std::unordered_map<
            SubjectPositionCandidate, double,
            SubjectPositionCandidateListKeyHash>

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 166 of file io.h.

SubjectCandidateList

using FRIF::SubjectCandidateList = std::unordered_map<std::string, double>

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

Key is a unique subject identifier, 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 subject identifiers.

Definition at line 181 of file io.h.

SubjectPositionCandidateListCorrespondence

using FRIF::SubjectPositionCandidateListCorrespondence

Initial value:

 
            std::unordered_map<SubjectPositionCandidate, Correspondence,
            SubjectPositionCandidateListKeyHash>

Representation to output Correspondence for each SubjectPositionCandidate from a SubjectPositionCandidateList.

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 193 of file io.h.

SubjectCandidateListCorrespondence

using FRIF::SubjectCandidateListCorrespondence

Initial value:

 
            std::unordered_map<std::string, Correspondence>

Representation to output Correspondence for each SubjectCandidate from a SubjectCandidateList.

Key is a unique subject identifier, 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 206 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 349 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 353 of file io.h.

Variable Documentation

API_MAJOR_VERSION

uint16_t FRIF::API_MAJOR_VERSION {1}

API major version number.

Definition at line 300 of file common.h.

API_MINOR_VERSION

uint16_t FRIF::API_MINOR_VERSION {2}

API minor version number.

Definition at line 302 of file common.h.

API_PATCH_VERSION

uint16_t FRIF::API_PATCH_VERSION {0}

API patch version number.

Definition at line 304 of file common.h.