OEDockBase

class OEDockBase

OEDockBase is a pure virtual class that defines an API for docking multiconformer molecules.

This pure virtual class is implement by OEDock.

This class must be initialized with a receptor (see Receptors chapter) using the OEDockBase.Initialize method prior to using the OEDockBase.DockMultiConformerMolecule method.

The following free function take OEDockBase objects.

OESetEnergyScore OESetEnergyScoreComponent
OESetSDScore OESetSDScoreComponent
OESetScore OESetScoreComponent

Destructor

virtual ~OEDockBase()

Destructor.

IsInitialized

virtual bool IsInitialized() const  = 0

Returns true if this object has been successfully initialized and is ready to dock molecules.

Initialize

virtual bool Initialize(const OEChem::OEMolBase& receptor)  = 0

Sets up this object to dock molecules into a receptor.

This function returns true if setup was successful and false otherwise.

receptor
A receptor describing the active site of the target protein (see Receptors chapter). This object does not depend upon receptor once this call is completed (i.e. receptor can be destroyed after calling this method).

Note: This method can take several minutes to complete with larger active sites.

DockMultiConformerMolecule

Both overloads of this method dock inputMol into the receptor passed to the OEDockBase.Initialize method.

The return value of this method describes the result of the docking, with a value from the OEDockingReturnCode namespace. A result of OEDockingReturnCode.Success indicates docking was successful.

virtual unsigned int DockMultiConformerMolecule(OEChem::OEMolBase& dockedMol,
                                                const OEChem::OEMCMolBase& inputMol)  = 0

This overload of OEDockBase.DockMultiConformerMolecule returns the top scoring pose.

dockedMol
Top scoring docked pose of inputMol.
inputMol
A multiconformer representation of a molecule to dock.

The score of the docked pose can be obtained by calling the GetEnergy method of dockedMol.

virtual unsigned int DockMultiConformerMolecule(OEChem::OEMCMolBase& dockedMol,
                                                const OEChem::OEMCMolBase& inputMol,
                                                unsigned int numPoses = 1)  = 0

This overload of OEDockBase.DockMultiConformerMolecule can return alternate docked poses, in addition to the top scoring pose.

dockedMol
Docked poses of inputMol. Poses are stored as conformers of the OEMCMolBase and are sorted by score.
inputMol
A multiconformer representation of a molecule to dock.
numPoses
Maximum number of top scoring docked poses to return in dockedMol. Typically this will be the number of poses returned, however, in highly restricted sites fewer than numPoses may be returned. The value of numPoses must be greater than zero.

The score of the docked poses can be obtained by calling the GetEnergy method on the conformers of dockedMol.

GetHighScoresAreBetter

virtual bool GetHighScoresAreBetter() const  = 0

Returns true if higher scores indicate a better result.

Returns false if lower scores indicate a better result.

GetName

virtual std::string GetName() const  = 0;

Returns the name of the scoring function docked poses are scored with.

GetComponentNames

virtual OESystem::OEIterBase<const std::string>* GetComponentNames() const  = 0

ScoreLigand

virtual float ScoreLigand(const OEChem::OEMolBase& pose)  = 0

Rescores a pose within the active site.

pose
Structure of a pose within the active site

If an error occurs this function will return FLT_MAX if OEDockBase.GetHighScoresAreBetter returns false or -FLT_MAX otherwise.

ScoreAtom

virtual float ScoreAtom(const OEChem::OEAtomBase& atom,
                        const OEChem::OEMolBase& pose)  = 0

Returns the score of an atom of a given pose within the active site.

atom
Atom of pose to score.
pose
Structure of a pose within the active site

If an error occurs this function will return FLT_MAX if OEDockBase.GetHighScoresAreBetter returns false or -FLT_MAX otherwise.

ScoreLigandComponent

virtual float ScoreLigandComponent(const OEChem::OEMolBase& pose,
                                   std::string compName)  = 0

Returns the given components contribution to the total score.

pose
Structure of a pose within the active site
compName
Name of the score component to report. Name must be one returned by OEDockBase.GetComponentNames.

If an error occurs this function will return FLT_MAX if OEDockBase.GetHighScoresAreBetter returns false or -FLT_MAX otherwise.

ScoreAtomComponent

virtual float ScoreAtomComponent(const OEChem::OEAtomBase& atom,
                                 const OEChem::OEMolBase& pose,
                                 std::string compName)  = 0

Returns the given components contribution to the score of a given atom score.

atom
Atom of pose to score.
pose
Structure of a pose within the active site
compName
Name of the score component to report. Name must be one returned by OEDockBase.GetComponentNames.

If an error occurs this function will return FLT_MAX if OEDockBase.GetHighScoresAreBetter returns false or -FLT_MAX otherwise.

AnnotatePose

Adds VIDA scoring annotation to the pose or poses passed.

The annotated poses must be written out in either oeb or oeb.gz format and are only viewable in VIDA.

virtual bool AnnotatePose(OEChem::OEMolBase& pose)  = 0

This overload of OEDockBase.AnnotatePose annotates a single pose.

pose
Structure of a pose within the active site
virtual bool AnnotatePose(OEChem::OEMCMolBase& poses)  = 0

This overload of OEDockBase.AnnotatePose annotates all poses of a given ligand.

poses
An OEMCMolBase the conformers of which are poses within the active site.

CacheScoringSetup

This function caches the current scoring setup of the OEDockBase object onto a receptor object. When another OEDockBase object is initialized with this receptor the it will read in the cached score data rather than recalculating it from scratch, thus improving the startup time of the OEDockBase object.

virtual bool CacheScoringSetup(OEChem::OEMolBase& receptor, bool clearOldData = true)  = 0
receptor
A receptor object. This must be the same receptor object the OEHybrid object was initialized with or an exact copy.
clearOldData
Flag to clear cached data from a prior call to CacheScoringSetup with this receptor. The cached data can be quite sizable (hundreds of megabytes), so leaving this flag at the default value of true is recommended.

Note

The cached score data on a receptor will be saved when the receptor is written to a file.