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
OEEonHitlistOptions(arg2: OEEonHitlistOptions) -> OEEonHitlistOptions

Default and copy constructors.

CreateCopy

CreateCopy() -> OEEonHitlistOptions

Creates and returns a deep copy of this object.

GetMaxHits

GetMaxHits() -> int

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

SetMaxHits

SetMaxHits(value: int) -> bool

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

GetBestHits() -> int

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

SetBestHits

SetBestHits(value: int) -> bool

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

GetCutoff

GetCutoff() -> float

Returns the score cutoff parameter. See SetCutoff method.

SetCutoff

SetCutoff(value: float) -> bool

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