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

.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESecondaryStructureSuperposition, SecondaryStructure, SecondaryStructureSuperposition, Superposition


.. _OESpruce_OESecondaryStructureSuperposition:

.. oe:class:: OESecondaryStructureSuperposition

   .. warning::

      |DEPRECATED-API|
      Please use :ref:`OESuperpose <OESpruce_OESuperpose>` class instead. 

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESecondaryStructureSuperposition

   This class represents
   :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` that performs
   a structural superposition on fit protein to a reference using a
   shape-based alignment of the secondary structure elements.

   .. seealso::

      * :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class
      * :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OESecondaryStructureSuperposition(const OEChem::OEMolBase& refMol,
                                              const OEChem::OEMolBase& fitMol,
                                              const OESuperpositionOptions& argOpts = OESuperpositionOptions())

      .. oe:language:: python

         .. oe:api:: python

            OESecondaryStructureSuperposition(refMol: Union[OEGraphMol,OEMol,OEQMol],
                                              fitMol: Union[OEGraphMol,OEMol,OEQMol],
                                              argOpts: OESuperpositionOptions = OESuperpositionOptions()) -> OESecondaryStructureSuperposition

      Constructor that superimposes the ``fitMol`` to the ``refMol`` by using a shape-based
      alignment to the secondary structure elements.
      If no :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` are passed in as ``argOpts``,
      then the default behavior of using a superposition to all globally matched atoms will be used.

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

         .. oe:api::

            OESecondaryStructureSuperposition(const OESecondaryStructureSuperposition& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESecondaryStructureSuperposition(rhs: OESecondaryStructureSuperposition) -> OESecondaryStructureSuperposition

      Copy constructor.

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

      .. oe:api::

         OESecondaryStructureSuperposition &operator=(const OESecondaryStructureSuperposition &rhs)

      Assignment operator.

   ..   _OESpruce_OESecondaryStructureSuperposition_operator_bool:

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` object is
      valid.

   ..   _OESpruce_OESecondaryStructureSuperposition_GetFitChains:

   .. oe:method:: GetFitChains

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

         .. oe:api::

            std::vector<std::string> GetFitChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitChains() -> OEStringVector

      Returns 1-letter code of all names of fit protein chains.

      .. seealso::

         * :ref:`GetRefChains <OESpruce_OESecondaryStructureSuperposition_GetRefChains>` method

   ..   _OESpruce_OESecondaryStructureSuperposition_GetRefChains:

   .. oe:method:: GetRefChains

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

         .. oe:api::

            std::vector<std::string> GetRefChains() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefChains() -> OEStringVector

      Returns 1-letter code of all names of reference protein chains.

      .. seealso::

         * `GetFitChains <OESpruce_OESecondaryStructureSuperposition_GetFitChains>` method

   .. oe:method:: GetRotMatrix

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

         .. oe:api::

            bool GetRotMatrix(double* rmat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(rmat: OEDoubleArray)

      Returns by reference the rotation matrix of the superposition.

   .. oe:method:: GetTanimoto

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

         .. oe:api::

            double GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      Returns the Tanimoto score for the structural superposition.

   .. oe:method:: GetTranslation

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

         .. oe:api::

            bool GetTranslation(double* trans) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(trans: OEDoubleArray)

      Returns by reference the translation vector of the superposition.

   ..   _OESpruce_OESecondaryStructureSuperposition_Transform:

   .. oe:method:: Transform

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

         .. oe:api::

            void Transform(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> None

      Transforms the input molecule using the stored rotation matrix and translation vector from the superposition.
