OESiteHopperSearchOptions

class OESiteHopperSearchOptions : public OESystem::OEOptions

Options to control the process in OESiteHopperSearch.

Constructors

OESiteHopperSearchOptions()
OESiteHopperSearchOptions(OESiteHopperSearchOptions &&)
OESiteHopperSearchOptions(const OESiteHopperSearchOptions &)

Default constructors.

GetMaxHits

unsigned int GetMaxHits() const

Get maximum number of hits to return from the search. Very large hitlists can use a large amount of RAM.

[default: 200]

GetNCPU

unsigned int GetNCPU() const

Get maximum number of CPUs to use for search. Zero (0) implies use all available.

[default: 0]

GetNormalizeAndRescore

bool GetNormalizeAndRescore() const

Flag to determine whether patches of hits will be normalized to the surface area of the query patch and then rescored for the final hitlist.

[default: false]

GetScoreCutoff

float GetScoreCutoff() const

Minimum PatchScore for a hit to be considered part of the hitlist.

[default: 0.0]

GetSequenceCutoff

float GetSequenceCutoff() const

Maximum protein sequence similarity for a hit to be considered part of the hitlist.

[default: 100.0]

GetUseGPU

bool GetUseGPU() const

Flag to determine whether to use a GPU for prescreen as part of the search. This reduce the search time, but requires Linux and a compatible Nvidia GPU. See GPU Prerequisites

SetMaxHits

bool SetMaxHits(unsigned int maxHits)

Set maximum number of hits to return from the search. Very large hitlists can use a large amount of RAM.

[default: 200]

SetNCPU

void SetNCPU(unsigned int n)

SetNCPU(value: int) -> None

Set maximum number of CPUs to use for search. Zero (0) implies use all available.

[default: 0]

SetNormalizeAndRescore

bool SetNormalizeAndRescore(bool state)

Flag to determine whether patches of hit OEDesignUnits will be normalized to the surface area of the query patch and then rescored for the final hitlist.

[default: false]

SetScoreCutoff

bool SetScoreCutoff(float cutoff)

Minimum PatchScore for a hit to be considered part of the hitlist.

[default: 0.0]

SetSequenceCutoff

bool SetSequenceCutoff(float cutoff)

Maximum protein sequence similarity for a hit to be considered part of the hitlist.

[default: 100.0]

SetUseGPU

bool GetUseGPU() const

Flag to set whether to use a GPU for prescreen as part of the search. This reduces the search time, but requires Linux and a compatible Nvidia GPU. See GPU Prerequisites

operator=

OESiteHopperSearchOptions &operator=(OESiteHopperSearchOptions &&)
OESiteHopperSearchOptions &operator=(const OESiteHopperSearchOptions &)

Assignment operator.

CreateCopy

OESiteHopperSearchOptions* CreateCopy() const