.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPositProbability, PositProbability


.. _OEDocking_OEPositProbability:

.. oe:class:: OEPositProbability

   .. oe:api::

      class OEPositProbability

   The :ref:`OEPositProbability <OEDocking_OEPositProbability>` can be used to estimate
   confidence, in terms of probability, that a ligand pose can be accurately predicted,
   with respect to the reference ligand or design unit receptor.

   This function is helpful in selecting a receptor or reference ligand to pose against 
   from a group of receptors.

   The :ref:`OEPositProbability <OEDocking_OEPositProbability>` class defines the following public methods:
    * :oe:meth:`Estimate<OEDocking::OEPositProbability::Estimate>`
    * :oe:meth:`PoseEstimate<OEDocking::OEPositProbability::PoseEstimate>`
    * :oe:meth:`SetupRef<OEDocking::OEPositProbability::SetupRef>`

   .. oe:method:: Constructor

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPositProbability()
            OEPositProbability(const OEPositProbability &)

      .. oe:language:: python

         .. oe:api:: python

            OEPositProbability() -> OEPositProbability
            OEPositProbability(arg2: OEPositProbability) -> OEPositProbability

   Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPositProbability &operator=(const OEPositProbability &)

      Assignment operator.



   .. oe:method:: Estimate
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            double Estimate(const OEChem::OEMolBase& mol)
            double Estimate(const OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Estimate(mol: Union[OEGraphMol,OEQMol]) -> float
            Estimate(mol: OEMol) -> float

      Provides the estimated probability.  With the :ref:`OEMolBase <OEChem_OEMolBase>`
      variation of the argument, multi-conformer molecule is generated with
      internal settings before producing an estimate.


   .. oe:method:: PoseEstimate
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            double PoseEstimate(const OEChem::OEMolBase& mol,
                                const unsigned poseMethod = OEPositMethod::UNKNOWN)

      .. oe:language:: python

         .. oe:api:: python

            PoseEstimate(mol: Union[OEGraphMol,OEMol,OEQMol], poseMethod: int) -> float

      Provides estimated probability assuming that the specified ligand pose was
      generated with the reference used in :oe:meth:`SetupRef<OEDocking::OEPositProbability::SetupRef>`. 
      The second argument ``poseMethod`` refers to specific methods from
      :oe:constns:`OEDocking::OEPositMethod`.


   .. oe:method:: SetupRef
   
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase& ligand)
            bool SetupRef(const OEBio::OEDesignUnit& du)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(ligand: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(du: OEDesignUnit) -> bool

      Sets up the reference system against which the pose is to be generated.
