.. oe:namespace:: OEShape

.. meta::
   :keywords: OEROCSOverlay

.. oe:function:: OEROCSOverlay

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

      .. oe:api::

         bool OEROCSOverlay(OEROCSResult& argResult,
                            const OEChem::OEMCMolBase& argQuery,
                            const OEChem::OEMCMolBase& argFitMol,
                            const OEROCSOptions& argOptions = OEROCSOptions())
         bool OEROCSOverlay(OEROCSResult& argResult,
                            const OEChem::OEMolBase& argQuery,
                            const OEChem::OEMCMolBase& argFitMol,
                            const OEROCSOptions& argOptions = OEROCSOptions())
         bool OEROCSOverlay(OEROCSResult& argResult,
                            const OEChem::OEMolBase& argQuery,
                            const OEChem::OEMolBase& argFitMol,
                            const OEROCSOptions& argOptions = OEROCSOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEROCSOverlay(argResult: OEROCSResult, argQuery: OEMol,
                       argFitMol: OEMol,
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool
         OEROCSOverlay(argResult: OEROCSResult,
                       argQuery: Union[OEGraphMol,OEQMol], argFitMol: OEMol,
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool
         OEROCSOverlay(argResult: OEROCSResult,
                       argQuery: Union[OEGraphMol,OEMol,OEQMol],
                       argFitMol: Union[OEGraphMol,OEQMol],
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool
         OEROCSOverlay(argResult: OEROCSResult,
                       argQuery: Union[OEGraphMol,OEMol,OEQMol],
                       argFitMol: Union[OEGraphMol,OEMol,OEQMol],
                       argOptions: OEROCSOptions = OEROCSOptions()) -> bool

   Calculate the overlay between the query and the fit molecule.  Returns `True` if
   calculation completed successfully.  The first argument returns the results of the
   single best hit.

   .. note::

      This function sets up the reference system in :ref:`OEROCS <OEShape_OEROCS>`
      every time it is called, even if it is called with the same reference object. 
      This can have unexpected performance issues if the function is used in a loop.
