OEPosit

class OEPosit

OEPosit is used to pose predict multiconformer molecules in an active site.

The OEPosit class defines the following public methods:
Deprecated methods of the class:

Constructor

OEPosit( const OEPositOptions &options = OEPositOptions() )
OEPosit(const OEPosit &)

Default and copy constructors.

operator=

OEPosit &operator=(const OEPosit &)

AddReceptor

bool AddReceptor(const OEBio::OEDesignUnit&)
bool AddReceptor(const OEChem::OEMolBase&)

Adds a receptor to the list of receptors to pose against. The function returns true if receptor is addded successful. 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

Since OEPosit can generate pose using any of the methods described in OEPositMethod, constraints present in the receptor may or may not play any role for the specific pose generation. Constraints only effect the generated pose when OEPositMethod.FRED or OEPositMethod.HYBRID is the underlying method.

ClearReceptors

void ClearReceptors()

Removes all existing receptors. Removing receptors will un-initialize an already initialized OEPosit instance.

Dock

unsigned Dock(OESinglePoseResult &res, const OEChem::OEMCMolBase& mol) const;
unsigned Dock(OEPositResults &res, const OEChem::OEMCMolBase& mol,
               const unsigned numPoses = 1) const

Dock the input molecule mol. The second overload can return alternate docked poses, in addition to the top scoring pose, with numPoses being the maximum desired number of poses.

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.

GetHighScoresAreBetter

bool GetHighScoresAreBetter() const

This always returns true for OEPosit.

GetName

std::string GetName() const

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

GetInvalidScore

float  GetInvalidScore() const

Returns the invalid score returned by OEPosit. These values are set up to sort invalid values in reverse order from the best reported values.

IsInitialized

bool IsInitialized() const

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

RankDesignUnits

OESystem::OEIterBase<OEBio::OEDesignUnit>* OEPosit::RankDesignUnits(const OEChem::OEMCMolBase&) const

Rank the design units, from best to worst receptors, to pose against, for the specified ligand.

DockMultiConformerMolecule

Warning

This is a deprecated API. Please use Dock instead.

Both overloads of this method dock inputMol into the receptor added by the OEPosit.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.

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

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

dockedMol

Docked pose with the best pose prediction probability 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.

Initialize

Warning

This is a deprecated API. Please use AddReceptor instead.

bool Initialize(const OEChem::OEMolBase& receptor)

Initializes OEPosit with receptor to pose ligand against. Calling initialize will remove any existing receptors in the current OEPosit instance. Function returns true if setup was successful and false otherwise.

RankReceptors

Warning

This is a deprecated API. Please use RankDesignUnits instead.

OESystem::OEIterBase<OEChem::OEMolBase>* OEPosit::RankReceptors(const OEChem::OEMCMolBase&) const

Rank the receptors, from best to worst, to pose against, for the specified ligand.

ScoreLigand

Warning

This is a deprecated API. This method is only compatible with DockMultiConformerMolecule, for obtaining a score (pose probability) after the pose has been generated.

Method provides invalid score when called on poses generated using Dock. The scores (pose probability) from that calculation are available in the resulting OESinglePoseResult.

float ScoreLigand(const OEChem::OEMolBase& pose) const

Rescores a pose within the active site.

If an error occurs this function will return the limiting large double in C++.