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

.. oe:namespace:: OEBio


.. _OEBio_OEPerceiveInteractionOptions:

.. oe:class:: OEPerceiveInteractionOptions

   .. oe:api::

      class OEPerceiveInteractionOptions

   This class is a container for all the parameters that control interaction
   perception when
   invoking the :oe:func:`OEBio::OEPerceiveInteractionHints` function.


   The current list of interactions include:

   * **cation-pi**          (see also :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`    class and :oe:constns:`OEBio::OECationPiInteractionHintType`    namespace)
   * **clashes**            (see also :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`       class)
   * **contacts**           (see also :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`     class)
   * **metal interactions** (see also :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`    class and :oe:constns:`OEBio::OEChelatorInteractionHintType`    namespace)
   * **covalents**          (see also :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`    class)
   * **halogen bonds**      (see also :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class and :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace)
   * **hydrogen bonds**     (see also :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`       class and :oe:constns:`OEBio::OEHBondInteractionHintType`       namespace)
   * **salt-bridges**       (see also :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`  class and :oe:constns:`OEBio::OESaltBridgeInteractionHintType`  namespace)
   * **Pi and T stacking**  (see also :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`    class and :oe:constns:`OEBio::OEStackingInteractionHintType`    namespace)

   Each interaction type has one or more parameters that control its perception.
   In  addition, hydrogen-bonding clashes, intramolecular hydrogen-bonds,
   unpaired hydrogen-bonds and  unpaired salt-bridges are also perceived.
   Unpaired interactions are those that are near the protein-ligand interface,
   but do not form an apparent bond.

   .. seealso::

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


   .. list-table::
      :widths: 100 100 100 100

      * - Get method
        - Set method
        - Interaction type(s)
        - Default value

      * - :oe:meth:`GetExtendedSaltBridgeDistance<OEBio::OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance>`
        -
        - salt bridge
        -

      * - :oe:meth:`GetMaxAcceptorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxAcceptorAngle>`
        - :oe:meth:`SetMaxAcceptorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle>`
        - hbond
        - 30 degrees

      * - :oe:meth:`GetMaxAtomPairDistance<OEBio::OEPerceiveInteractionOptions::GetMaxAtomPairDistance>`
        -
        -
        -

      * - :oe:meth:`GetMaxCationPiAngle<OEBio::OEPerceiveInteractionOptions::GetMaxCationPiAngle>`
        - :oe:meth:`SetMaxCationPiAngle<OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle>`
        - cation-Pi
        - 50 degrees

      * - :oe:meth:`GetMaxCationPiDistance<OEBio::OEPerceiveInteractionOptions::GetMaxCationPiDistance>`
        - :oe:meth:`SetMaxCationPiDistance<OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance>`
        - cation-Pi
        - 5.5 |Angstroms|

      * - :oe:meth:`GetMaxChargeAidedHBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxChargeAidedHBondDistance>`
        - :oe:meth:`SetMaxChargeAidedHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance>`
        - hbond
        - 3.5 |Angstroms|

      * - :oe:meth:`GetMaxContactFraction<OEBio::OEPerceiveInteractionOptions::GetMaxContactFraction>`
        - :oe:meth:`SetMaxContactFraction<OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction>`
        - contact
        - 1.2

      * - :oe:meth:`GetMaxCovalentFraction<OEBio::OEPerceiveInteractionOptions::GetMaxCovalentFraction>`
        - :oe:meth:`SetMaxCovalentFraction<OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction>`
        - covalent
        - 1.1

      * - :oe:meth:`GetMaxDonorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxDonorAngle>`
        - :oe:meth:`SetMaxDonorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle>`
        - hbond
        - 35 degrees

      * - :oe:meth:`GetMaxHBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxHBondDistance>`
        - :oe:meth:`SetMaxHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance>`
        - hbond
        - 3.2 |Angstroms|

      * - :oe:meth:`GetMaxHalogenAngle<OEBio::OEPerceiveInteractionOptions::GetMaxHalogenAngle>`
        - :oe:meth:`SetMaxHalogenAngle<OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle>`
        - halogen bond
        - 35 degrees

      * - :oe:meth:`GetMaxHalogenBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxHalogenBondDistance>`
        - :oe:meth:`SetMaxHalogenBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance>`
        - halogen bond
        - 3.2 |Angstroms|

      * - :oe:meth:`GetMaxMetalBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxMetalBondDistance>`
        - :oe:meth:`SetMaxMetalBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxMetalBondDistance>`
        - chelator
        - 3.5 |Angstroms|

      * - :oe:meth:`GetMaxNonIdealAcceptorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealAcceptorAngle>`
        - :oe:meth:`SetMaxNonIdealAcceptorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealAcceptorAngle>`
        - hbond
        - 30 degrees

      * - :oe:meth:`GetMaxNonIdealDonorAngle<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealDonorAngle>`
        - :oe:meth:`SetMaxNonIdealDonorAngle<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealDonorAngle>`
        - hbond
        - 45 degrees

      * - :oe:meth:`GetMaxNonIdealHBondDistance<OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealHBondDistance>`
        - :oe:meth:`SetMaxNonIdealHBondDistance<OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance>`
        - hbond
        - 3.8 |Angstroms|

      * - :oe:meth:`GetMaxPiStackAngle<OEBio::OEPerceiveInteractionOptions::GetMaxPiStackAngle>`
        - :oe:meth:`SetMaxPiStackAngle<OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle>`
        - Pi-stacking
        - :math:`\frac{\pi}{9.0}`

      * - :oe:meth:`GetMaxPiStackDistance<OEBio::OEPerceiveInteractionOptions::GetMaxPiStackDistance>`
        - :oe:meth:`SetMaxPiStackDistance<OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance>`
        - Pi-stacking
        - 5.0 |Angstroms|

      * - :oe:meth:`GetMaxProteinIntraDistance<OEBio::OEPerceiveInteractionOptions::GetMaxProteinIntraDistance>`
        - :oe:meth:`SetMaxProteinIntraDistance<OEBio::OEPerceiveInteractionOptions::SetMaxProteinIntraDistance>`
        - intramolecular (protein)
        - 6.0 |Angstroms|

      * - :oe:meth:`GetMaxSaltBridgeDistance<OEBio::OEPerceiveInteractionOptions::GetMaxSaltBridgeDistance>`
        - :oe:meth:`SetMaxSaltBridgeDistance<OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance>`
        - salt bridge
        - 5.0 |Angstroms|

      * - :oe:meth:`GetMaxTStackAngle<OEBio::OEPerceiveInteractionOptions::GetMaxTStackAngle>`
        - :oe:meth:`SetMaxTStackAngle<OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle>`
        - T-stacking
        - :math:`\frac{\pi}{9.0}`

      * - :oe:meth:`GetMaxTStackDistance<OEBio::OEPerceiveInteractionOptions::GetMaxTStackDistance>`
        - :oe:meth:`SetMaxTStackDistance<OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance>`
        - T-stacking
        - 5.35 |Angstroms|

      * - :oe:meth:`GetMaxUnpairedAngle<OEBio::OEPerceiveInteractionOptions::GetMaxUnpairedAngle>`
        - :oe:meth:`SetMaxUnpairedAngle<OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle>`
        - hbond
        - :math:`\frac{\pi}{2}`

      * - :oe:meth:`GetMaxUnpairedDistance<OEBio::OEPerceiveInteractionOptions::GetMaxUnpairedDistance>`
        - :oe:meth:`SetMaxUnpairedDistance<OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance>`
        - hbond
        - 5.0 |Angstroms|

      * - :oe:meth:`GetMinContactFraction<OEBio::OEPerceiveInteractionOptions::GetMinContactFraction>`
        - :oe:meth:`SetMinContactFraction<OEBio::OEPerceiveInteractionOptions::SetMinContactFraction>`
        - contact, clash
        - 0.8

      * - :oe:meth:`GetMinCovalentFraction<OEBio::OEPerceiveInteractionOptions::GetMinCovalentFraction>`
        - :oe:meth:`SetMinCovalentFraction<OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction>`
        - covalent
        - 0.9

      * - :oe:meth:`GetMinHBondContactFraction<OEBio::OEPerceiveInteractionOptions::GetMinHBondContactFraction>`
        - :oe:meth:`SetMinHBondContactFraction<OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction>`
        - hbond
        - 0.5

      * - :oe:meth:`GetMinStackOffset<OEBio::OEPerceiveInteractionOptions::GetMinStackOffset>`
        - :oe:meth:`SetMinStackOffset<OEBio::OEPerceiveInteractionOptions::SetMinStackOffset>`
        - Pi-stacking, T-stacking
        - 0.5 |Angstroms|

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPerceiveInteractionOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEPerceiveInteractionOptions() -> OEPerceiveInteractionOptions
            OEPerceiveInteractionOptions(arg2: OEPerceiveInteractionOptions) -> OEPerceiveInteractionOptions

      The default constructor for perception of interaction options.  It sets all of the interaction parameters
      to their default value.


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

      .. oe:api::

         OEPerceiveInteractionOptions & operator=(const OEPerceiveInteractionOptions &)

      Assignment operator.



   .. oe:method:: GetExtendedSaltBridgeDistance

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

         .. oe:api::

            double GetExtendedSaltBridgeDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtendedSaltBridgeDistance() -> float

      Actual salt bridge interaction distance is calculated from the geometric centers of the two interacting
      charge groups, which may or may not be comprised of a single atom.  The distance returned by this function
      is the maximum distance between two formally charged atoms for subsequent identification of charge groups.
      This is a simple increment larger than the value associated with
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxSaltBridgeDistance` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance`.


   .. oe:method:: GetMaxAcceptorAngle

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

         .. oe:api::

            double GetMaxAcceptorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAcceptorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle`.


   .. oe:method:: GetMaxAtomPairDistance

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

         .. oe:api::

            double GetMaxAtomPairDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtomPairDistance() -> float

      Returns the maximum value of

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxHBondDistance`,
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxChargeAidedHBondDistance`,
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxMetalBondDistance`,
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance`, and
      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxHalogenBondDistance`.


   .. oe:method:: GetMaxCationPiAngle

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

         .. oe:api::

            double GetMaxCationPiAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCationPiAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle`.


   .. oe:method:: GetMaxCationPiDistance

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

         .. oe:api::

            double GetMaxCationPiDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCationPiDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance`.


   .. oe:method:: GetMaxChargeAidedHBondDistance

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

         .. oe:api::

            double GetMaxChargeAidedHBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxChargeAidedHBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance`.


   .. oe:method:: GetMaxContactFraction

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

         .. oe:api::

            double GetMaxContactFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxContactFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`.


   .. oe:method:: GetMaxCovalentFraction

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

         .. oe:api::

            double GetMaxCovalentFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCovalentFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction`.


   .. oe:method:: GetMaxDonorAngle

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

         .. oe:api::

            double GetMaxDonorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxDonorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle`.


   .. oe:method:: GetMaxHBondDistance

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

         .. oe:api::

            double GetMaxHBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance`.


   .. oe:method:: GetMaxHalogenAngle

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

         .. oe:api::

            double GetMaxHalogenAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHalogenAngle() -> float


      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle`.


   .. oe:method:: GetMaxHalogenBondDistance

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

         .. oe:api::

            double GetMaxHalogenBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHalogenBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance`.


   .. oe:method:: GetMaxMetalBondDistance

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

         .. oe:api::

            double GetMaxMetalBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMetalBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxMetalBondDistance`.

   .. oe:method:: GetMaxNonIdealAcceptorAngle

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

         .. oe:api::

            double GetMaxNonIdealAcceptorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNonIdealAcceptorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealAcceptorAngle`.

   .. oe:method:: GetMaxNonIdealDonorAngle

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

         .. oe:api::

            double GetMaxNonIdealDonorAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNonIdealDonorAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealDonorAngle`.

   .. oe:method:: GetMaxNonIdealHBondDistance

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

         .. oe:api::

            double GetMaxNonIdealHBondDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNonIdealHBondDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance`.

   .. oe:method:: GetMaxPiStackAngle

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

         .. oe:api::

            double GetMaxPiStackAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxPiStackAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle`.


   .. oe:method:: GetMaxPiStackDistance

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

         .. oe:api::

            double GetMaxPiStackDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxPiStackDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance`.


   .. oe:method:: GetMaxProteinIntraDistance

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

         .. oe:api::

            double GetMaxProteinIntraDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxProteinIntraDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxProteinIntraDistance`.


   .. oe:method:: GetMaxSaltBridgeDistance

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

         .. oe:api::

            double GetMaxSaltBridgeDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSaltBridgeDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance`.


   .. oe:method:: GetMaxTStackAngle

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

         .. oe:api::

            double GetMaxTStackAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTStackAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle`.


   .. oe:method:: GetMaxTStackDistance

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

         .. oe:api::

            double GetMaxTStackDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxTStackDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance`.


   .. oe:method:: GetMaxUnpairedAngle

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

         .. oe:api::

            double GetMaxUnpairedAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxUnpairedAngle() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle`.


   .. oe:method:: GetMaxUnpairedDistance

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

         .. oe:api::

            double GetMaxUnpairedDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxUnpairedDistance() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance`.

   .. oe:method:: GetMinContactFraction

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

         .. oe:api::

            double GetMinContactFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinContactFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.


   .. oe:method:: GetMinCovalentFraction

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

         .. oe:api::

            double GetMinCovalentFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinCovalentFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction`.


   .. oe:method:: GetMinHBondContactFraction

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

         .. oe:api::

            double GetMinHBondContactFraction() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinHBondContactFraction() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction`.


   .. oe:method:: GetMinStackOffset

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

         .. oe:api::

            double GetMinStackOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinStackOffset() -> float

      Returns the value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinStackOffset`.


   .. oe:method:: SetMaxAcceptorAngle

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

         .. oe:api::

            void SetMaxAcceptorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAcceptorAngle(radians: float) -> None

      In perception of a hydrogen bond, we define the angle :math:`X-A...D`, where **A** and **D** are the acceptor
      and donor respectively, and **X** is one or more points in space that are located so that an idealized
      hydrogen-bond would give an angle of :math:`\pi`.  The maximum acceptor angle is the maximum allowed deviation (in
      radians) from the idealized angle (or the minimum deviation from multiple angles when more than one
      **X** position is possible).

      **Default=** :math:`(\pi * \frac{6.0}{36.0})` **= 30 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method


   .. oe:method:: SetMaxCationPiAngle

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

         .. oe:api::

            void SetMaxCationPiAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCationPiAngle(radians: float) -> None

      This option sets the maximum allowed angle defined by a point on the vector normal from the pi ring system, the
      geometric center of the ring system and the geometric center of the charged system.  For the purposes of
      Cation Pi interaction hints, only Lysine, N-methyl Lysine and Arginine are recognized cations. For Lysine and N-methyl
      Lysine, the charge center is the charged Nitrogen atom, while for the Arginine residue, the charge center will be the
      geometric center of the Carbon and three Nitrogen atoms that share the resonant charge.  Each smallest
      aromatic ring (independent of ring fusions) is considered separately and a cation can interact with more
      than one pi system simultaneously.

      **Default=** :math:`(\pi * \frac{10.0}{36.0})` **= 50 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiDistance` method


   .. oe:method:: SetMaxCationPiDistance

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

         .. oe:api::

            void SetMaxCationPiDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCationPiDistance(dist: float) -> None

      This is the maximum allowed distance between the center of a cation system and the center of an
      aromatic pi system.  For the purposes of Cation Pi interaction hints, only Lysine, N-methyl Lysine
      and Arginine are recognized cations. Each smallest aromatic ring (independent of ring fusions) is
      considered separately and a cation can interact with more than one pi system simultaneously.

      **Default= 5.5** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCationPiAngle` method


   .. oe:method:: SetMaxChargeAidedHBondDistance

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

         .. oe:api::

            void SetMaxChargeAidedHBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxChargeAidedHBondDistance(dist: float) -> None

      For the purpose of hydrogen bond perception, charge assisted hydrogen bonds, are identified when one
      of the two bonding partners is part of a functional group with a net formal charge.  These interactions
      include dipole - charge interactions and are perceived at slightly longer range than simple hydrogen-
      bonds by default.

      **Default= 3.5** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method


   .. oe:method:: SetMaxContactFraction

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

         .. oe:api::

            void SetMaxContactFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxContactFraction(frac: float) -> None

      Van der Waals interactions are perceived as non-interacting, in attractive contact, or clashing.  The three
      classes are determined by comparing the atom - atom distance **Daa** to the sum of the
      van der Waals radii of the two atoms **VDWtot**.  The distance **Daa** is represented as a
      fraction of **VDWtot** which we will call **Faa**.  If the value of **Faa** is greater than
      the value stored in
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`, then the two atoms are
      non-interacting.  If the value of **Faa** is between the values set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are in attractive
      contact.  If the value of **Faa** is less than
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are clashing.

      Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than
      generic atom pairs because of the balance of forces.  To handle this, when two atoms are forming a
      hydrogen bond, the value of **Faa** is compared to
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` to determine clashing
      rather than :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.

      **Default = 1.2**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method


   .. oe:method:: SetMaxCovalentFraction

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

         .. oe:api::

            void SetMaxCovalentFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCovalentFraction(frac: float) -> None

      This function sets the maximum ratio of the distance between to atoms to the sum of their covalent
      radii allowed for perception of a covalent bond.

      Covalent interactions are perceived based on comparing the distance between two atoms **D** to the
      sum of the covalent radii **SumRc**.  If **D** is > **SumRc** times the value set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction` and **D** is < **SumRc** times the
      value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction`, then a covalent
      interaction will be perceived. Currently no angle constraint is used in perceiving covalent interactions.

      Hydrogen and Halide atoms as well as water molecules are excluded from covalent interaction hint
      perception.  Metal atom interactions are perceived as :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      rather than as covalent interactions.

      When a covalent interaction exists between atom **P** of the protein and atom **L** of the ligand, then
      no other interactions will be perceived for atoms **P** and **L**.  Further, atoms bonded to atoms
      **L** and **P** will be excluded from perception of clash or contact interactions.  Bonded atoms will
      be able to participate in other interactions such as hydrogen bonding.

      **Default = 1.1**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction` method


   .. oe:method:: SetMaxDonorAngle

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

         .. oe:api::

            void SetMaxDonorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxDonorAngle(radians: float) -> None

      In the perception of a hydrogen bond with the interaction :math:`A...H-D`, the angle :math:`A-D-H`
      is ideally zero in most cases.
      This function determines the maximum allowed value of this angle in a perceived hydrogen-bond.

      **Default** = :math:`(\pi * \frac{7.0}{36.0})` **= 35 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method


   .. oe:method:: SetMaxHBondDistance

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

         .. oe:api::

            void SetMaxHBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHBondDistance(dist: float) -> None

      This function sets the maximum distance between the donor and acceptor heavy atoms for a hydrogen-bond
      to be perceived.

      **Default = 3.2** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method


   .. oe:method:: SetMaxHalogenAngle

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

         .. oe:api::

            void SetMaxHalogenAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHalogenAngle(radians: float) -> None

      In the perception of halogen bonds, there is an angle formed between :math:`R-X...E/N` where **X** is a univalent
      halogen, **E/N** are the electrophile or nucleophile, and **R** is the attachment of the halogen.  For
      nucleophiles, the ideal interaction angle is :math:`\pi`, for electrophiles, the ideal interaction angle
      :math:`\frac{\pi}{2}`.
      This function determines the maximum allowed deviation (in radian) from these ideal angles, respectively, for
      perception of a halogen bond.

      **Default** = :math:`(\pi * \frac{7.0}{36.0})` **= 35 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance` method


   .. oe:method:: SetMaxHalogenBondDistance

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

         .. oe:api::

            void SetMaxHalogenBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHalogenBondDistance(dist: float) -> None

      This is the maximum distance between the halogen atom and the electrophile or nucleophile atom for
      perception of a halogen bond.

      **Default = 3.2** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle` method


   .. oe:method:: SetMaxMetalBondDistance

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

         .. oe:api::

            void SetMaxMetalBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMetalBondDistance(dist: float) -> None

      This is the maximum distance allowed for an interaction to be perceived between a metal atom and a
      chelating non-metal atom.

      **Default = 3.5** |Angstroms|

   .. oe:method:: SetMaxNonIdealAcceptorAngle

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

         .. oe:api::

            void SetMaxNonIdealAcceptorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNonIdealAcceptorAngle(radians: float) -> None

      Sets the maximum angle deviation (in radian) from the non-ideal angle.

      **Default=** :math:`(\pi * \frac{6.0}{36.0})` **= 30 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance` method

   .. oe:method:: SetMaxNonIdealDonorAngle

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

         .. oe:api::

            void SetMaxNonIdealDonorAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNonIdealDonorAngle(radians: float) -> None

      Sets the maximum allowed value of this angle in a perceived non-ideal
      hydrogen bond.

      **Default=** :math:`(\pi * \frac{9.0}{36.0})` **= 45 degrees**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance` method

   .. oe:method:: SetMaxNonIdealHBondDistance

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

         .. oe:api::

            void SetMaxNonIdealHBondDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNonIdealHBondDistance(dist: float) -> None

      This function sets the maximum distance between the donor and acceptor
      heavy atoms for a non-ideal hydrogen bond to be perceived.

      **Default = 3.8** |Angstroms|

   .. oe:method:: SetMaxPiStackAngle

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

         .. oe:api::

            void SetMaxPiStackAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxPiStackAngle(radians: float) -> None

      Sets the maximum angle deviation (in radian) from the ideal angle calculated
      between the two aromatic ring normals to be considered for Pi-stacking interaction.

      **Default =** :math:`\frac{\pi}{9.0}`

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance` method


   .. oe:method:: SetMaxPiStackDistance

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

         .. oe:api::

            void SetMaxPiStackDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxPiStackDistance(dist: float) -> None

      Sets the maximum distance (in |Angstrom|) allowed between the geometric center of two aromatic
      rings in order to being considered for Pi-stacking interaction.

      **Default = 5.0** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackAngle` method


   .. oe:method:: SetMaxProteinIntraDistance

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

         .. oe:api::

            void SetMaxProteinIntraDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxProteinIntraDistance(dist: float) -> None

      Sets the maximum distance (in |Angstroms|) used to identify protein atoms that are
      neighbours of the ligand when perceiving intramolecular protein hydrogen bonds and
      chelator interactions.

      **Default = 6.0** |Angstroms|


   .. oe:method:: SetMaxSaltBridgeDistance

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

         .. oe:api::

            void SetMaxSaltBridgeDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSaltBridgeDistance(dist: float) -> None

      Sets the maximum distance (in |Angstroms|) allowed between the geometric centers of the
      two formally charged groups in a perceived salt bridge interaction.

      **Default = 5.0** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance` method


   .. oe:method:: SetMaxTStackAngle

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

         .. oe:api::

            void SetMaxTStackAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTStackAngle(radians: float) -> None

      Sets the maximum angle deviation (in radian) from the ideal angle (:math:`\frac{\pi}{2}`) calculated
      between the two aromatic ring normals to be considered for T-stacking interaction.

      **Default =** :math:`\frac{\pi}{9.0}`

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance` method


   .. oe:method:: SetMaxTStackDistance

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

         .. oe:api::

            void SetMaxTStackDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxTStackDistance(dist: float) -> None

      Sets the maximum distance (in |Angstrom|) allowed between the geometric center of two aromatic
      rings in order to being considered for T-stacking interaction.

      **Default = 5.35** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackAngle` method


   .. oe:method:: SetMaxUnpairedAngle

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

         .. oe:api::

            void SetMaxUnpairedAngle(double radians)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxUnpairedAngle(radians: float) -> None

      In perception of unpaired interactions, the unpaired potential interaction group should be oriented
      toward the ligand or protein where it could make an interaction.  This is the maximum deviation (in radian)
      allowed between the potential interaction group and the nearest potential partner atom.

      **Default =** :math:`\frac{\pi}{2}`

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance` method


   .. oe:method:: SetMaxUnpairedDistance

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

         .. oe:api::

            void SetMaxUnpairedDistance(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxUnpairedDistance(dist: float) -> None

      In perception of unpaired interactions, the unpaired potential interaction group should be within
      a minimum distance of the nearest potential paired atom.  This function sets the maximum distance
      (in |Angstroms|) for perception of an unpaired potential.

      **Default = 5.0** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle` method


   .. oe:method:: SetMinContactFraction

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

         .. oe:api::

            void SetMinContactFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMinContactFraction(frac: float) -> None

      der Waals interactions are perceived as non-interacting, in attractive contact, or clashing.  The three
      classes are determined by comparing the atom - atom distance **Daa** to the sum of the
      van der Waals radii of the two atoms **VDWtot**.  The distance **Daa** is represented as a
      fraction of **VDWtot** which we will call **Faa**.  If the value of **Faa** is greater than
      the value stored in
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`, then the two atoms are
      non-interacting.  If the value of **Faa** is between the values set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are in attractive
      contact.  If the value of **Faa** is less than
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are clashing.

      Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than
      generic atom pairs because of the balance of forces.  To handle this, when two atoms are forming a
      hydrogen bond, the value of **Faa** is compared to
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` to determine clashing
      rather than :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.

      **Default = 0.8**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method


   .. oe:method:: SetMinCovalentFraction

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

         .. oe:api::

            void SetMinCovalentFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMinCovalentFraction(frac: float) -> None

      This function sets the minimum ratio of the distance between to atoms to the sum of their covalent
      radii allowed for perception of a covalent bond.

      Covalent interactions are perceived based on comparing the distance between two atoms **D** to the
      sum of the covalent radii **SumRc**.  If **D** is > **SumRc** times the value set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinCovalentFraction` and **D** is < **SumRc** times the
      value set by :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction`, then a covalent
      interaction will be perceived. Currently no angle constraint is used in perceiving covalent interactions.

      Hydrogen and Halide atoms as well as water molecules are excluded from covalent interaction hint
      perception.  Metal atom interactions are perceived as :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      rather than as covalent interactions.

      When a covalent interaction exists between atom **P** of the protein and atom **L** of the ligand, then
      no other interactions will be perceived for atoms **P** and **L**.  Further, atoms bonded to atoms
      **L** and **P** will be excluded from perception of clash or contact interactions.  Bonded atoms will
      be able to participate in other interactions such as hydrogen bonding.

      **Default = 0.9**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxCovalentFraction` method


   .. oe:method:: SetMinHBondContactFraction

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

         .. oe:api::

            void SetMinHBondContactFraction(double frac)

      .. oe:language:: python

         .. oe:api:: python

            SetMinHBondContactFraction(frac: float) -> None

      der Waals interactions are perceived as non-interacting, in attractive contact, or clashing.  The three
      classes are determined by comparing the atom - atom distance **Daa** to the sum of the
      van der Waals radii of the two atoms **VDWtot**.  The distance **Daa** is represented as a
      fraction of **VDWtot** which we will call **Faa**.  If the value of **Faa** is greater than
      the value stored in
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction`, then the two atoms are
      non-interacting.  If the value of **Faa** is between the values set by
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` and
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are in attractive
      contact.  If the value of **Faa** is less than
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` then the atoms are clashing.

      Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than
      generic atom pairs because of the balance of forces.  To handle this, when two atoms are forming a
      hydrogen bond, the value of **Faa** is compared to
      :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` to determine clashing
      rather than :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction`.

      **Default = 0.5**

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance` method


   .. oe:method:: SetMinStackOffset

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

         .. oe:api::

            void SetMinStackOffset(double dist)

      .. oe:language:: python

         .. oe:api:: python

            SetMinStackOffset(minOffset: float) -> None

      Sets the minimum allowed lateral offset (in |Angstroms|) used to filter
      Pi-stacking and T-stacking interaction candidates.

      **Default = 0.5** |Angstroms|

      .. seealso::

         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxPiStackDistance` method
         * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxTStackDistance` method

