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


.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHermiteOverlay, HermiteOverlay


.. _OEShape_OEHermiteOverlay:

.. oe:class:: OEHermiteOverlay
   
   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHermiteOverlay

   The :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` defines an interface for overlap optimization
   between a reference object (a molecule, grid, shape query, or Hermite) and a fit object (molecule
   conformers, grid, or Hermite).

   .. note::

      Currently :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` optimizes shape only.


   The :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` class defines the following public methods:
    * :oe:meth:`BestOverlay<OEShape::OEHermiteOverlay::BestOverlay>`
    * :oe:meth:`SetupRef<OEShape::OEHermiteOverlay::SetupRef>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHermiteOverlay(const OEHermiteOverlayOptions& hermOverlayOpts = OEHermiteOverlayOptions())
            OEHermiteOverlay(const OEHermiteOverlay&)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteOverlay(hermOverlayOpts: OEHermiteOverlayOptions = OEHermiteOverlayOptions()) -> OEHermiteOverlay
            OEHermiteOverlay(arg2: OEHermiteOverlay) -> OEHermiteOverlay

      Default and copy constructors.

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

      .. oe:api::

         OEHermiteOverlay &operator=(const OEHermiteOverlay &)

.. _OEShape_OEHermiteOverlay_BestOverlay:

      Assignment operator.


   .. oe:method:: BestOverlay

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

         .. oe:api::

            bool BestOverlay(OEBestOverlayScore& score,
                             const OEHermite& fitherm,
                             const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter = OEHighestTanimoto())
            bool BestOverlay(OEBestOverlayScore& score,
                             const OEChem::OEMCMolBase& fitmol,
                             const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter = OEHighestTanimoto())
            bool BestOverlay(OEBestOverlayScore& score,
                             const OESystem::OEScalarGrid& fitgrid,
                             const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& sorter = OEHighestTanimoto())

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(score: OEBestOverlayScore, fitherm: OEHermite,
                        sorter: OEBestOverlayScoreSorterPred = OEHighestTanimoto()) -> bool
            BestOverlay(score: OEBestOverlayScore, fitmol: OEMol,
                        sorter: OEBestOverlayScoreSorterPred = OEHighestTanimoto()) -> bool
            BestOverlay(score: OEBestOverlayScore, fitgrid: OEScalarGrid,
                        sorter: OEBestOverlayScoreSorterPred = OEHighestTanimoto()) -> bool

      This method optimizes the overlay between the reference object and the fit object (molecule conformers,
      grid, or Hermite), and returns the best result, sorted based on the binary predicate ``sorter``.
      The predicate has a default setting of :ref:`OEHighestTanimoto <OEShape_OEHighestTanimoto>`. 
      The reference object must be set using the :oe:meth:`SetupRef<OEShape::OEHermiteOverlay::SetupRef>` method prior to calling this method.

.. _OEShape_OEHermiteOverlay_SetupRef:

   .. oe:method:: SetupRef

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

         .. oe:api::

            bool SetupRef(const OEHermite& refherm)
            bool SetupRef(const OEChem::OEMolBase& refmol)
            bool SetupRef(const OESystem::OEScalarGrid& refgrid)
            bool SetupRef(const OEShapeQuery& query)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(refherm: OEHermite) -> bool
            SetupRef(refmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool
            SetupRef(refgrid: OEScalarGrid) -> bool
            SetupRef(query: OEShapeQuery) -> bool

      This method defines the interface for setting up the reference system for the 
      :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>` instance with a molecule, grid, shape query,
      or Hermite object.
