.. include:: ../substitutions
.. include:: ../../common/cookbook/cookbook-hyperlinks

.. oe:namespace:: OEBio

.. meta::
   :keywords: OEPerceiveInteractionHints

..  _oebio_oeperceiveinteractionhints:

.. oe:function:: OEPerceiveInteractionHints

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

      .. oe:api::

         bool OEPerceiveInteractionHints(OEBio::OEInteractionHintContainer& asite)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveInteractionHints(asite: OEInteractionHintContainer) -> bool

   Perceives potential interaction types between a protein and a ligand
   stored in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object using default
   parameters.

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

      .. oe:api::

         bool OEPerceiveInteractionHints(OEBio::OEInteractionHintContainer& asite,
                                         const OEPerceiveInteractionOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEPerceiveInteractionHints(asite: OEInteractionHintContainer,
                                    opts: OEPerceiveInteractionOptions) -> bool

   Perceives potential interaction types between a protein and a ligand
   stored in the :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object using the
   given parameters (:ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>`).
   The molecules stored in ``asite`` must have 3D coordinates assigned and should also have radii assigned to the atoms.

   .. seealso::

      * [Kumar-2002]_
      * [Cavallo-2016]_
      * [Bissantz-2010]_
      * [Marcou-2007]_

   The following interaction types are currently perceived:

   * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`    (see also :oe:constns:`OEBio::OECationPiInteractionHintType` namespace)
   * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`    (see also :oe:constns:`OEBio::OEChelatorInteractionHintType` namespace)
   * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
   * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
   * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
   * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` (see also :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace)
   * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`       (see also :oe:constns:`OEBio::OEHBondInteractionHintType` namespace)
   * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`  (see also :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace)
   * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`    (see also :oe:constns:`OEBio::OEStackingInteractionHintType` namespace)


   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * :ref:`section_examples_summary_complex2img` **Grapheme TK** example
      * `Accessing Interaction Hint Information`_ **OpenEye Python Cookbook** recipe
