.. _f-colormap:

module ``graphhelper._colormap``
================================





.. inheritance-diagram:: pyensae.graphhelper._colormap


Short summary
+++++++++++++

module ``pyensae.graphhelper._colormap``

CorrPlot functionalities.

It comes from `corrplot.py <https://raw.githubusercontent.com/biokit/biokit/master/biokit/viz/corrplot.py>`_
which I copied here because the module does not properly work on Python 3 (import issues).
See also `biokit license <https://github.com/biokit/biokit/blob/master/LICENSE>`_.

:author: Thomas Cokelaer
:references: http://cran.r-project.org/web/packages/corrplot/vignettes/corrplot-intro.html


:githublink:`%|py|12`




Classes
+++++++

+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| class                                                      | truncated documentation                                                                                                    |
+============================================================+============================================================================================================================+
| :class:`Color <pyensae.graphhelper._colormap.Color>`       | Lists of known colors.                                                                                                     |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :class:`Colormap <pyensae.graphhelper._colormap.Colormap>` | Snippets of code from `colormap/colors.py <https://github.com/cokelaer/colormap/blob/master/src/colormap/colors.py>`_, ... |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| function                                                          | truncated documentation                                                                                                          |
+===================================================================+==================================================================================================================================+
| :func:`cmap_builder <pyensae.graphhelper._colormap.cmap_builder>` | Returns a colormap object compatible with matplotlib If only parameter **name** is provided, it should be a known matplotlib ... |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+----------------------------------------------------------------------------------+-------------------------+
| property                                                                         | truncated documentation |
+==================================================================================+=========================+
| :meth:`colormaps <pyensae.graphhelper._colormap.Colormap.colormaps>`             |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :meth:`diverging_black <pyensae.graphhelper._colormap.Colormap.diverging_black>` |                         |
+----------------------------------------------------------------------------------+-------------------------+






Methods
+++++++

+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| method                                                                                        | truncated documentation                                       |
+===============================================================================================+===============================================================+
| :py:meth:`__init__ <pyensae.graphhelper._colormap.Color.__init__>`                            |                                                               |
+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| :py:meth:`_get_colormap_mpl <pyensae.graphhelper._colormap.Colormap._get_colormap_mpl>`       |                                                               |
+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| :py:meth:`_get_diverging_black <pyensae.graphhelper._colormap.Colormap._get_diverging_black>` |                                                               |
+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| :meth:`cmap <pyensae.graphhelper._colormap.Colormap.cmap>`                                    | Returns a colormap object to be used within matplotlib        |
+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| :meth:`cmap_linear <pyensae.graphhelper._colormap.Colormap.cmap_linear>`                      | Provides 3 colors in format accepted by :class:`Color`        |
+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| :meth:`set_hex <pyensae.graphhelper._colormap.Color.set_hex>`                                 | Converts a string like ``#AABBCC`` into `(red, green, blue)`. |
+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyensae.graphhelper._colormap
    :members:
    :special-members: __init__
    :show-inheritance: