.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPositOptions, PositOptions


.. _OEDocking_OEPositOptions:

.. oe:class:: OEPositOptions

   .. oe:api::

      class OEPositOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for performing
   pose prediction using POSIT.

   The :ref:`OEPositOptions <OEDocking_OEPositOptions>` class defines the following public methods:
    * :oe:meth:`GetAllowedClashType<OEDocking::OEPositOptions::GetAllowedClashType>` and
      :oe:meth:`SetAllowedClashType<OEDocking::OEPositOptions::SetAllowedClashType>`
    * :oe:meth:`GetBestReceptorPoseOnly<OEDocking::OEPositOptions::GetBestReceptorPoseOnly>` and
      :oe:meth:`SetBestReceptorPoseOnly<OEDocking::OEPositOptions::SetBestReceptorPoseOnly>`
    * :oe:meth:`GetExcludeSelf<OEDocking::OEPositOptions::GetExcludeSelf>` and
      :oe:meth:`SetExcludeSelf<OEDocking::OEPositOptions::SetExcludeSelf>`
    * :oe:meth:`GetFlexiOverlayOptions<OEDocking::OEPositOptions::GetFlexiOverlayOptions>` and
      :oe:meth:`SetFlexiOverlayOptions<OEDocking::OEPositOptions::SetFlexiOverlayOptions>`
    * :oe:meth:`GetFullConformationSearch<OEDocking::OEPositOptions::GetFullConformationSearch>` and
      :oe:meth:`SetFullConformationSearch<OEDocking::OEPositOptions::SetFullConformationSearch>`
    * :oe:meth:`GetIgnoreNitrogenStereo<OEDocking::OEPositOptions::GetIgnoreNitrogenStereo>` and
      :oe:meth:`SetIgnoreNitrogenStereo<OEDocking::OEPositOptions::SetIgnoreNitrogenStereo>`
    * :oe:meth:`GetMinProbability<OEDocking::OEPositOptions::GetMinProbability>` and
      :oe:meth:`SetMinProbability<OEDocking::OEPositOptions::SetMinProbability>`
    * :oe:meth:`GetPoserCacheCount<OEDocking::OEPositOptions::GetPoserCacheCount>` and
      :oe:meth:`SetPoserCacheCount<OEDocking::OEPositOptions::SetPoserCacheCount>`
    * :oe:meth:`GetPoseRelaxMode<OEDocking::OEPositOptions::GetPoseRelaxMode>` and
      :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>`
    * :oe:meth:`GetPoseRelaxOptions<OEDocking::OEPositOptions::GetPoseRelaxOptions>` and
      :oe:meth:`SetPoseRelaxOptions<OEDocking::OEPositOptions::SetPoseRelaxOptions>`
    * :oe:meth:`GetPositMethods<OEDocking::OEPositOptions::GetPositMethods>` and
      :oe:meth:`SetPositMethods<OEDocking::OEPositOptions::SetPositMethods>`
    * :oe:meth:`GetTorLib<OEDocking::OEPositOptions::GetTorLib>` and
      :oe:meth:`SetTorLib<OEDocking::OEPositOptions::SetTorLib>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEPositOptions(const bool fullConformationalSearch = true,
                           const unsigned ipositMethods = OEPositMethod::ALL)
            OEPositOptions(const OEPositOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEPositOptions(fullConformationalSearch: bool = True,
                           ipositMethods: int) -> OEPositOptions
            OEPositOptions(arg2: OEPositOptions) -> OEPositOptions

      Constructors.

      *fullConformationalSearch*
         If ``true``, a full flexible conformational search is performed
         during pose prediction. If ``false``, only a rigid overlay is used.
         Default: ``true``.

      *ipositMethods*
         Bit-mask of POSIT pose-prediction methods to enable.
         See :oe:constns:`OEDocking::OEPositMethod` for valid values.
         Default: :oe:const:`OEDocking::OEPositMethod::ALL`.

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

      .. oe:api::

         OEPositOptions &operator=(const OEPositOptions &)


   .. _OEDocking_OEPositOptions_GetAllowedClashType:

      Assignment operator.


   .. oe:method:: GetAllowedClashType

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

         .. oe:api::

            unsigned GetAllowedClashType() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowedClashType() -> int

      See :oe:meth:`SetAllowedClashType<OEDocking::OEPositOptions::SetAllowedClashType>` method.


   .. _OEDocking_OEPositOptions_GetBestReceptorPoseOnly:

   .. oe:method:: GetBestReceptorPoseOnly

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

         .. oe:api::

            bool GetBestReceptorPoseOnly() const

      .. oe:language:: python

         .. oe:api:: python

            GetBestReceptorPoseOnly() -> bool

      See :oe:meth:`SetBestReceptorPoseOnly<OEDocking::OEPositOptions::SetBestReceptorPoseOnly>` method.  


   .. _OEDocking_OEPositOptions_GetExcludeSelf:

   .. oe:method:: GetExcludeSelf

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

         .. oe:api::

            bool GetExcludeSelf() const

      .. oe:language:: python

         .. oe:api:: python

            GetExcludeSelf() -> bool

      See :oe:meth:`SetExcludeSelf<OEDocking::OEPositOptions::SetExcludeSelf>` method.


   .. _OEDocking_OEPositOptions_GetFlexiOverlayOptions:

   .. oe:method:: GetFlexiOverlayOptions

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

         .. oe:api::

            OEShapeFitOptions& GetFlexiOverlayOptions()
            const OEShapeFitOptions& GetFlexiOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexiOverlayOptions() -> OEShapeFitOptions

      See :oe:meth:`SetFlexiOverlayOptions<OEDocking::OEPositOptions::SetFlexiOverlayOptions>` method.


   .. _OEDocking_OEPositOptions_GetFullConformationSearch:

   .. oe:method:: GetFullConformationSearch

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

         .. oe:api::

            bool GetFullConformationSearch() const

      .. oe:language:: python

         .. oe:api:: python

            GetFullConformationSearch() -> bool

      See :oe:meth:`SetFullConformationSearch<OEDocking::OEPositOptions::SetFullConformationSearch>` method.


   .. _OEDocking_OEPositOptions_GetIgnoreNitrogenStereo:

   .. oe:method:: GetIgnoreNitrogenStereo

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

         .. oe:api::

            bool GetIgnoreNitrogenStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreNitrogenStereo() -> bool

      See :oe:meth:`SetIgnoreNitrogenStereo<OEDocking::OEPositOptions::SetIgnoreNitrogenStereo>` method.


   .. _OEDocking_OEPositOptions_GetMinProbability:

   .. oe:method:: GetMinProbability

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

         .. oe:api::

            double GetMinProbability() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinProbability() -> float

      See :oe:meth:`SetMinProbability<OEDocking::OEPositOptions::SetMinProbability>` method.


   .. _OEDocking_OEPositOptions_GetPoserCacheCount:

   .. oe:method:: GetPoserCacheCount

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

         .. oe:api::

            unsigned GetPoserCacheCount()const

      .. oe:language:: python

         .. oe:api:: python

            GetPoserCacheCount() -> int

      See :oe:meth:`SetPoserCacheCount<OEDocking::OEPositOptions::SetPoserCacheCount>` method.


   .. _OEDocking_OEPositOptions_GetPoseRelaxMode:

   .. oe:method:: GetPoseRelaxMode

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

         .. oe:api::

            unsigned GetPoseRelaxMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetPoseRelaxMode() -> int

      See :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>` method.


   .. _OEDocking_OEPositOptions_GetPoseRelaxOptions:

   .. oe:method:: GetPoseRelaxOptions

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

         .. oe:api::

            OEPoseOptimizerOptions& GetPoseRelaxOptions()
            const OEPoseOptimizerOptions& GetPoseRelaxOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPoseRelaxOptions() -> OEPoseOptimizerOptions

      See :oe:meth:`SetPoseRelaxOptions<OEDocking::OEPositOptions::SetPoseRelaxOptions>` method.


   .. _OEDocking_OEPositOptions_GetPositMethods:

   .. oe:method:: GetPositMethods

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

         .. oe:api::

            unsigned int GetPositMethods() const

      .. oe:language:: python

         .. oe:api:: python

            GetPositMethods() -> int

      See :oe:meth:`SetPositMethods<OEDocking::OEPositOptions::SetPositMethods>` method. 


   .. _OEDocking_OEPositOptions_GetTorLib:

   .. oe:method:: GetTorLib

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

         .. oe:api::

            const OETorLib* GetTorLib() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorLib() -> OETorLib

      See :oe:meth:`SetTorLib<OEDocking::OEPositOptions::SetTorLib>` method.


   .. _OEDocking_OEPositOptions_SetAllowedClashType:

   .. oe:method:: SetAllowedClashType

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

         .. oe:api::

            bool SetAllowedClashType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowedClashType(value: int) -> bool

      Sets the **allowed clash type** between the ligand pose and the protein,
      for pose generation. Allowed clash types are defined in the
      :oe:constns:`OEDocking::OEAllowedClashType` namespace.

      The allowed clash type defines if a generated pose contains a clash or not, as
      reported in a pose calculation result. The allowed clash type also determines if
      a relaxation of the pose would be carried out when
      :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>` is set
      to :oe:const:`OEDocking::OEPoseRelaxMode::CLASHED`.
      Default is :oe:const:`OEDocking::OEAllowedClashType::HYDROGEN`.


   .. _OEDocking_OEPositOptions_SetBestReceptorPoseOnly:

   .. oe:method:: SetBestReceptorPoseOnly

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

         .. oe:api::

            bool SetBestReceptorPoseOnly(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetBestReceptorPoseOnly(value: bool) -> bool

      Sets flag if **only the best receptor** should be considered for pose prediction.
      If this flag set to ``false`` the pose prediction is performed using all of the
      receptors and the best set of poses from all of the receptors combined is provided
      as the results. With the default setting of ``true`` pose prediction is only performed
      on the ``best receptor`` for any given ligand. Note that, setting the flag to ``false``
      could increase the runtime significantly depending on the number of receptors used
      for the calculation.


   .. _OEDocking_OEPositOptions_SetExcludeSelf:

   .. oe:method:: SetExcludeSelf

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

         .. oe:api::

            bool SetExcludeSelf(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetExcludeSelf(value: bool) -> bool

      Sets flag **to exclude receptor that contains a given ligand as its bound ligand**, when 
      choosing the best receptor for a ligand during pose prediction. This option is meant to 
      be used when running cross docking validation experiments, and allows the user to prevent 
      docking a ligand to a receptor containing itself, without having to generate a number of 
      leave one out receptor datasets.
      Default: **False.**


   .. _OEDocking_OEPositOptions_SetFlexiOverlayOptions:

   .. oe:method:: SetFlexiOverlayOptions

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

         .. oe:api::

            void SetFlexiOverlayOptions(const OEShapeFitOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexiOverlayOptions(opts: OEShapeFitOptions) -> None

      Sets :oe:cls:`options<OEDocking::OEShapeFitOptions>` related to flexible optimization 
      with shape, color, and forcefield, relevant for pose generation with 
      :oe:const:`OEDocking::OEPositMethod::SHAPEFIT`.


   .. _OEDocking_OEPositOptions_SetFullConformationSearch:

   .. oe:method:: SetFullConformationSearch

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

         .. oe:api::

            bool SetFullConformationSearch(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFullConformationSearch(value: bool) -> bool

      Sets flag **to perform full conformation search**.
      Setting this option to ``false`` disables internal rotamer conformer searching during 
      the flexible searching algorithm. If this option is set to ``false`` and a 3D input is 
      not given, this setting is ignored and a full conformation search is automatically performed. 
      Default: ``true``.


   .. _OEDocking_OEPositOptions_SetIgnoreNitrogenStereo:

   .. oe:method:: SetIgnoreNitrogenStereo

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

         .. oe:api::

            bool SetIgnoreNitrogenStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreNitrogenStereo(value: bool) -> bool

      Sets flag **to ignore Nitrogen stereo specifications** in input molecule. 
      Setting this option to ``false`` ignores Nitrogen stereo specifications in the input molecule,
      and a value to ``true`` ensures that any specified Nitrogen stereo information is restored.
      A molecule would always be processed, irrespective of this setting. When Nitrogen stereo is 
      specified in the incoming molecule, setting flag is set to ``true`` would respect those
      stereo specifications. Default: ``false``.


   .. _OEDocking_OEPositOptions_SetMinProbability:

   .. oe:method:: SetMinProbability

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

         .. oe:api::

            bool SetMinProbability(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMinProbability(value: float) -> bool

      Sets the minimum pose probability, for poses to be of interest.  Poses
      that has a probability below the minimum value are not relaxed even when
      the :oe:meth:`SetPoseRelaxMode<OEDocking::OEPositOptions::SetPoseRelaxMode>`
      is set to ``CLASHED`` or `ALL``. Default is ``0.33``.


   .. _OEDocking_OEPositOptions_SetPoserCacheCount:

   .. oe:method:: SetPoserCacheCount

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

         .. oe:api::

            bool SetPoserCacheCount(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetPoserCacheCount(value: int) -> bool

      Sets the maximum number of posers to be kept in memory cache during **POSIT** calculation.
      Each poser takes ~0.75GB of memory.  Ability to keep more poser in the cache speeds
      up the calculation when working with multiple receptors. Default is ``10``.


   .. _OEDocking_OEPositOptions_SetPoseRelaxMode:

   .. oe:method:: SetPoseRelaxMode

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

         .. oe:api::

            bool SetPoseRelaxMode(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetPoseRelaxMode(value: int) -> bool

      Sets the **trigger to perform relaxation** of the generated pose.  The relaxation is
      performed by allowing flexibility to the ligand and parts of the receptor. Turning on
      relaxation can significantly slow down the calculations. Pose relaxation modes are
      defined in the :oe:constns:`OEDocking::OEPoseRelaxMode` namespace.
      Default is :oe:const:`OEDocking::OEPoseRelaxMode::NONE`.


   .. _OEDocking_OEPositOptions_SetPoseRelaxOptions:

   .. oe:method:: SetPoseRelaxOptions

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

         .. oe:api::

            void SetPoseRelaxOptions(const OEPoseOptimizerOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetPoseRelaxOptions(opts: OEPoseOptimizerOptions) -> None

      Sets :oe:cls:`options<OEDocking::OEPoseOptimizerOptions>` related to post-optimization
      of the generated pose.


   .. _OEDocking_OEPositOptions_SetPositMethods:

   .. oe:method:: SetPositMethods

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

         .. oe:api::

            bool SetPositMethods(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetPositMethods(value: int) -> bool

      Sets the **posing methods** to be used. Methods are set as bits in the supplied integer,
      see the :oe:constns:`OEDocking::OEPositMethod` namespace for more details.
      Default is :oe:const:`OEDocking::OEPositMethod::ALL`.


   .. _OEDocking_OEPositOptions_SetTorLib:

   .. oe:method:: SetTorLib

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

         .. oe:api::

            bool SetTorLib(const unsigned)
            bool SetTorLib(const std::string&)
            bool SetTorLib(const OEConfGen::OETorLib&)

      .. oe:language:: python

         .. oe:api:: python

            SetTorLib(value: int) -> bool
            SetTorLib(value: str) -> bool
            SetTorLib(value: oeistream) -> bool
            SetTorLib(value: OETorLib) -> bool

      Sets the **torsion library** that is used for torsion driving during conformer generation.  
      The first overload takes an `unsigned` from the :ref:`OETorlibType <OEConfGen_OETorLibType>` namespace,
      and the second overload takes the corresponding string values.
      **Default:** :ref:`Original <OEConfGen_OETorLibType_Original>`
