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

.. oe:namespace:: OESpruce


.. _OESpruce_OEPocket:

.. oe:class:: OEPocket

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEPocket

   This class stores the pockets resulting from running :oe:func:`OESpruce::OEFindPockets` function.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPocket(const OESpicoli::OESurface& surf, OEChem::OEMolBase& mol)
            OEPocket(const OEPocket &)

      .. oe:language:: python

         .. oe:api:: python

            OEPocket(rhs: OEPocket) -> OEPocket
            OEPocket(arg2: OEPocket) -> OEPocket
            OEPocket(surf: OESurface, mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEPocket

      Default and copy constructor that constructs a `OEPocket` object.

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

      .. oe:api::

         OEPocket& operator=(const OEPocket &)

      Assignment operator.

   .. oe:method:: GetSurfaceArea

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

         .. oe:api::

            double GetSurfaceArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceArea() -> float

      Returns the surface area for the pocket surface.

   .. oe:method:: GetLocalDensity

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

         .. oe:api::

            double GetLocalDensity() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocalDensity() -> float

      Returns the local density score for the pocket. A score > 50 is considered high quality.

   .. oe:method:: GetPocketPredicate

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

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& GetPocketPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetPocketPredicate() -> OEUnaryAtomPred

      Returns an atom predicate for the pocket. The pocket is residue based and can therefore be transferred
      to structures in the same target.

   .. oe:method:: GetPocketSurface

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

         .. oe:api::

            const OESpicoli::OESurface& GetPocketSurface() const
            OESpicoli::OESurface& GetPocketSurface()

      .. oe:language:: python

         .. oe:api:: python

            GetPocketSurface() -> OESurface

      Returns a reference to the surface of the pocket.

   .. oe:method:: GetAtoms

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

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEAtomBase>* GetAtoms()

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator of the atoms making up the pocket surface.

   .. oe:method:: GetResidues

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

         .. oe:api::

            OESystem::OEIterBase<OEHierResidue>* GetResidues()

      .. oe:language:: python

         .. oe:api:: python

            GetResidues() -> OEResidueIter

      Returns an iterator of the OEResidues making up the pocket.

   .. seealso::

      * :oe:func:`OESpruce::OEFindPockets` function
      * :ref:`OEPocketOptions <OESpruce_OEPocketOptions>` class
      * :ref:`OEMakeDesignUnitFromPocket <OESpruce_OEMakeDesignUnitFromPocket>` function
