.. _superposition_opt_params:
.. include:: ../../apps-substitutions

..  program:: superposition

=================================
Optional Parameters
=================================

Input Options
--------------

.. option:: -fit_lig <filename>

   A file containing a ligand to use as a constraint during the superposition.
   Should only be used if the input is not an OEDesignUnit

   .. seealso::

      * :ref:`OESpruce::OESuperpose::SetupRef <OESpruce_OESuperPose_SetupRef>` and :ref:`OESpruce::OESuperpose::Superpose <OESpruce_OESuperPose_Superpose>` in the **Spruce TK** manual.

.. option:: -ref_lig <filename>

   A file containing a reference ligand to use as a constraint during the superposition.
   Should only be used if the input is not an OEDesignUnit

   .. seealso::

      * :ref:`OESpruce::OESuperpose::SetupRef <OESpruce_OESuperPose_SetupRef>` and :ref:`OESpruce::OESuperpose::Superpose <OESpruce_OESuperPose_Superpose>` in the **Spruce TK** manual.

Output Options
--------------

.. option:: -prefix <prefix>

   Prefix used to name output files, default is blank. To avoid overwriting input files,
   all structure files are automatically using the prefix `superposed_` if no prefix is specified.


.. option:: -log <logfile>

   The argument for this flag specifies the name of
   the log file. This overrides any specified prefix.

.. option:: -settings_file <settingsfile>

   (Alias: -settings)

   The argument for this flag specifies the name of
   the settings file. This overrides any specified prefix.

.. option:: -verbose

   Triggers copious logging output

Parameters
--------------

.. option:: -method <method>

   The method to use for superposition

   ==========  ======================================================================================
   Method      Description
   ==========  ======================================================================================
   global      Global Sequence Alignment to identify CA pairs
   ----------  --------------------------------------------------------------------------------------
   site        Global Sequence Alignment to identity CA pairs - focusing on the subset in active site
   ----------  --------------------------------------------------------------------------------------
   ddm         Superposition using the Distance Difference Matrix method (DDM)
   ----------  --------------------------------------------------------------------------------------
   sse         Superposition using an overlap of Secondary Structure Elements (SSE)
   ----------  --------------------------------------------------------------------------------------
   weighted    Superposition using Weighted DDM method
   ----------  --------------------------------------------------------------------------------------
   sitehopper  Superposition using SiteHopper
   ==========  ======================================================================================

   .. seealso::

      * :ref:`OESpruce::OESuperposeOptions::SetMethod <OESpruce_OESuperposeOptions_SetMethod>` in the **Spruce TK** manual.

.. option:: -valid_seqscore <value>

   Minimum sequence alignment score for the superposition to be considered valid

   [Default=200]

   .. seealso::

      * :ref:`OESpruce::OESuperposeOptions::SetValidSeqScore <OESpruce_OESuperposeOptions_SetValidSeqScore>` in the **Spruce TK** manual.

.. option:: -valid_rmsd <value>

   Maximum RMSD threshold for the superposition to be considered valid

   [Default=10.0]

   .. seealso::

      * :ref:`OESpruce::OESuperposeOptions::SetValidRMSD <OESpruce_OESuperposeOptions_SetValidRMSD>` in the **Spruce TK** manual.

.. option:: -valid_tanimoto <value>

   Minimum Tanimoto similarity threshold for the superposition to be considered valid

   [Default=0.0]

   .. seealso::

      * :ref:`OESpruce::OESuperposeOptions::SetValidTanimoto <OESpruce_OESuperposeOptions_SetValidTanimoto>` in the **Spruce TK** manual.
