OESiteHopperSearchOptions¶
class OESiteHopperSearchOptions : public OESystem::OEOptions
Options to control the process in OESiteHopperSearch.
Constructors¶
OESiteHopperSearchOptions()
OESiteHopperSearchOptions(OESiteHopperSearchOptions &&)=default
OESiteHopperSearchOptions(const OESiteHopperSearchOptions &)=default
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 reduced the search time significantly, but requires Linux and a compatible Nvidia GPU. See GPU Prerequisites
SetMaxHits¶
void 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)
Set maximum number of CPUs to use for search. Zero (0) implies use all available.
[default: 0]
SetNormalizeAndRescore¶
void 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¶
void SetScoreCutoff(float cutoff)
Minimum PatchScore for a hit to be considered part of the hitlist.
[default: 0.0]
SetSequenceCutoff¶
void SetSequenceCutoff(float cutoff)
Maximum protein sequence similarity for a hit to be considered part of the hitlist.
[default: 100.0]
operator=¶
OESiteHopperSearchOptions &operator=(OESiteHopperSearchOptions &&)=default
OESiteHopperSearchOptions &operator=(const OESiteHopperSearchOptions &)=default
CreateCopy¶
OESiteHopperSearchOptions *CreateCopy() const