Proprietary Fingerprint Template III
API for participating in NIST's evaluation of proprietary fingerprint template algorithms.
Public Member Functions | Public Attributes | List of all members
PFTIII::SubmissionIdentification Struct Reference

Identifying information about this submission that will be included in reports. More...

#include <pftiii.h>

Collaboration diagram for PFTIII::SubmissionIdentification:
Collaboration graph

Public Member Functions

 SubmissionIdentification ()
 Default constructor. More...
 
 SubmissionIdentification (const uint16_t versionNumber, const std::string &libraryIdentifier, const std::tuple< std::string, bool > &featureExtractionAlgorithmMarketingIdentifier=std::make_tuple("", false), const std::tuple< std::string, bool > &comparisonAlgorithmMarketingIdentifier=std::make_tuple("", false), const std::tuple< uint16_t, bool > &cbeffFeatureExtractionAlgorithmProductOwner=std::make_tuple(0x0000, false), const std::tuple< uint16_t, bool > &cbeffFeatureExtractionAlgorithmIdentifier=std::make_tuple(0x0000, false), const std::tuple< uint16_t, bool > &cbeffComparisoinAlgorithmProductOwner=std::make_tuple(0x0000, false), const std::tuple< uint16_t, bool > &cbeffComparisonAlgorithmIdentifier=std::make_tuple(0x0000, false))
 SubmissionIdentification constructor. More...
 

Public Attributes

uint16_t versionNumber {}
 Version number of this submission. More...
 
std::string libraryIdentifier {}
 Non-infringing identifier of this submission. More...
 
std::tuple< std::string, bool > featureExtractionAlgorithmMarketingIdentifier {"", false}
 Non-infringing marketing name of the feature extraction algorithm included in this submission. More...
 
std::tuple< std::string, bool > comparisonAlgorithmMarketingIdentifier {"", false}
 Non-infringing marketing name of the comparison algorithm included in this submission. More...
 
std::tuple< uint16_t, bool > cbeffFeatureExtractionAlgorithmProductOwner {0x0000, false}
 CBEFF Product Owner of the feature extraction algorithm, if registered. More...
 
std::tuple< uint16_t, bool > cbeffFeatureExtractionAlgorithmIdentifier {0x0000, false}
 CBEFF Feature Extraction Algorithm Identifier, if registered. More...
 
std::tuple< uint16_t, bool > cbeffComparisonAlgorithmProductOwner {0x0000, false}
 CBEFF Product Owner of the template comparison algorithm, if registered. More...
 
std::tuple< uint16_t, bool > cbeffComparisonAlgorithmIdentifier
 CBEFF Comparison Algorithm Identifier, if registered. More...
 

Detailed Description

Identifying information about this submission that will be included in reports.

Definition at line 299 of file pftiii.h.

Constructor & Destructor Documentation

◆ SubmissionIdentification() [1/2]

PFTIII::SubmissionIdentification::SubmissionIdentification ( )

Default constructor.

Definition at line 68 of file libpftiii.cpp.

◆ SubmissionIdentification() [2/2]

PFTIII::SubmissionIdentification::SubmissionIdentification ( const uint16_t  versionNumber,
const std::string &  libraryIdentifier,
const std::tuple< std::string, bool > &  featureExtractionAlgorithmMarketingIdentifier = std::make_tuple("", false),
const std::tuple< std::string, bool > &  comparisonAlgorithmMarketingIdentifier = std::make_tuple("", false),
const std::tuple< uint16_t, bool > &  cbeffFeatureExtractionAlgorithmProductOwner = std::make_tuple(0x0000, false),
const std::tuple< uint16_t, bool > &  cbeffFeatureExtractionAlgorithmIdentifier = std::make_tuple(0x0000, false),
const std::tuple< uint16_t, bool > &  cbeffComparisoinAlgorithmProductOwner = std::make_tuple(0x0000, false),
const std::tuple< uint16_t, bool > &  cbeffComparisonAlgorithmIdentifier = std::make_tuple(0x0000, false) 
)

SubmissionIdentification constructor.

