OEDock

class OEDock

OEDock is used to dock and score multiconformer molecules in an active site.

Use the following procedure to dock and score molecules with this class.

1. Initialize the active site by passing a design unit containing a receptor (see chapter_receptor chapter) to the OEDock.Initialize method.

2. Dock molecules using the OEDock.DockMultiConformerMolecule method.

3. Score docked molecules with any of the following methods

   • OEDock.ScoreLigand

   • OEDock.ScoreAtom

   • OEDock.ScoreLigandComponent

   • OEDock.ScoreAtomComponent

   • OEDock.AnnotatePose

Constructor

OEDock(scoring: int, resolution: int) -> OEDock
OEDock(arg2: OEDockOptions) -> OEDock
OEDock(arg2: OEDock) -> OEDock

Default and copy constructors.

IsInitialized

bool IsInitialized() const

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

Initialize

Initialize(du: OEDesignUnit) -> bool
Initialize(receptor: Union[OEGraphMol,OEMol,OEQMol]) -> bool

Sets up this object to dock molecules into a receptor. This function returns true if initialization was successful. This object does not depend upon receptor once this call is completed (i.e. receptor can be destroyed after calling this method). The first overload expects a design unit that contains a receptor. The second overload works on a variation of molecule that contains receptor data.

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 OEDock.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.

DockMultiConformerMolecule(dockedMol: Union[OEGraphMol,OEMol,OEQMol],
                           inputMol: OEMol) -> int

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

dockedMol

Top scoring docked pose of inputMol.

inputMol

A multiconformer representation of a molecule to dock. Must have 3D coordinates assigned.

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

DockMultiConformerMolecule(dockedMol: OEMol, inputMol: OEMol,
                           numPoses: int = 1) -> int

This overload of OEDock.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. Must have 3D coordinates assigned.

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

GetHighScoresAreBetter() -> bool

Returns true if higher scores indicate a better result.

Returns false if lower scores indicate a better result.

GetName

GetName() -> str

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

GetComponentNames

GetComponentNames() -> Iterable[str]

ScoreLigand

ScoreLigand(pose: Union[OEGraphMol,OEMol,OEQMol]) -> float

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 OEDock.GetHighScoresAreBetter returns false or -FLT_MAX otherwise.

ScoreAtom

ScoreAtom(atom: OEAtomBase, pose: Union[OEGraphMol,OEMol,OEQMol]) -> float

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 OEDock.GetHighScoresAreBetter returns false or -FLT_MAX otherwise.

ScoreLigandComponent

ScoreLigandComponent(pose: Union[OEGraphMol,OEMol,OEQMol],
                     compName: str) -> float

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 OEDock.GetComponentNames.

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

ScoreAtomComponent

ScoreAtomComponent(atom: OEAtomBase,
                   pose: Union[OEGraphMol,OEMol,OEQMol],
                   compName: str) -> float

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 OEDock.GetComponentNames.

If an error occurs this function will return FLT_MAX if OEDock.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.

AnnotatePose(pose: OEMol) -> bool
AnnotatePose(pose: Union[OEGraphMol,OEQMol]) -> bool

This overload of OEDock.AnnotatePose annotates a single pose.

pose

Structure of a pose within the active site

AnnotatePose(pose: OEMol) -> bool
AnnotatePose(pose: Union[OEGraphMol,OEQMol]) -> bool

This overload of OEDock.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 OEDock object onto a receptor object. When another OEDock 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 OEDock object.

CacheScoringSetup(du: OEDesignUnit, clearOldData: bool = True) -> bool
CacheScoringSetup(receptor: Union[OEGraphMol,OEMol,OEQMol],
                  clearOldData: bool = True) -> bool

receptor

A receptor object. This must be the same receptor object the OEDock 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.