Interface TextFinderInterface

A TextFinder should provide an abstraction layer to perform text searches

Interface

TextFinderInterface

Hierarchy

TextFinderInterface

Index

Methods

findMatch findMatches

Methods

findMatch

findMatch<PROVIDER_DATA_TYPE>(matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>): Promise<MatchResult<Region>>
findMatch should provide an abstraction to search for an image needle in another image haystack

Returns
A MatchResult holding the match probability and location

Memberof
TextFinderInterface
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
  
  A MatchRequest containing needed matching data
Returns Promise<MatchResult<Region>>
- Defined in provider/text-finder.interface.ts:20

findMatches

findMatches<PROVIDER_DATA_TYPE>(matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>): Promise<MatchResult<Region>[]>
findMatches should provide an abstraction to search for an image needle in another image haystack

Returns
A list of MatchResults holding the match probability and location

Memberof
TextFinderInterface
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
  
  A MatchRequest containing needed matching data
Returns Promise<MatchResult<Region>[]>
- Defined in provider/text-finder.interface.ts:32