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

Default and copy constructors.

GetGenerateIdea

GetGenerateIdea() -> bool

See SetGenerateIdea method.

GetMaxHits

GetMaxHits() -> int

See SetMaxHits method.

SetGenerateIdea

SetGenerateIdea(value: bool) -> bool

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

SetMaxHits

SetMaxHits(value: int) -> bool

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