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

.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperposeOptions, SuperposeOptions, OESuperpose


.. _OESpruce_OESuperposeOptions:

.. oe:class:: OESuperposeOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESuperposeOptions

   This class represents :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` that sets
   the optional parameters for structural superposition using the :ref:`OESuperpose <OESpruce_OESuperpose>` class.

   .. seealso::
      
      * :ref:`OESuperpose <OESpruce_OESuperpose>` class
      * :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class
      * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

   .. admonition:: Code Example

      * :ref:`spruce_examples_superposition` example

   .. oe:method:: Constructors

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

         .. oe:api::

            OESuperposeOptions(const unsigned method = OESuperposeMethod::Default)

      .. oe:language:: python

         .. oe:api:: python

            OESuperposeOptions(method: int) -> OESuperposeOptions

      Default constructor.

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

         .. oe:api::

            OESuperposeOptions(const OESuperposeOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESuperposeOptions(arg2: OESuperposeOptions) -> OESuperposeOptions

      Copy constructor.

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

      .. oe:api::

         OESuperposeOptions &operator=(const OESuperposeOptions &argOpts)

      Assignment operator.

.. _OESpruce_OESuperposeOptions_GetMethod:


   .. oe:method:: GetMethod

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

         .. oe:api::

            unsigned GetMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMethod() -> int

      Returns the type of superposition to be performed. Types are given from the constants
      given in :ref:`OESuperposeMethod <OESpruce_OESuperposeMethod>`.
      The default type is :ref:`Default <OESpruce_OESuperposeMethod_Default>`.

.. _OESpruce_OESuperposeOptions_SetMethod:


   .. oe:method:: SetMethod

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

         .. oe:api::

            bool SetMethod(unsigned value)

      .. oe:language:: python

         .. oe:api:: python

            SetMethod(value: int) -> bool

      Sets the type of superposition to be performed. Types are taken from the
      constants given in :ref:`OESuperposeMethod <OESpruce_OESuperposeMethod>`.

.. _OESpruce_OESuperposeOptions_GetUseConstraints:

   .. oe:method:: GetUseConstraints

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

         .. oe:api::

            bool GetUseConstraints() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseConstraints() -> bool

      Returns whether or not ligand or site-residue constraints should be used to validate the superposition.

      .. seealso::

         * :ref:`SetUseConstraints <OESpruce_OESuperposeOptions_SetUseConstraints>` method
         * :ref:`SetupRef <OESpruce_OESuperpose_SetupRef>` method
         * :ref:`Superpose <OESpruce_OESuperpose_Superpose>` method

.. _OESpruce_OESuperposeOptions_SetUseConstraints:

   .. oe:method:: SetUseConstraints

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

         .. oe:api::

            bool SetUseConstraints(bool value)

      .. oe:language:: python

         .. oe:api:: python

            SetUseConstraints(value: bool) -> bool

      Sets whether or not ligand or site-residue constraints should be used to validate the superposition.

      .. seealso::

         * :ref:`GetUseConstraints <OESpruce_OESuperposeOptions_GetUseConstraints>` method
         * :ref:`SetupRef <OESpruce_OESuperpose_SetupRef>` method
         * :ref:`Superpose <OESpruce_OESuperpose_Superpose>` method

.. _OESpruce_OESuperposeOptions_GetValidRMSD:

   .. oe:method:: GetValidRMSD

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

         .. oe:api::

            double GetValidRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidRMSD() -> float

      Returns the RMSD threshold for validating the superposition of the reference and fit molecules. 
      :oe:meth:`OESpruce::OESuperposeResults::IsValid` returns false if the RMSD of the superposed molecules exceeds this threshold. 
      The default value is 10.0 Angstroms for sequence-based methods and -1.0 for shape-based methods (RMSD calculation is only 
      applicable to sequence-based methods).

      .. seealso::
         
         * :ref:`SetValidRMSD <OESpruce_OESuperposeOptions_SetValidRMSD>` method
         * :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>` method
         * :ref:`GetRMSD <OESpruce_OESuperposeResults_GetRMSD>` method

.. _OESpruce_OESuperposeOptions_SetValidRMSD:

   .. oe:method:: SetValidRMSD

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

         .. oe:api::

            bool SetValidRMSD(double value)

      .. oe:language:: python

         .. oe:api:: python

            SetValidRMSD(value: float) -> bool

      Sets the RMSD threshold for validating the superposition of the reference and fit molecules. 

      .. warning::

         RMSD calculation is only applicable to sequence-based methods. Please avoid using this function when running shape-based superposition.
      
      .. seealso::

         * :ref:`SetValidRMSD <OESpruce_OESuperposeOptions_GetValidRMSD>` method

