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

.. oe:namespace:: OEGrapheme

.. oe:function:: OERenderBFactorMap

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

      .. oe:api::

         bool OERenderBFactorMap(OEDepict::OEImageBase& image,
                                 const OE2DActiveSiteDisplay& adisp)

   .. oe:language:: python

      .. oe:api:: python

         OERenderBFactorMap(image: OEImageBase, adisp: OE2DActiveSiteDisplay) -> bool

   Renders the B-factor information of an active site display into an image.

   *image*
      The image in which the active site is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the B-Factor information of an active site.

   **Example:**

   .. oe:source:: RenderBFactorMap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP

   .. oe:source:: RenderBFactorMap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP

   .. oe:source:: RenderBFactorMap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP

   .. oe:source:: RenderBFactorMap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-RENDER-BFACTORMAP


  .. _figure_RenderBFactorMap:

     .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over any residue circles</b>
         </p>

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

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

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

   .. only:: oepdf

      .. figure:: ../images/RenderBFactorMap.pdf
         :align:  center

         **Example of using the OERenderBfactorMap function**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawBFactorMapLegend` function
      * :oe:func:`OEGrapheme::OERenderActiveSite` function
      * :oe:func:`OEGrapheme::OERenderActiveSiteMaps` function
      * :oe:func:`OEGrapheme::OERenderContactMap` function
      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand B-Factor`_  **OpenEye Python Cookbook** example
      * `Visualizing Protein-Ligand B-Factor Map`_  **OpenEye Python Cookbook** example
