OEEonHitlistOptions

Attention

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

class OEEonHitlistOptions : public OESystem::OEOptions

This class sets up options required for generating a hit list in OEEonHitlistBuilder from a set of Eon hits OEEonHit.

The OEEonHitlistOptions class defines the following public methods:

Constructors

OEEonHitlistOptions()
OEEonHitlistOptions(const OEEonHitlistOptions &)

Default and copy constructors.

operator=

OEEonHitlistOptions &operator=(const OEEonHitlistOptions &)

Assignment operator.

GetMaxHits

unsigned GetMaxHits() const

Returns parameter for the maximum number of hits to be generated. See SetMaxHits method.

SetMaxHits

bool SetMaxHits(const unsigned)

Sets the maximum number of molecules to go over. When zero, all inputs to the hit list will be considered in the hit list. Default: 0.

GetBestHits

unsigned GetBestHits() const

Returns parameter for the number of best hits to keep. See SetBestHits method.

SetBestHits

bool SetBestHits(const unsigned)

Sets the number of maximum hits to keep at the output of the hit list. Default: 1000.

GetCutoff

double GetCutoff() const

Returns the score cutoff parameter. See SetMaxHits method.

SetCutoff

bool SetCutoff(const double)

Sets the cutoff parameter. When the combo score is below this value, the hits are ignored. Default: -1.0