OEBroodHitlistOptions

Attention

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

class OEBroodHitlistOptions : public OESystem::OEOptions

This class provides an interface to set up options used when generating a hitlist in OEHitlistBuilder from a set of Brood scores.

The OEBroodHitlistOptions class defines the following public methods:

• GetGenerateIdea and SetGenerateIdea

• GetMaxHits and SetMaxHits

Constructors

OEBroodHitlistOptions()
OEBroodHitlistOptions(const OEBroodHitlistOptions &)

Default and copy constructors.

operator=

OEBroodHitlistOptions &operator=(const OEBroodHitlistOptions &)

Assignment operator.

GetGenerateIdea

bool GetGenerateIdea() const

See SetGenerateIdea method.

GetMaxHits

unsigned GetMaxHits() const

See SetMaxHits method.

SetGenerateIdea

bool SetGenerateIdea(const bool)

Sets whether cluster information is generated for the created hitlist. Default: True.

SetMaxHits

bool SetMaxHits(const unsigned)

Sets the maximum number of hits to generate. Default: 1000.