.. oe:namespace:: OEShape



.. meta::
   :keywords: OEROCSResult, ROCSResult


.. _OEShape_OEROCSResult:

.. oe:class:: OEROCSResult

   .. oe:api::


      class OEROCSResult : public OEOverlapResults

   This class extends the :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` to represent the results of
   a single :ref:`OEROCS <OEShape_OEROCS>` calculation.

   The following methods are publicly inherited from :ref:`OEOverlapResults <OEShape_OEOverlapResults>`:
    * :oe:meth:`GetColorScore<OEShape::OEOverlapResults::GetColorScore>`
    * :oe:meth:`GetColorTanimoto<OEShape::OEOverlapResults::GetColorTanimoto>` 
    * :oe:meth:`GetColorTversky<OEShape::OEOverlapResults::GetColorTversky>`
    * :oe:meth:`GetFitColorTversky<OEShape::OEOverlapResults::GetFitColorTversky>` 
    * :oe:meth:`GetFitSelfColor<OEShape::OEOverlapResults::GetFitSelfColor>`
    * :oe:meth:`GetFitSelfOverlap<OEShape::OEOverlapResults::GetFitSelfOverlap>`
    * :oe:meth:`GetFitTversky<OEShape::OEOverlapResults::GetFitTversky>` 
    * :oe:meth:`GetFitTverskyCombo<OEShape::OEOverlapResults::GetFitTverskyCombo>`
    * :oe:meth:`GetOverlap<OEShape::OEOverlapResults::GetOverlap>`
    * :oe:meth:`GetRefColorTversky<OEShape::OEOverlapResults::GetRefColorTversky>` 
    * :oe:meth:`GetRefSelfColor<OEShape::OEOverlapResults::GetRefSelfColor>`
    * :oe:meth:`GetRefSelfOverlap<OEShape::OEOverlapResults::GetRefSelfOverlap>`
    * :oe:meth:`GetRefTversky<OEShape::OEOverlapResults::GetRefTversky>` 
    * :oe:meth:`GetRefTverskyCombo<OEShape::OEOverlapResults::GetRefTverskyCombo>`
    * :oe:meth:`GetTanimoto<OEShape::OEOverlapResults::GetTanimoto>`
    * :oe:meth:`GetTanimotoCombo<OEShape::OEOverlapResults::GetTanimotoCombo>` 
    * :oe:meth:`GetTversky<OEShape::OEOverlapResults::GetTversky>`

   The following methods are publicly inherited from :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>`:
    * :oe:meth:`GetFitConfIdx<OEShape::OEBestOverlayScore::GetFitConfIdx>`
    * :oe:meth:`GetRefConfIdx<OEShape::OEBestOverlayScore::GetRefConfIdx>` 
    * :oe:meth:`GetRotMatrix<OEShape::OEBestOverlayScore::GetRotMatrix>`
    * :oe:meth:`GetTranslation<OEShape::OEBestOverlayScore::GetTranslation>` 
    * :oe:meth:`Transform<OEShape::OEBestOverlayScore::Transform>`

   The :ref:`OEROCSResult <OEShape_OEROCSResult>` class defines the following public methods:
    * :oe:meth:`AddScore<OEShape::OEROCSResult::AddScore>`
    * :oe:meth:`GetOverlayConf<OEShape::OEROCSResult::GetOverlayConf>` 
    * :oe:meth:`GetOverlayConfs<OEShape::OEROCSResult::GetOverlayConfs>`
    
   .. oe:method:: Constructors

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

         .. oe:api::

            OEROCSResult()
            OEROCSResult(const OEBestOverlayScore&, const OEChem::OEMCMolBase&)
            OEROCSResult(const OEROCSResult&)

      .. oe:language:: python

         .. oe:api:: python

            OEROCSResult() -> OEROCSResult
            OEROCSResult(argScore: OEBestOverlayScore, argFitMol: OEMol) -> OEROCSResult
            OEROCSResult(argResult: OEROCSResult) -> OEROCSResult

      Default and copy constructors. The second constructor takes in an instance of a
      :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>` and the corresponding fit molecule.

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

      .. oe:api::

         OEROCSResult &operator=(const OEROCSResult&)

      Assignment operator.


   .. oe:method:: AddScore

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

         .. oe:api::

            void AddScore(const OEBestOverlayScore&, const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            AddScore(argScore: OEBestOverlayScore, argFitMol: OEMol) -> None

      Add a new conformer to the score.  This method is useful for generating a
      multi-conformer :ref:`OEROCSResult <OEShape_OEROCSResult>`.

   .. oe:method:: GetOverlayConf

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

         .. oe:api::

            const OEChem::OEMolBase& GetOverlayConf() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayConf() -> OEGraphMol

      Returns the best hit conformer in the overlaid state.

   .. oe:method:: GetOverlayConfs

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

         .. oe:api::

            const OEChem::OEMCMolBase& GetOverlayConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayConfs() -> OEMol

      Returns the best hit conformers in the overlaid state, for a multi-conformer result.
