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

.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperpositionType, SuperpositionType

.. oe:constnamespace:: OESuperpositionType

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants for superpositioning methods.

   .. seealso::

      * :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class

   .. oe:constant:: Default

      The default superpositioning method is
      :oe:const:`OESpruce::OESuperpositionType::Global`.

   .. oe:constant:: DDM

      Calculate superposition using the **D**\ istance **D**\ ifference **M**\ atrix method.

   .. oe:constant:: Global

      Calculate superposition using the all matched atoms.


   .. oe:constant:: Site

      Calculate superposition using the input site residues. Site residues must be set with the
      :oe:meth:`OESpruce::OESuperpositionOptions::SetSiteResidues` member function of the :ref:`OESuperpositionOptions <OESpruce_OESuperpositionOptions>` class.

   .. oe:constant:: SSE

      Calculate superposition using an overlap of **S**\ econdary **S**\ tructure **E**\ lements.

      .. seealso::

         * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

   .. oe:constant:: Undefined

      Superposition method is undefined. No superposition will take place.

   .. oe:constant:: Weighted

      Calculate a weighted superposition using weights taken from the Difference Distance Matrix.
