OESimSearchResult

class OESimSearchResult

The OESimSearchResult class is used to store the results of a similarity search along with reporting the progress of the search and the histogram of the similarity scores.

Constructor

OESimSearchResult(nrbins: int = 50, min: float = 0.0,
                  max: float = 1.0) -> OESimSearchResult

Constructor an empty result object with parameters for the score histogram.

nrbins: Number of bins in the histogram (default = 50).
minv: Minimum bound (inclusive) of the histogram range (default = 0.0).
maxv: Maximum bound (inclusive) of the histogram range (default = 1.0).

GetHistogram

GetHistogram() -> OEFPHistogram

Returns an OEFPHistogram object that stores the histogram of similarity scores.

GetSearchStatus

GetSearchStatus() -> int

Returns the status of the similarity search defined in the OESimSearchStatus namespace.

GetSortedScores

GetSortedScores() -> Iterable[OESimScore]

Returns an iterator over the calculated similarity scores (OESimScore) in the sorted order. Each OESimScore holds a similarity score and index of the corresponding fingerprint of the database.

IsValid

IsValid() -> bool

Returns whether the OESimSearchResult object is valid.

NumSearched

NumSearched() -> int

Returns the number of fingerprints that have been already searched. This counter is continuously updated and provides the progress of the similarity search.

NumTargets

NumTargets() -> int

Returns the number of targets (i.e. the number of fingerprints in the database).