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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonPBOverlay, EonPBOverlay


.. _OEEon_OEEonPBOverlay:

.. oe:class:: OEEonPBOverlay

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonPBOverlay

  This class calculates shape potential similarity overlay. It defines the following public methods:
    * :oe:meth:`SetupRef<OEEon::OEEonPBOverlay::SetupRef>`
    * :oe:meth:`BestOverlay<OEEon::OEEonPBOverlay::BestOverlay>`


   .. oe:method:: Constructors

      Default constructor.

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

         .. oe:api::

            OEEonPBOverlay(const OEShape::OEOverlayOptions& opts = OEShape::OEOverlayOptions(),
                           const OEEon::OEEonPBOptions& pbOpts = OEEon::OEEonPBOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEEonPBOverlay(opts: OEOverlayOptions = OEOverlayOptions(),
                           pbOpts: OEEonPBOptions = OEEonPBOptions()) -> OEEonPBOverlay


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

         ~OEEonPBOverlay()


   .. oe:method:: SetupRef

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

         .. oe:api::

            bool SetupRef(const OEChem::OEMol& query)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(query: OEMol) -> bool

      This method sets up the reference molecule.


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

         .. oe:api::

            bool BestOverlay(OEEonOverlayScore& score,
                             const OEChem::OEMCMolBase& mol,
                             const unsigned numInitHits)

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(score: OEEonOverlayScore, mol: OEMol, numInitHits: int) -> bool

      This method returns the best shape and potential similarity pose. The numInitHits parameter is the number of top shape and charge overlay hits that are rescored with shape and potential single point calculations.