OEScoreHitlist

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OEScoreHitlist: public OEHitlistBase

This class collects and manages scores from overlay operations, filtering duplicates and creating a hit list of unique, high-scoring fragment matches.

The OEScoreHitlist class defines the following public methods:

AddScores

Build

GetHits

GetMatchCount

Constructors

OEScoreHitlist(const unsigned maxHits = 1000)

This method constructs an OEScoreHitlist with a specified maximum number of hits to retain.

AddScores

bool AddScores(const std::vector<OEBroodScore>&)

This method adds a batch of OEBroodScore objects for score-stage hit list curation.

Build

bool Build(const bool final = true) override

This method builds the final hit list from all added scores, filtering duplicates and retaining the top-scoring unique fragments.

GetHits

const std::vector<OEBroodScore>& GetHits() const

This method returns curated score-level hits as OEBroodScore objects.

GetMatchCount

unsigned GetMatchCount() const

This method returns the number of unique score matches retained in the hit list.