.. oe:namespace:: OEDocking



.. meta::
   :keywords: OEAlignReceptorFunction, AlignReceptorFunction


.. _OEDocking_OEAlignReceptorFunction:

.. oe:class:: OEAlignReceptorFunction

   .. oe:api::

      class OEAlignReceptorFunction

   :ref:`OEAlignReceptorFunction <OEDocking_OEAlignReceptorFunction>` is a pure virtual class that defines an
   API for aligning two receptors.

   This pure virtual class is intended to be subclassed in order to create an
   aligned receptor.  This is necessary because the receptor has multiple
   components that need to be aligned properly, such as the inner and outer
   contours and any bound or extra molecules attached to the receptor.

   .. oe:method:: SetupTarget

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

         .. oe:api::

            bool SetupTarget(const OEChem::OEMolBase& target) = 0

      .. oe:language:: python

         .. oe:api:: python

            SetupTarget(target: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   Called when setting the target molecule.

   .. oe:method:: operator()

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

         .. oe:api::

            virtual OESystem::OEIterBase<const OEChem::OETrans>* operator()(const OEChem::OEMolBase&receptor_to_align) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> Iterable[OETrans]

   Implement to return the transformations that take receptor_to_align into
   the targets reference frame.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            virtual OEAlignReceptorFunction * CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAlignReceptorFunction

   Must return a fully instantiated OEAlignReceptor.
