.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlayScore, EonOverlayScore


.. _OEEon_OEEonOverlayScore:

.. oe:class:: OEEonOverlayScore

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlayScore : public OEShape::OEBestOverlayScore

   This class stores results of the shape and electrostatics overlay computation.


   The :ref:`OEEonOverlayScore <OEEon_OEEonOverlayScore>` class defines the following public methods:
       * :oe:meth:`GetTanimoto<OEEon::OEEonOverlayScore::GetTanimoto>`
       * :oe:meth:`GetETTanimoto<OEEon::OEEonOverlayScore::GetETTanimoto>`
       * :oe:meth:`GetTanimotoCombo<OEEon::OEEonOverlayScore::GetTanimotoCombo>`
       * :oe:meth:`GetETOverlap<OEEon::OEEonOverlayScore::GetETOverlap>`
       * :oe:meth:`GetRefSelfET<OEEon::OEEonOverlayScore::GetRefSelfET>`
       * :oe:meth:`GetFitSelfET<OEEon::OEEonOverlayScore::GetFitSelfET>`


   Public methods inherited from the parent class can be found in the :ref:`OEBestOverlayScore <OEShape_OEBestOverlayScore>`.

   .. oe:method:: Constructors

      Default, copy constructor, and the constructor from parent class object.

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

         .. oe:api::

            OEEonOverlayScore()
            OEEonOverlayScore(const OEEonOverlayScore&)
            OEEonOverlayScore(const OEShape::OEBestOverlayScore&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlayScore() -> OEEonOverlayScore
            OEEonOverlayScore(arg2: OEEonOverlayScore) -> OEEonOverlayScore
            OEEonOverlayScore(arg2: OEBestOverlayScore) -> OEEonOverlayScore

   .. oe:method:: Destructor
      
      .. oe:api::

         ~OEEonOverlayScore()


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

      .. oe:api::

         OEEonOverlayScore& operator=(const OEEonOverlayScore&)

      Assignment operator.

   .. _OEEon_OEEonOverlayScore_GetTanimoto:

   .. oe:method:: GetTanimoto

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

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      This method returns the shape Tanimoto.

   .. _OEEon_OEEonOverlayScore_GetETTanimoto:

   .. oe:method:: GetETTanimoto

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

         .. oe:api::

            float GetETTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetETTanimoto() -> float

      This method returns the electrostatic Tanimoto.


   .. _OEEon_OEEonOverlayScore_GetTanimotoCombo:

   .. oe:method:: GetTanimotoCombo

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

         .. oe:api::

            float GetTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimotoCombo() -> float

      This method returns the shape and electrostatics Tanimoto Combo.


   .. _OEEon_OEEonOverlayScore_GetETOverlap:

   .. oe:method:: GetETOverlap

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

         .. oe:api::

            float GetETOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetETOverlap() -> float

      This method returns the electrostatic overlap.

   .. _OEEon_OEEonOverlayScore_GetRefSelfET:

   .. oe:method:: GetRefSelfET

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

         .. oe:api::

            float GetRefSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfET() -> float

      This method returns the electrostatic reference self overlap.

   .. _OEEon_OEEonOverlayScore_GetFitSelfET:

   .. oe:method:: GetFitSelfET

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

         .. oe:api::

            float GetFitSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfET() -> float

      This method returns the electrostatic fit self overlap.
 

