50#ifndef FRIF_EVALUATIONS_E1N_H_
51#define FRIF_EVALUATIONS_E1N_H_
189 std::tuple<ReturnStatus, std::optional<CreateTemplateResult>>
192 const std::string &identifier,
193 const std::vector<Sample> &samples)
241 std::vector<TemplateData>>>
297 const std::filesystem::path &databaseDirectory,
298 const uint64_t maxSize)
331 std::shared_ptr<ExtractionInterface>
333 const std::filesystem::path &configurationDirectory);
351 std::optional<ProductIdentifier>
492 const uint64_t maxSize) = 0;
552 std::tuple<ReturnStatus, std::optional<SearchResult>>
554 const std::vector<std::byte> &probeTemplate,
555 const uint16_t maxCandidates)
605 std::optional<CandidateListCorrespondence>
607 const std::vector<std::byte> &probeTemplate,
654 std::shared_ptr<SearchInterface>
656 const std::filesystem::path &configurationDirectory,
657 const std::filesystem::path &databaseDirectory);
675 std::optional<ProductIdentifier>
714 #ifdef NIST_EXTERN_FRIF_E1N_API_VERSION
Interface for database search implemented by participant.
virtual ~SearchInterface()
virtual std::tuple< ReturnStatus, std::optional< SearchResult > > search(const std::vector< std::byte > &probeTemplate, const uint16_t maxCandidates) const =0
Search the reference database for the samples represented in probeTemplate.
static Compatibility getCompatibility()
Obtain information about API feature and version compatibility of this implementation.
static std::shared_ptr< SearchInterface > getImplementation(const std::filesystem::path &configurationDirectory, const std::filesystem::path &databaseDirectory)
Obtain a managed pointer to an object implementing SearchInterface.
virtual ReturnStatus load(const uint64_t maxSize)=0
Load reference database into memory.
virtual std::optional< CandidateListCorrespondence > extractCorrespondence(const std::vector< std::byte > &probeTemplate, const SearchResult &searchResult) const =0
Extract pairs of corresponding Minutia between TemplateType::Probe and TemplateType::Reference templa...
static std::optional< ProductIdentifier > getProductIdentifier()
Obtain identification and version information for the search portion of this submission.
FRIF TE Exemplar 1:N functionality.
uint16_t API_PATCH_VERSION
API patch version number.
LibraryIdentifier getLibraryIdentifier()
uint16_t API_MAJOR_VERSION
API major version number.
uint16_t API_MINOR_VERSION
API minor version number.
TemplateType
Use for data extracted from Sample.
Output from extracting features into a template .
Information used by the NIST testing apparatus to help efficiently test this implementation.
bool supportsCorrespondence
Is useful information returned from extractCorrespondence()?
std::set< uint16_t > referenceDatabaseVersions
LibraryIdentifier::versionNumber of previously-submitted software that generates reference databases ...
std::set< uint16_t > probeTemplateVersions
LibraryIdentifier::versionNumber of previously-submitted software that generates probe templates that...
Identification information about the submitted library.
Information about the result of calling a FRIF API function.
The results of a searching a database.
Collection of templates on disk.