OEEonHitlistBuilder

Attention

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

class OEEonHitlistBuilder

This class aggregates shape and electrostatic overlay scores into a ranked hit list. Use AddScore or AddScores to populate scores, then call Build and retrieve the ranked results with GetHits.

The OEEonHitlistBuilder class defines the following public methods:

GetAddCount
GetHitCount
GetHits
AddScore
AddScores
Build

Constructors

OEEonHitlistBuilder(hitlistOptions: OEEonHitlistOptions = OEEonHitlistOptions()) -> OEEonHitlistBuilder

Constructor. This class is not copyable.

Destructor

~OEEonHitlistBuilder()

GetAddCount
GetAddCount() -> int
This method returns number of added entries to the hit list.

GetHitCount
GetHitCount() -> int
This method returns the number of hits stored currently in the hit list object.

GetHits
GetHits() -> OEEonHitVector
GetHits(vecHits: OEEonHitVector) -> bool
This method returns the sorted hits.

AddScores
AddScores(hits: OEEonHitVector) -> bool
This method adds a vector of hits to the hit list object.

AddScore
AddScore(score: OEEonOverlayScore, mol: OEMol) -> bool
This method adds an Eon hit to the hit list object.

Build
Build() -> bool
This method builds internal variables to build a hit list once all scores have been added.