.. _szmap_examples_szmapbestorientations:

Generate Szmap points and probe orientations at ligand atoms
================================================================================

A program that generates 3D conformations of probe molecules
and Szmap points at each ligand atom coordinate.

.. seealso::

   * :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` class
   * :ref:`OESzmapResults <OESzmap_OESzmapResults>` class
   * :oe:func:`OESzmap::OECalcSzmapValue` function
   * :oe:func:`OESzmap::OEIsClashing` function
   * :oe:constns:`OESzmap::OEEnsemble` namespace
   * :oe:constns:`OESzmap::OEComponent` namespace


Command Line Interface
----------------------

A description of the command line interface can be obtained by
executing the program with the --help argument.

.. oe:language:: c++

   .. code-block:: console

      SzmapBestOrientations --help

.. oe:language:: python

   .. code-block:: console

      python SzmapBestOrientations.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapBestOrientations --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapBestOrientations --help


will generate the following output:

.. code-block:: console

   Simple parameter list
    -l : Input ligand coordinates for calculations
    -o : Output file for points and probes molecules
    -p : Input protein (or other) context mol
    -prob : Cutoff for cumulative probability of probes


Code
----------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.cpp <../../../../sublibs/tklibs/szmap/examples/SzmapBestOrientations.cpp>`

   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.py <../../../../wrappers/python/examples/szmap/SzmapBestOrientations.py>`


   .. :ref:`Full listing. <listing-SzmapBestOrientations.py>`

   ..   literalinclude:: ../../../../wrappers/python/examples/szmap/SzmapBestOrientations.py


   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.java <../../../../wrappers/java/examples/openeye/examples/oeszmap/SzmapBestOrientations.java>`

   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`SzmapBestOrientations.cs <../../../../wrappers/csharp/Csharp-Examples/OESzmap/SzmapBestOrientations.cs>`

   .. only:: oepdf

      .. oe:source:: SzmapBestOrientations.cs
         :language: csharp

Examples
----------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> SzmapBestOrientations -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> python SzmapBestOrientations.py -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> java SzmapBestOrientations -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> SzmapBestOrientations -l 4std_lig.oeb.gz -p 4std_prot.oeb.gz -o SzmapBestOrientations.oeb.gz
