OESiteHopperSearchOptions

class OESiteHopperSearchOptions : public OESystem::OEOptions

Options to control the process in OESiteHopperSearch.

Constructors

OESiteHopperSearchOptions() -> OESiteHopperSearchOptions
OESiteHopperSearchOptions(arg2: OESiteHopperSearchOptions) -> OESiteHopperSearchOptions

Default constructors.

GetMaxHits

GetMaxHits() -> int

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

[default: 200]

GetNCPU

GetNCPU() -> int

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

[default: 0]

GetNormalizeAndRescore

GetNormalizeAndRescore() -> bool

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

GetScoreCutoff() -> float

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

[default: 0.0]

GetSequenceCutoff

GetSequenceCutoff() -> float

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

[default: 100.0]

GetUseGPU

GetUseGPU() -> bool

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

SetMaxHits(value: int) -> bool

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

SetNormalizeAndRescore(value: bool) -> bool

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

SetScoreCutoff(value: float) -> bool

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

[default: 0.0]

SetSequenceCutoff

SetSequenceCutoff(value: float) -> bool

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

[default: 100.0]

SetUseGPU

SetUseGPU(value: bool) -> bool

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

CreateCopy

CreateCopy() -> OESiteHopperSearchOptions