.. _section_examples_summary_shapeoverlap2pdf:

Depicting Shape and Color Atom Overlaps
===================================================================================

A program that depicts the shape and the color overlap between a 3D
reference structure and a sets of pre-aligned 3D fit molecules.
It is implemented to visualize the output of `ROCS <http://www.eyesopen.com/rocs>`_
but can be used to visualize the shape and color similarities of any
molecules that have been pre-aligned with other applications.

.. note::

   **OEShape TK** license is **not** required to run this example.

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

      prompt> shapeoverlap2pdf --help

.. oe:language:: python

   .. code-block:: console

      prompt> python shapeoverlap2pdf.py --help

.. oe:language:: java

   .. code-block:: console

      prompt> java ShapeOverlap2PDF --help

.. oe:language:: csharp

   .. code-block:: console

      prompt> ShapeOverlap2PDF --help


will generate the following output:

::

   [-in] <input> [-out] <output pdf>

    Simple parameter list
        input/output options:
          -in : Input molecule filename
          -out : Output image filename

        general options:
          -maxhits : Maximum number of hits depicted

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

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`shapeoverlap2pdf.py <../../../../wrappers/python/examples/grapheme/shapeoverlap2pdf.py>`

      .. literalinclude:: ../../../../wrappers/python/examples/grapheme/shapeoverlap2pdf.py

   .. only:: oepdf

      .. oe:source:: shapeoverlap2pdf.py
         :language: python

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`shapeoverlap2pdf.cpp <../../../../sublibs/tklibs/grapheme/examples/shapeoverlap2pdf.cpp>`
         and
         :download:`shapeoverlap2pdf.txt <../../../../sublibs/tklibs/grapheme/examples/shapeoverlap2pdf.txt>`
         interface file

   .. only:: oepdf

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

      With the shapeoverlap2pdf.txt interface file

      .. oe:source:: shapeoverlap2pdf.txt
         :language: c++

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeOverlap2PDF.java <../../../../wrappers/java/examples/openeye/examples/oegrapheme/ShapeOverlap2PDF.java>`
         and
         :download:`ShapeOverlap2PDF.txt <../../../../wrappers/java/examples/openeye/examples/oegrapheme/ShapeOverlap2PDF.txt>`
         interface file

   .. only:: oepdf

      .. oe:source:: ShapeOverlap2PDF.java
         :language: java

      With the ShapeOverlap2PDF.txt interface file

      .. oe:source:: ShapeOverlap2PDF.txt
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`ShapeOverlap2PDF.cs <../../../../wrappers/csharp/Csharp-Examples/OEGrapheme/ShapeOverlap2PDF.cs>`

   .. only:: oepdf

      .. oe:source:: ShapeOverlap2PDF.cs
         :language: csharp

.. seealso::

   * :ref:`OEColorForceField <OEShape_OEColorForceField>` class in the **OEShape TK**
   * :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` and
     :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>` classes
   * :oe:func:`OEGrapheme::OERenderShapeQuery` function
   * :oe:func:`OEGrapheme::OEShapeOverlapDisplay`,
     :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>`, and
     :ref:`OEColorOverlapDisplayOptions <OEGrapheme_OEColorOverlapDisplayOptions>` classes
   * :oe:func:`OEGrapheme::OERenderShapeOverlap` function
   * :oe:func:`OEGrapheme::OERenderColorOverlap` function
   * :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend` function
   * :oe:func:`OEGrapheme::OEDrawROCSScores` function

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

.. oe:language:: c++

   .. code-block:: console

      prompt> shapeoverlap2pdf -in  rocs.sdf -out overlaps.pdf

.. oe:language:: python

   .. code-block:: console

      prompt> python shapeoverlap2pdf.py -in rocs.sdf -out overlaps.pdf

.. oe:language:: java

   .. code-block:: console

      prompt> java ShapeOverlap2PDF -in rocs.sdf -out overlaps.pdf

.. oe:language:: csharp

   .. code-block:: console

      prompt> ShapeOverlap2PDF -in rocs.sdf -out overlaps.pdf

.. _table_depiction_shapeoverlap2pdf:

.. list-table::  **Example of depicting the shape and color atom overlaps** (The pages are reduced here for visualization convenience)
   :header-rows: 1
   :widths: 300 300 300

   * - page 1
     - page 2
     - page 3

   * -  .. image:: images/shapeoverlap2pdf-page-1.*
           :width: 400
     -  .. image:: images/shapeoverlap2pdf-page-2.*
           :width: 400
     -  .. image:: images/shapeoverlap2pdf-page-3.*
           :width: 400

