.. include:: ../substitutions
.. include:: ../../common/cookbook/cookbook-hyperlinks
.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEGrapheme

.. oe:function:: OERenderRamachandranPlot

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OERenderRamachandranPlot(OEDepict::OEImageBase& image,
                                       const OERamachandranPlot& plot)

   .. oe:language:: python

      .. oe:api:: python

         OERenderRamachandranPlot(image: OEImageBase, plot: OERamachandranPlot) -> bool

   Renders the six Ramachandran plots into separate tabs of the given
   image.

   *image*
     The image on which the Ramachandran plots are rendered.

   *plot*
     The :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` object that stores the
     data of a Ramachandran plot.

   .. note::

      This functionality is **only available** for :file:`.svg`
      image format.

   **Example:**

   .. oe:source:: RenderRamachandranPlot.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

   .. oe:source:: RenderRamachandranPlot.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

   .. oe:source:: RenderRamachandranPlot.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

   .. oe:source:: RenderRamachandranPlot.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA

  .. _figure_RenderRamachandranPlot:

  .. only:: oehtml

     .. raw:: html

        <p align="center">
        <object data="../../_images/RenderRamachandranPlot.svg" type="image/svg+xml"  width = "600" ></object>
        <p>

        <p align="center">
        <b>Example of using the OERenderRamachandranPlot function</b>
        <p>

     .. image:: ../images/RenderRamachandranPlot.svg
        :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. oe:api::

      bool OERenderRamachandranPlot(OEDepict::OEImageBase &image,
                                    const OERamachandranPlot &plot,
                                    unsigned int ramatype)

   Renders a specific Ramachandran plot into the given image.

   *image*
     The image on which the specific Ramachandran plot is rendered.

   *plot*
     The :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` object that stores the
     data of a Ramachandran plot.

   *ramatype*
     The type of the Ramachandran plot being rendered.
     This value has to be from the :oe:constns:`OEBio::OERamaType`
     namespace.

   .. seealso::

      * :ref:`OERamachandranAnalysis <OEBio_OERamachandranAnalysis>` class in **OEChem TK** manual

   **Example:**

   .. oe:source:: RenderRamachandranPlot.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

   .. oe:source:: RenderRamachandranPlot.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

   .. oe:source:: RenderRamachandranPlot.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

   .. oe:source:: RenderRamachandranPlot.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-RAMA-GENERAL

  .. _figure_RenderRamachandranPlot_General:

  .. only:: oehtml

     .. raw:: html

        <p align="center">
        <object data="../../_images/RenderRamachandranPlot-General.svg" type="image/svg+xml"  width = "600" ></object>
        <p>

        <p align="center">
        <b>Example of using the OERenderRamachandranPlot function</b>
        <p>

     .. image:: ../images/RenderRamachandranPlot-General.svg
        :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

   .. admonition:: Code Example

      * `Ramachandran Plot`_ **OpenEye Python Cookbook** recipe
