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

.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEShapeFitOptions, ShapeFitOptions


.. _OEDocking_OEShapeFitOptions:

.. oe:class:: OEShapeFitOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEShapeFitOptions : public OEShape::OEFlexiOverlayOptions

   This class provides an interface to setup options to generate pose conformers using
   **flexible overlay optimization** between the bound ligand present in the reference 
   design unit and a fit molecule 
   using :ref:`OEShapeFit <OEDocking_OEShapeFit>`.

   The :ref:`OEShapeFitOptions <OEDocking_OEShapeFitOptions>` class defines the following public methods:
    * :oe:meth:`GetFullConformationSearch<OEDocking::OEShapeFitOptions::GetFullConformationSearch>` and
      :oe:meth:`SetFullConformationSearch<OEDocking::OEShapeFitOptions::SetFullConformationSearch>`
    * :oe:meth:`GetMaxLocalStrain<OEDocking::OEShapeFitOptions::GetMaxLocalStrain>` and
      :oe:meth:`SetMaxLocalStrain<OEDocking::OEShapeFitOptions::SetMaxLocalStrain>`
    * :oe:meth:`GetMaxOptSteps<OEDocking::OEShapeFitOptions::GetMaxOptSteps>` and
      :oe:meth:`SetMaxOptSteps<OEDocking::OEShapeFitOptions::SetMaxOptSteps>`
    * :oe:meth:`GetTorLib<OEDocking::OEShapeFitOptions::GetTorLib>` and
      :oe:meth:`SetTorLib<OEDocking::OEShapeFitOptions::SetTorLib>`
    * :oe:meth:`GetFlexiOverlapOptions<OEDocking::OEShapeFitOptions::GetFlexiOverlapOptions>` and
      :oe:meth:`SetFlexiOverlapOptions<OEDocking::OEShapeFitOptions::SetFlexiOverlapOptions>`
    * :oe:meth:`GetRigidOverlayOptions<OEDocking::OEShapeFitOptions::GetRigidOverlayOptions>` and
      :oe:meth:`SetRigidOverlayOptions<OEDocking::OEShapeFitOptions::SetRigidOverlayOptions>`
    * :oe:meth:`CreateCopy<OEDocking::OEShapeFitOptions::CreateCopy>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEShapeFitOptions()
            OEShapeFitOptions(const OEShapeFitOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeFitOptions() -> OEShapeFitOptions
            OEShapeFitOptions(arg2: OEShapeFitOptions) -> OEShapeFitOptions

      Default and copy constructors.

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

      .. oe:api::

         OEShapeFitOptions &operator=(const OEShapeFitOptions&)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEShapeFitOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEShapeFitOptions

      Creates and returns a deep copy of this object.


.. _OEDocking_OEShapeFitOptions_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::OEShapeFitOptions::SetFullConformationSearch>` method.



.. _OEDocking_OEShapeFitOptions_GetMaxOptSteps:

   .. oe:method:: GetMaxOptSteps

      .. oe:api::

         unsigned GetMaxOptSteps() const

      See :oe:meth:`SetMaxOptSteps<OEDocking::OEShapeFitOptions::SetMaxOptSteps>` method.


.. _OEDocking_OEShapeFitOptions_GetTorLib:

   .. oe:method:: GetTorLib

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

         .. oe:api::

            const OEConfGen::OETorLib* GetTorLib() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorLib() -> OETorLib

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


.. _OEDocking_OEShapeFitOptions_GetFlexiOverlapOptions:

   .. oe:method:: GetFlexiOverlapOptions

      .. oe:api::

               OEFlexiOverlapOptions& GetFlexiOverlapOptions()
               const OEFlexiOverlapOptions& GetFlexiOverlapOptions() const

      Returns a reference to the :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance as currently set.
      These are options related to flexible overlap optimization using shape, color, and force field.
      See also :oe:meth:`SetFlexiOverlapOptions<OEDocking::OEShapeFitOptions::SetFlexiOverlapOptions>` method.

.. _OEDocking_OEShapeFitOptions_GetMaxLocalStrain:

   .. oe:method:: GetMaxLocalStrain

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

         .. oe:api::

            double GetMaxLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLocalStrain() -> float

      See :ref:`SetMaxLocalStrain<OEDocking_OEShapeFitOptions_SetMaxLocalStrain>` method.

.. _OEDocking_OEShapeFitOptions_GetRigidOverlayOptions:

   .. oe:method:: GetRigidOverlayOptions

      .. oe:api::

               OEOverlayOptions& GetRigidOverlayOptions()
               const OEOverlayOptions& GetRigidOverlayOptions() const

      Returns a reference to the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` instance as currently set.
      These are options related to rigid overlay optimization using shape and color.
      See also :oe:meth:`SetRigidOverlayOptions<OEDocking::OEShapeFitOptions::SetRigidOverlayOptions>` method.

.. _OEDocking_OEShapeFitOptions_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 ``true`` enables internal rotamer conformer generation,
      prior to running :ref:`OEShapeFit <OEDocking_OEShapeFit>`. 
      Default: ``false``.

.. _OEDocking_OEShapeFitOptions_SetMaxLocalStrain:

   .. oe:method:: SetMaxLocalStrain

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

         .. oe:api::

            bool SetMaxLocalStrain(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLocalStrain(value: float) -> bool

      Sets the **Number allowable local strain** in the generated hits.
      **Default: 6.5.**

.. _OEDocking_OEShapeFitOptions_SetMaxOptSteps:

   .. oe:method:: SetMaxOptSteps

      .. oe:api::

         bool SetMaxOptSteps(const unsigned)

      Sets the maximum number of optimization iteration steps in flexible overlay optimization.
      Default: `2000` steps.


.. _OEDocking_OEShapeFitOptions_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:** :oe:const:`OEConfGen::OETorLibType::Original`


.. _OEDocking_OEShapeFitOptions_SetFlexiOverlapOptions:

   .. oe:method:: SetFlexiOverlapOptions

      .. oe:api::

         void SetFlexiOverlapOptions(const OEFlexiOverlapOptions&)

      Sets the options related to flexible overlap calculations by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.


.. _OEDocking_OEShapeFitOptions_SetRigidOverlayOptions:

   .. oe:method:: SetRigidOverlayOptions

      .. oe:api::

         void SetRigidOverlayOptions(const OEOverlayOptions&)

      Sets the options related to overlay optimization using shape and color by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.
