OEHitlistBuilder

Attention

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

class OEHitlistBuilder

This class defines interface for generating a hitlist from calculated :ref: Brood scores <OEBioisostere_OEBroodScore>.

The OEHitlistBuilder class defines the following public methods:

• AddScores

• Build

• GetAddCount

• GetBumpCount

• GetDeleteCount

• GetDuplicateCount

• GetHitCount

• GetHits

• GetInitHitCount

• GetSecDuplicateCount

• GetStrainCount

• GetUnstableCount

Constructors

OEHitlistBuilder(const OEBroodQuery &query)
OEHitlistBuilder(const OEBroodQuery &query,
                 const OEBroodGeneralOptions&)
OEHitlistBuilder(const OEBroodQuery &query,
                 const OEBroodGeneralOptions&, const OEBroodHitlistOptions&)

Constructors.

AddScores

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

Adds the specified scores for building hitlist.

Build

bool Build()

Builds the hitlist. Method should be called after all the scores have been added via AddScores.

GetAddCount

unsigned GetAddCount() const

Returns the total number of scores added.

GetBumpCount

unsigned GetBumpCount() const

Returns the total number of matches that were rejected due to bumping with protein.

GetDeleteCount

unsigned GetDeleteCount() const

Returns the total number of matches that were deleted.

GetDuplicateCount

unsigned GetDuplicateCount() const

Returns the total number of matches that were marked as duplicate.

GetHitCount

unsigned GetHitCount() const

Returns the total number of generated hits in the hitlist.

GetHits

std::vector<OEBroodHit> GetHits() const
bool GetHits(std::vector<OEBroodHit>&) const

Returns the generated hits.

GetInitHitCount

unsigned GetInitHitCount() const

Returns the initial size of the hitlist.

GetMatchCount

unsigned GetMatchCount() const

Returns the total number of matches found.

GetSecDuplicateCount

unsigned GetSecDuplicateCount() const

Returns the number of secondary duplicates.

GetStrainCount

unsigned GetStrainCount() const

Returns the number of matches rejected due to strain.

GetUnstableCount

unsigned GetUnstableCount() const

Returns the number of matches rejected due to unstable bonds.