.. oe:namespace:: OEShape



.. meta::
   :keywords: OEMultiRefOverlay, MultiRefOverlay


.. _OEShape_OEMultiRefOverlay:

.. oe:class:: OEMultiRefOverlay

   .. oe:api::


      class OEMultiRefOverlay

   .. note::

      With the default settings, the :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` optimizes
      both shape and color.

   The :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` provides an extension to :ref:`OEOverlay <OEShape_OEOverlay>` to enable setting up a multi-conformer molecule
   as the reference system for overlay optimization between a reference and a fit 
   molecule conformers.

   The :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` class defines the following public methods:
    * :oe:meth:`BestOverlay<OEShape::OEMultiRefOverlay::BestOverlay>`
    * :oe:meth:`GetOverlayOptions<OEShape::OEMultiRefOverlay::GetOverlayOptions>`
    * :oe:meth:`Overlay<OEShape::OEMultiRefOverlay::Overlay>`
    * :oe:meth:`SetupRef<OEShape::OEMultiRefOverlay::SetupRef>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMultiRefOverlay(const OEOverlayOptions& argOptions = OEOverlayOptions())
            OEMultiRefOverlay(const OEMultiRefOverlay&)

      .. oe:language:: python

         .. oe:api:: python

            OEMultiRefOverlay(argOptions: OEOverlayOptions = OEOverlayOptions()) -> OEMultiRefOverlay
            OEMultiRefOverlay(argOverlay: OEMultiRefOverlay) -> OEMultiRefOverlay

      Default and copy constructors.

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

      .. oe:api::

         OEMultiRefOverlay &operator=(const OEMultiRefOverlay &)

      Assignment operator.


   .. oe:method:: BestOverlay

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

         .. oe:api::

            bool BestOverlay(OEBestOverlayScore& argScore, const OEChem::OEMCMolBase& argFitMol,
            const OESystem::OEBinaryPredicate<OEBestOverlayScore, OEBestOverlayScore>& argPred = OEHighestTanimotoCombo())

      .. oe:language:: python

         .. oe:api:: python

            BestOverlay(argScore: OEBestOverlayScore, argFitMol: OEMol,
                        argPred: OEBestOverlayScoreSorterPred = OEHighestTanimotoCombo()) -> bool

      Method optimizes the overlay between the reference object and the fit
      molecule conformers, and returns the best result.  The reference object must be set using the
      :oe:meth:`SetupRef<OEShape::OEMultiRefOverlay::SetupRef>` method.

   .. oe:method:: GetOverlayOptions

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

         .. oe:api::

            const OEOverlayOptions& GetOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlayOptions() -> OEOverlayOptions

      Returns a reference to the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>`
      instance as currently set. This defines options to calculate Overlay.

   .. oe:method:: Overlay

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

         .. oe:api::

            OESystem::OEIterBase<OEBestOverlayResults>* Overlay(const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            Overlay(argFitMol: OEMol) -> Iterable[OEBestOverlayResults]

      Method optimizes the Overlay between the reference molecule and the fit
      molecule conformers.  The reference molecule must be set using the
      :oe:meth:`SetupRef<OEShape::OEMultiRefOverlay::SetupRef>` method.

   .. oe:method:: SetupRef

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

         .. oe:api::

            bool SetupRef(const OEChem::OEMCMolBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(argRefMol: OEMol) -> bool

      Method defines the interface for setting up the reference system for the :ref:`OEMultiRefOverlay <OEShape_OEMultiRefOverlay>` instance with a multi-conformer molecule.
