.. oe:namespace:: OEPB



.. meta::
   :keywords: OEET, ET


.. _OEPB_OEET:

.. oe:class:: OEET

   .. oe:api::


      class OEET

   Used to calculate electrostatic similarity between molecules using
   Poisson-Boltzmann electrostatic potentials.

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEET(const OEET& rhs)
            OEET(float dielectric = 80.0f)

      .. oe:language:: python

         .. oe:api:: python

            OEET(dielectric: float = 80.0) -> OEET
            OEET(rhs: OEET) -> OEET

      Default and copy constructors.

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

      .. oe:api::

         OEET &operator=(const OEET &rhs)

      Assignment operator

      Assignment operator.


   .. oe:method:: GetDielectric

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

         .. oe:api::

            float GetDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectric() -> float

      Returns the setting for the outer dielectric constant.

   .. oe:method:: GetGridBuffer

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

         .. oe:api::

            float GetGridBuffer() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridBuffer() -> float

      Returns the setting for the amount of space between the molecule and the edge of the grid.

   .. oe:method:: GetGridSpacing

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

         .. oe:api::

            float GetGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridSpacing() -> float


      Returns the setting for the grid spacing.

   .. oe:method:: GetInnerDielectric

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

         .. oe:api::

            float GetInnerDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerDielectric() -> float

      Returns the value for the inner dielectric.

   .. oe:method:: GetInnerMask

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

         .. oe:api::

            float GetInnerMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerMask() -> float

      Returns the value for the inner mask.

   .. oe:method:: GetJoin

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

         .. oe:api::

            bool GetJoin() const

      .. oe:language:: python

         .. oe:api:: python

            GetJoin() -> bool

      Returns the setting for whether or not to join the molecules for masking.

   .. oe:method:: GetOuterMask

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

         .. oe:api::

            float GetOuterMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetOuterMask() -> float

      Returns the value for the outer mask.

   .. oe:method:: GetSaltConcentration

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

         .. oe:api::

            float GetSaltConcentration() const
            Returns the setting for the salt concentration

      .. oe:language:: python

         .. oe:api:: python

            GetSaltConcentration() -> float

   .. oe:method:: SetDielectric

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

         .. oe:api::

            void SetDielectric(float d)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectric(d: float) -> None

      Sets the outer dielectric constant

   .. oe:method:: SetGridBuffer

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

         .. oe:api::

            void SetGridBuffer(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetGridBuffer(f: float) -> None

      Sets the grid buffer, or boundary spacing, which is the amount
      of distance between the molecule and the edge of the grid.  The
      default value is 6.0.

   .. oe:method:: SetGridSpacing

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

         .. oe:api::

            void SetGridSpacing(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetGridSpacing(f: float) -> None

      Sets the grid spacing.  The default value is 0.75.

   .. oe:method:: SetInnerDielectric

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

         .. oe:api::

            void SetInnerDielectric(float d)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerDielectric(d: float) -> None

      Sets the inner dielectric constant

   .. oe:method:: SetInnerMask

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

         .. oe:api::

            void SetInnerMask(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerMask(f: float) -> None

      Sets the inner mask for electrostatic comparison.  The default
      value is set to 0.05.  The inner mask is used to mask out the
      inner part of a molecule.  The inner part of the molecule is
      masked out so that the important regions surrounding the
      molecule dominate the electrostatic comparison.

   .. oe:method:: SetJoin

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

         .. oe:api::

            void SetJoin(bool j)

      .. oe:language:: python

         .. oe:api:: python

            SetJoin(j: bool) -> None

      Turns molecular joining on(``true``) or off(``false``).  The
      default value is ``true``, which uses the combine reference
      molecule and trial molecule when applying the inner and outer
      mask.


   .. oe:method:: SetOuterMask

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

         .. oe:api::

            void SetOuterMask(float f)

      .. oe:language:: python

         .. oe:api:: python

            SetOuterMask(f: float) -> None

      Sets the outer mask for electrostatic comparison.  The default
      value is set to 0.0005.  The outer mask is used to mask out
      regions far from the molecule.


   .. oe:method:: SetRefMol

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

         .. oe:api::

            bool SetRefMol(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            SetRefMol(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the reference molecule.  

   .. oe:method:: SetSaltConcentration

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

         .. oe:api::

            void SetSaltConcentration(float conc)

      .. oe:language:: python

         .. oe:api:: python

            SetSaltConcentration(conc: float) -> None

      Sets the salt concentration.  The default value is 0.04.

   .. oe:method:: Tanimoto

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

         .. oe:api::

            float Tanimoto(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Tanimoto(mol: Union[OEGraphMol,OEMol,OEQMol]) -> float

      Returns the electrostatic Tanimoto between the reference
      molecule that has been set and the trial molecule that is passed
      in as an argument.
