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

.. oe:namespace:: OESpruce

.. meta::
   :keywords: OESuperposeMethod, SuperposeMethod

..  _OESpruce_OESuperposeMethod:

.. oe:constnamespace:: OESuperposeMethod

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants for superpositioning methods.

   .. seealso::

      * :ref:`OESuperposeOptions <OESpruce_OESuperposeOptions>` class

   .. admonition:: Code Example

      * :ref:`spruce_examples_superposition` example

..  _OESpruce_OESuperposeMethod_Default:

   .. oe:constant:: Default

      The default superpositioning method is
      GlobalCarbonAlpha.

..  _OESpruce_OESuperposeMethod_GlobalCarbonAlpha:

   .. oe:constant:: GlobalCarbonAlpha

      Calculate superposition using the all matched alpha carbon atoms.

..  _OESpruce_OESuperposeMethod_Global:

   .. oe:constant:: Global

      Alias for :oe:const:`OESpruce::OESuperposeMethod::GlobalCarbonAlpha`.

..  _OESpruce_OESuperposeMethod_SiteSequence:


   .. oe:constant:: SiteSequence

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

..  _OESpruce_OESuperposeMethod_Site:


   .. oe:constant:: Site

      Alias for SiteSequence.

..  _OESpruce_OESuperposeMethod_DifferenceDistanceMatrix:


   .. oe:constant:: DifferenceDistanceMatrix

      Calculate superposition using the **D**\ istance **D**\ ifference **M**\ atrix method. See
      :ref:`Protein Superposition <spruce_superposition_section>` for more information.

..  _OESpruce_OESuperposeMethod_DDM:


   .. oe:constant:: DDM

      Alias for DifferenceDistanceMatrix.

..  _OESpruce_OESuperposeMethod_WeightedDifferenceDistanceMatrix:

   .. oe:constant:: WeightedDifferenceDistanceMatrix

      Calculate a weighted superposition using weights taken from the Difference Distance Matrix. See
      :ref:`Protein Superposition <spruce_superposition_section>` for more information.

..  _OESpruce_OESuperposeMethod_Weighted:


   .. oe:constant:: Weighted

      Alias for  WeightedDifferenceDistanceMatrix.

..  _OESpruce_OESuperposeMethod_SecondaryStructureElements:


   .. oe:constant:: SecondaryStructureElements

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

      .. seealso::

         * :ref:`OESecondaryStructureSuperposition <OESpruce_OESecondaryStructureSuperposition>` class

..  _OESpruce_OESuperposeMethod_SSE:


   .. oe:constant:: SSE

      Alias for  SecondaryStructureElements.

..  _OESpruce_OESuperposeMethod_SiteHopper:


   .. oe:constant:: SiteHopper

      Calculates the superposition using SiteHopper

      .. seealso::

         * :ref:`oesitehopper_chapter_intro`

..  _OESpruce_OESuperposeMethod_Undefined:


   .. oe:constant:: Undefined

      Superposition method is undefined. No superposition will take place.

