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

.. oe:namespace:: OESpruce



.. _OESpruce_OEPocketOptions:

.. oe:class:: OEPocketOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEPocketOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for pocket finding using
   :oe:func:`OESpruce::OEFindPockets` function.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPocketOptions()
            OEPocketOptions(const OEPocketOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEPocketOptions() -> OEPocketOptions
            OEPocketOptions(arg2: OEPocketOptions) -> OEPocketOptions

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

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

      .. oe:api::

         OEPocketOptions &operator=(const OEPocketOptions &)

      Assignment operator.

   .. oe:method:: GetMinSurfaceArea

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

         .. oe:api::

            double GetMinSurfaceArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinSurfaceArea() -> float

      Returns the minimum surface area for a detected pocket surface.
      [Default: :math:`150 \, {Angstrom}^2`]

   .. oe:method:: GetMaxSurfaceArea

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

         .. oe:api::

            double GetMaxSurfaceArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSurfaceArea() -> float

      Returns the maximum surface area for a detected pocket surface.
      [Default: :math:`3000 \, {Angstrom}^2`]

   .. oe:method:: GetBurialFactor

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

         .. oe:api::

            double GetBurialFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBurialFactor() -> float

      Returns the factor used to distinguish pockets from the general surface.
      [Default: 1.4]

.. _OESpruce_OEPocketOptions_SetMinSurfaceArea:

   .. oe:method:: SetMinSurfaceArea

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

         .. oe:api::

            bool SetMinSurfaceArea(const double value)

      .. oe:language:: python

         .. oe:api:: python

            SetMinSurfaceArea(value: float) -> bool

      Sets the minimum surface area for a detected pocket surface.

.. _OESpruce_OEPocketOptions_SetMaxSurfaceArea:

   .. oe:method:: SetMaxSurfaceArea

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

         .. oe:api::

            bool SetMaxSurfaceArea(const double value)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSurfaceArea(value: float) -> bool

      Sets the maximum surface area for a detected pocket surface.

.. _OESpruce_OEPocketOptions_SetBurialFactor:

   .. oe:method:: SetBurialFactor

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

         .. oe:api::

            bool SetBurialFactor(const double value)

      .. oe:language:: python

         .. oe:api:: python

            SetBurialFactor(value: float) -> bool

      Sets the factor used to distinguish pockets from the general surface.

   .. seealso::

      * :oe:func:`OESpruce::OEFindPockets` function
      * :ref:`OEPocket <OESpruce_OEPocket>` class