.. _OESpruce_OESuperposeOptions_GetValidTanimoto:

   .. oe:method:: GetValidTanimoto

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

         .. oe:api::

            double GetValidTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidTanimoto() -> float

      Returns the Tanimoto threshold for validating the superposition of the reference and fit molecules. 
      :oe:meth:`OESpruce::OESuperposeResults::IsValid` returns false if the Tanimoto of the superposed molecules is smaller than this 
      threshold. The default value is 0.0 for shape-based methods and -1.0 for sequence-based methods (Tanimoto calculation 
      is only applicable to shape-based methods).

      .. seealso::
         
         * :ref:`SetValidTanimoto <OESpruce_OESuperposeOptions_SetValidTanimoto>` method
         * :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>` method
         * :ref:`GetTanimoto <OESpruce_OESuperposeResults_GetTanimoto>` method


.. _OESpruce_OESuperposeOptions_SetValidTanimoto:

   .. oe:method:: SetValidTanimoto

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

         .. oe:api::

            bool SetValidTanimoto(double value)

      .. oe:language:: python

         .. oe:api:: python

            SetValidTanimoto(value: float) -> bool

      Sets the Tanimoto threshold for validating the superposition of the reference and fit molecules. 

      .. warning::

         Tanimoto calculation is only applicable to shape-based methods. Please avoid using this function when running sequence-based superposition.

      .. seealso::

         * :ref:`GetValidRMSD <OESpruce_OESuperposeOptions_GetValidRMSD>` method

.. _OESpruce_OESuperposeOptions_GetValidSeqScore:

   .. oe:method:: GetValidSeqScore

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

         .. oe:api::

            int GetValidSeqScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetValidSeqScore() -> int

      Returns the sequence alignment score threshold for validating the superposition of the reference and fit molecules. 
      :oe:meth:`OESpruce::OESuperposeResults::IsValid` returns false if the sequence alignment score of the superposed molecules is smaller 
      than this threshold. The default value is 200 for sequence-based methods and -1000 for shape-based methods (sequence alignment score  
      is only applicable to sequence-based methods).

      .. seealso::
         
         * :ref:`SetValidSeqScore <OESpruce_OESuperposeOptions_SetValidSeqScore>` method
         * :ref:`IsValid <OESpruce_OESuperposeResults_IsValid>` method
         * :ref:`GetSeqScore <OESpruce_OESuperposeResults_GetSeqScore>` method

.. _OESpruce_OESuperposeOptions_SetValidSeqScore:

   .. oe:method:: SetValidSeqScore

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

         .. oe:api::

            bool SetValidSeqScore(int value)

      .. oe:language:: python

         .. oe:api:: python

            SetValidSeqScore(value: int) -> bool

      Sets the sequence alignment score threshold for validating the superposition of the reference and fit molecules. 

      .. warning::

         sequence alignment score is only applicable to sequence-based methods. Please avoid using this function when running shape-based superposition.

      .. seealso::

         * :ref:`GetValidRMSD <OESpruce_OESuperposeOptions_GetValidRMSD>` method

.. _OESpruce_OESuperposeOptions_GetUseSeqScoreChainMatching:

   .. oe:method:: GetUseSeqScoreChainMatching

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

         .. oe:api::

            bool GetUseSeqScoreChainMatching() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseSeqScoreChainMatching() -> bool

      Returns whether or not combined sequence alignment score should be used to match chains for multi-chain complexes.

      .. seealso::

         * :ref:`SetUseSeqScoreChainMatching <OESpruce_OESuperposeOptions_SetUseSeqScoreChainMatching>` method

.. _OESpruce_OESuperposeOptions_SetUseSeqScoreChainMatching:

   .. oe:method:: SetUseSeqScoreChainMatching

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

         .. oe:api::

            bool SetUseSeqScoreChainMatching(bool value)

      .. oe:language:: python

         .. oe:api:: python

            SetUseSeqScoreChainMatching(value: bool) -> bool

      Sets whether or not combined sequence alignment score should be used to match chains for multi-chain complexes.

      .. seealso::

         * :ref:`GetUseSeqScoreChainMatching <OESpruce_OESuperposeOptions_GetUseSeqScoreChainMatching>` method