Parameters
versionNumberVersion number of this submission. Required to be unique for each new submission.
libraryIdentifierNon-infringing identifier of this submission. Should be the same for all submissions. Case sensitive. Must match the regular expression "[:alnum:]+".
featureExtractionAlgorithmMarketingIdentifierNon-infringing marketing name of the feature extraction algorithm included in this submission. Optional. Case sensitive. Must match the regular expression "[[:graph:] ]*". First tuple member is the value and second is boolean indicating the initialization status of the value.
comparisonAlgorithmMarketingIdentifierNon-infringing marketing name of the comparison algorithm included in this submission. Optional. Case sensitive. Must match the regular expression "[[:graph:] ]*". First tuple member is value and second is boolean indicating the initialization status of the value.
cbeffFeatureExtractionAlgorithmProductOwnerCBEFF Product Owner of the feature extraction algorithm, if registered. First tuple member is value and second is boolean indicating the initialization status of the value. Optional, unlesscbeffFeatureExtractionAlgorithmIdentifieris supplied.
cbeffFeatureExtractionAlgorithmIdentifierCBEFF Feature Extraction Algorithm Identifier, if registered. First tuple member is value and second is boolean indicating the initialization status of the value.
cbeffComparisoinAlgorithmProductOwnerCBEFF Product Owner of the feature extraction algorithm, if registered. First tuple member is value and second is boolean indicating the initialization status of the value. Optional, unless cbeffComparisonAlgorithmIdentifieris supplied.
cbeffComparisonAlgorithmIdentifierCBEFF Comparison Algorithm Identifier, if registered. First tuple member is value and second is boolean indicating the initialization status of the value.
Note
The name of the core library submitted for evaluation shall be "libpftiii_<libraryIdentifier>_<versionNumber (capital hex)>.so". Refer to the test plan for more information.

Definition at line 73 of file libpftiii.cpp.

Member Data Documentation

◆ versionNumber

uint16_t PFTIII::SubmissionIdentification::versionNumber {}

Version number of this submission.

Required to be unique for each new submission. Required.

Definition at line 377 of file pftiii.h.

◆ libraryIdentifier

std::string PFTIII::SubmissionIdentification::libraryIdentifier {}

Non-infringing identifier of this submission.

Should be the same for all submissions from an organization. Required. Case sensitive. Must match the regular expression "[:alnum:]+".

Definition at line 383 of file pftiii.h.

◆ featureExtractionAlgorithmMarketingIdentifier

std::tuple<std::string, bool> PFTIII::SubmissionIdentification::featureExtractionAlgorithmMarketingIdentifier {"", false}

Non-infringing marketing name of the feature extraction algorithm included in this submission.

Optional. Case sensitive. Must match the regular expression "[[:graph:] ]*". First tuple member is value and second is boolean indicating the initialization status of the value.

Definition at line 392 of file pftiii.h.

◆ comparisonAlgorithmMarketingIdentifier

std::tuple<std::string, bool> PFTIII::SubmissionIdentification::comparisonAlgorithmMarketingIdentifier {"", false}

Non-infringing marketing name of the comparison algorithm included in this submission.

Optional. Case sensitive. Must match the regular expression "[[:graph:] ]*". First tuple member is value and second is boolean indicating the initialization status of the value.

Definition at line 401 of file pftiii.h.

◆ cbeffFeatureExtractionAlgorithmProductOwner

std::tuple<uint16_t, bool> PFTIII::SubmissionIdentification::cbeffFeatureExtractionAlgorithmProductOwner {0x0000, false}

CBEFF Product Owner of the feature extraction algorithm, if registered.

Optional, unless cbeffFeatureExtractionAlgorithmIdentifier is supplied. First tuple member is value and second is boolean indicating the initialization status of the value.

See also
https://www.ibia.org/cbeff/biometric-identifier-overview

Definition at line 417 of file pftiii.h.

◆ cbeffFeatureExtractionAlgorithmIdentifier

std::tuple<uint16_t, bool> PFTIII::SubmissionIdentification::cbeffFeatureExtractionAlgorithmIdentifier {0x0000, false}

CBEFF Feature Extraction Algorithm Identifier, if registered.

Optional. First tuple member is value and second is boolean indicating the initialization status of the value.

See also
https://www.ibia.org/cbeff/iso/biometric-feature- extraction-algorithm-identifiers

Definition at line 427 of file pftiii.h.

◆ cbeffComparisonAlgorithmProductOwner

std::tuple<uint16_t, bool> PFTIII::SubmissionIdentification::cbeffComparisonAlgorithmProductOwner {0x0000, false}

CBEFF Product Owner of the template comparison algorithm, if registered.

Optional, unless cbeffComparisonAlgorithmIdentifier is supplied. First supplied. First tuple member is value and second is boolean indicating the initialization status of the value.

See also
https://www.ibia.org/cbeff/biometric-identifier-overview

Definition at line 439 of file pftiii.h.

◆ cbeffComparisonAlgorithmIdentifier

std::tuple<uint16_t, bool> PFTIII::SubmissionIdentification::cbeffComparisonAlgorithmIdentifier
Initial value:
{
0x0000, false}

CBEFF Comparison Algorithm Identifier, if registered.

Optional. First tuple member is value and second is boolean indicating the initialization status of the value.

See also
https://www.ibia.org/cbeff/iso/biometric-comparison- algorithm-identifiers

Definition at line 448 of file pftiii.h.


The documentation for this struct was generated from the following files: