.. oe:namespace:: OESiteHopper



.. _OESiteHopper_OESiteHopperResults:

.. oe:class:: OESiteHopperResults

   .. oe:api::


      class OESiteHopperResults

   This is a class used inside the SiteHopper search. User results 
   user the :ref:`OESiteHopperScore <OESiteHopper_OESiteHopperScore>` class.

   
   The following classes derive from this class:
    * :ref:`OESiteHopperScore <OESiteHopper_OESiteHopperScore>`
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESiteHopperResults()
            OESiteHopperResults(OESiteHopperResults &&rhs)
            OESiteHopperResults(const OESiteHopperResults& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperResults() -> OESiteHopperResults
            OESiteHopperResults(rhs: OESiteHopperResults) -> OESiteHopperResults

      Default constructors.

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

      .. oe:api::

         OESiteHopperResults &operator=(OESiteHopperResults &&rhs)
         OESiteHopperResults &operator=(const OESiteHopperResults &rhs)

      Assignment operator.


   .. oe:method:: GetColorScale

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

         .. oe:api::

            float GetColorScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScale() -> float

      Get scale factor applied to color Tanimoto to get PatchScore.

      [default: 3.0]

   .. oe:method:: GetColorTanimoto

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

         .. oe:api::

            float GetColorTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorTanimoto() -> float

      Get color Tanimoto from the patch overlay.

   .. oe:method:: GetPatchScore

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

         .. oe:api::

            float GetPatchScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetPatchScore() -> float

      Get PatchScore from overlay. This score is Shape Tanimoto + ScaleFactor * Color Tanimoto.

   .. oe:method:: GetRank

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

         .. oe:api::

            unsigned int GetRank() const

      .. oe:language:: python

         .. oe:api:: python

            GetRank() -> int

      Get the rank in the hitlist.

   .. oe:method:: GetSequenceSimilarity

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

         .. oe:api::

            float GetSequenceSimilarity() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceSimilarity() -> float

      Get sequence similarity between referance patch protein and fit patch protein.

   .. oe:method:: GetShapeTanimoto

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

         .. oe:api::

            float GetShapeTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeTanimoto() -> float

      Get Shape Tanimoto from overlay.

   .. oe:method:: SetColorScale

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

         .. oe:api::

            void SetColorScale(float scale)

      .. oe:language:: python

         .. oe:api:: python

            SetColorScale(scale: float) -> None

      Set scale factor applied to color Tanimoto to get PatchScore.

      [default: 3.0]

   .. oe:method:: SetColorTanimoto

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

         .. oe:api::

            void SetColorTanimoto(float score)

      .. oe:language:: python

         .. oe:api:: python

            SetColorTanimoto(score: float) -> None

   .. oe:method:: SetRank

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

         .. oe:api::

            void SetRank(unsigned int rank)

      .. oe:language:: python

         .. oe:api:: python

            SetRank(rank: int) -> None

   .. oe:method:: SetSequenceSimilarity

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

         .. oe:api::

            void SetSequenceSimilarity(float similarity)

      .. oe:language:: python

         .. oe:api:: python

            SetSequenceSimilarity(similarity: float) -> None

   .. oe:method:: SetShapeTanimoto

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

         .. oe:api::

            void SetShapeTanimoto(float score)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeTanimoto(score: float) -> None

