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

.. oe:namespace:: OESpruce

.. meta::
   :keywords: OEStructuralSuperposition, StructuralSuperposition, Superposition


.. _OESpruce_OEStructuralSuperposition:

.. oe:class:: OEStructuralSuperposition

   .. warning::

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

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEStructuralSuperposition

   This class represents :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>`
   that performs a structural superposition on fit protein to a
   reference protein, using a superposition method given as an
   optional parameter.

   .. seealso::

      * :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class
      * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class


   .. oe:method:: Constructors

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

         .. oe:api::

            OEStructuralSuperposition(const OEChem::OEMolBase& argRefMol,
                                      const OEChem::OEMolBase& argFitMol,
                                      const OESuperpositionOptions& argOpts = OESuperpositionOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEStructuralSuperposition(argRefMol: Union[OEGraphMol,OEMol,OEQMol],
                                      argFitMol: Union[OEGraphMol,OEMol,OEQMol],
                                      argOpts: OESuperpositionOptions = OESuperpositionOptions()) -> OEStructuralSuperposition

      Constructor that superimposes the ``argFitMol`` to the ``argRefMol``.
      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.

      Both ``argRefMol`` and ``argFitMol`` must have 3D coordinates assigned.

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

         .. oe:api::

            OEStructuralSuperposition(const OEStructuralSuperposition& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEStructuralSuperposition(rhs: OEStructuralSuperposition) -> OEStructuralSuperposition

      Copy constructor.

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

      .. oe:api::

         OEStructuralSuperposition &operator=(const OEStructuralSuperposition &rhs)

      Assignment operator.

   ..   _OESpruce_OEStructuralSuperposition_operator_bool:


   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool()

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEStructuralSuperposition <OESpruce_OEStructuralSuperposition>` object is
      valid.

   ..   _OESpruce_OEStructuralSuperposition_ConstraintsMet:

   .. oe:method:: ConstraintsMet

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

          .. oe:api::

             bool ConstraintsMet() const

       .. oe:language:: python

          .. oe:api:: python

             ConstraintsMet() -> bool

      Returns whether or not the constraints were met.

   ..   _OESpruce_OEStructuralSuperposition_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::

         * :oe:meth:`OESpruce::OEStructuralSuperposition::GetRefChains` method

   ..   _OESpruce_OEStructuralSuperposition_GetRMSD:


   .. oe:method:: GetRMSD

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

         .. oe:api::

            double GetRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSD() -> float

      Returns the RMSD of the structural superposition.

   ..   _OESpruce_OEStructuralSuperposition_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::

         * :oe:meth:`OESpruce::OEStructuralSuperposition::GetFitChains` method

   ..   _OESpruce_OEStructuralSuperposition_GetRegion:


   .. oe:method:: GetRegion

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

         .. oe:api::

            std::vector<int> GetRegion() const

      .. oe:language:: python

         .. oe:api:: python

            GetRegion() -> OEIntVector

      Returns the index of all residues involved in the alignment.

   ..   _OESpruce_OEStructuralSuperposition_GetRotMatrix:


   .. oe:method:: GetRotMatrix

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

         .. oe:api::

            void GetRotMatrix(double* rmat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(rmat: OEDoubleArray) -> None

      Returns by reference the rotation matrix of the superposition.

   ..   _OESpruce_OEStructuralSuperposition_GetScore:


   .. oe:method:: GetScore

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

         .. oe:api::

            int GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> int

      Returns the sequence alignment score for the structural superposition.

   ..   _OESpruce_OEStructuralSuperposition_GetTranslation:


   .. oe:method:: GetTranslation

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

         .. oe:api::

            void GetTranslation(double* trans) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(trans: OEDoubleArray) -> None

      Returns by reference the translation vector of the superposition.

   ..   _OESpruce_OEStructuralSuperposition_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.
