{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Plotting with Matplotlib"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The default plotting extension for HoloViews until a 2.0 release is [Matplotlib](http://matplotlib.org) when HoloViews will start defaulting to [Bokeh](http://bokeh.pydata.org) (see the [Plotting with Bokeh](Plotting_with_Bokeh.ipynb) user guide).\n",
    "\n",
    "While the ``'bokeh'`` backend provides many useful interactive features, the ``'matplotlib'`` plotting extension is well suited to static exports for printed figures and because matplotlib is very full featured allows. To enable the ``'matplotlib'`` backend, we can initialize the Holoviews notebook extension:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import numpy as np\n",
    "import holoviews as hv\n",
    "from holoviews import opts\n",
    "\n",
    "hv.extension('matplotlib')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Working with matplotlib directly\n",
    "\n",
    "When HoloViews outputs matplotlib plots it creates and manipulates a matplotlib Figure, axes and artists in the background. If at any time you need access to the underlying matplotlib representation of an object you can use the ``hv.render`` function to convert it. For example let us convert a HoloViews ``Image`` to a matplotlib Figure, which will let us access and modify every aspect of the plot:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "img = hv.Image(np.random.rand(10, 10))\n",
    "\n",
    "fig = hv.render(img)\n",
    "\n",
    "print('Figure: ', fig)\n",
    "print('Axes:   ', fig.axes)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Static file format\n",
    "\n",
    "Matplotlib supports a wide range of export formats suitable for both web and print publishing. During interactive exploration in the Notebook, your results are always visible within the notebook itself, and usually png plots are good enough. To switch the default file format you can use the ``hv.output`` utility and control set ``fig`` option, supported formats include:\n",
    "\n",
    "    ['png', 'svg', 'pdf']\n",
    "    \n",
    "however pdf output is not supported in the notebook. To demonstrate let us switch output to SVG:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "hv.output(fig='svg')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Now when we create a plot in the notebook the output will be rendered as SVGs:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from holoviews.operation import contours\n",
    "\n",
    "x = y = np.arange(-3.0, 3.0, 0.1)\n",
    "X, Y = np.meshgrid(x, y) \n",
    "\n",
    "def g(x,y,c):\n",
    "    return 2*((x-y)**2/(x**2+y**2)) + np.exp(-(np.sqrt(x**2+y**2)-c)**2)\n",
    "\n",
    "img = hv.Image(g(X,Y,2))\n",
    "filled_contours = contours(img, filled=True)\n",
    "\n",
    "filled_contours"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The ``hv.save`` function allows exporting plots to all supported formats simply by changing the file extension. Certain formats support additional options, e.g. for png export we can also specify the ``dpi`` (dots per inch):"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "hv.save(filled_contours, 'contours.png', dpi=144)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To confirm the plot was exported correctly we can load it back in using IPython's Image object:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from IPython.display import Image\n",
    "Image('contours.png', width=400)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "For a publication, you will usually want to select SVG format by changing the file extension, because this vector format preserves the full resolution of all text and drawing elements.  SVG files can be be used in some document preparation programs directly (e.g. [LibreOffice](http://www.libreoffice.org/)), and can easily be converted using e.g. [Inkscape](https://inkscape.org) to PDF for use with PDFLaTeX or to EMF for use with Microsoft Word.  They can also be edited using Inkscape or other vector drawing programs to move graphical elements around, add arbitrary text, etc., if you need to make final tweaks before using the figures in a document.  You can also embed them within other SVG figures in such a drawing program, e.g. by creating a larger figure as a template that automatically incorporates multiple SVG files you have exported separately."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Animation support\n",
    "\n",
    "The ``'matplotlib'`` backend supports animated outputs either as video (using mp4 or webm formats) or as animated GIFS. This is useful for output to web pages that users can view without needing to interact with.  It can also be useful for creating descriptive pages for HoloViews constructs that require a live Python/Jupyter server rather than just a web page - see for example [DynamicMap](../reference/containers/matplotlib/DynamicMap.ipynb).\n",
    "\n",
    "### GIF\n",
    "\n",
    "In recent versions of matplotlib (>=2.2.0) GIF output can also be generated using [pillow](https://pillow.readthedocs.io/en/latest/), which is what HoloViews uses by default. The pillow dependency can be installed using conda or pip using: ``conda install pillow`` or ``pip install pillow``.\n",
    "\n",
    "To display a plot The speed of the animation is controlled using the ``fps`` (frames per second):"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "holomap = hv.HoloMap([(t, hv.Image(g(X,Y, 4 * np.sin(np.pi*t)))) for t in np.linspace(0,1,21)]).opts(\n",
    "    cmap='fire', colorbar=True, show_title=False, xaxis='bare', yaxis='bare')\n",
    "\n",
    "contour_hmap = contours(holomap, filled=True)\n",
    "\n",
    "hv.output(contour_hmap, holomap='gif', fps=5)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Animated output can also be exported using the save function by changing the file extension:\n",
    "    \n",
    "```python\n",
    "hv.save(contour_hmap, 'holomap.gif', fps=5)\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Videos\n",
    "\n",
    "Video output in matplotlib depends on ffmpeg, which may be [compiled from source](https://trac.ffmpeg.org/wiki/CompilationGuide), installed from conda using ``conda install ffmpeg``, or installed on OSX using brew using ``brew install ffmpeg``. To select video output use set the holomap format to ``'mp4'``:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "hv.output(contour_hmap, holomap='mp4', fps=5)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Plot size\n",
    "\n",
    "One of the major differences between the matplotlib extension and others is the way plot sizes work. In Plotly and Bokeh plot sizes are inside out, i.e. each plot defines its height and can then be composed together as needed, while matplotlib defines the size of the figure and the size of each subplot is relative to that. This affords greater control over plot aspect but can also make things more difficult. In HoloViews the size of a plot can be controlled using a couple of main options\n",
    "\n",
    "- **``aspect``**: Determines the aspect ratio of a subplot\n",
    "- **``fig_bounds``**: A four-tuple declaring the (left, bottom, right, top) of the plot in figure coordinates with a range of 0-1.\n",
    "- **``fig_inches``**: The size of the plot in inches can be a single which will be scaled according to the plots aspect or a tuple specifying both width and height).\n",
    "- **``fig_size``**: A percentage scaling factor."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "For example assuming a dpi (dots per inch) of 72, setting ``fig_inches=5``, ``aspect=2`` and ``fig_bounds=(0, 0, 1, 1)`` should produce a plot roughly 720 pixels wide and 360 pixels in height:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "hv.output(fig='png', dpi=72)\n",
    "filled_contours.opts(aspect=2, fig_inches=5, fig_bounds=(0, 0, 1, 1))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "This turns out to be not quite correct because any empty space will be clipped, e.g. the plot above is actually 603 × 318 pixels, however it is a good approximation.\n",
    "\n",
    "## Plot layouts\n",
    "\n",
    "Another aspect that differs quite substantially between matplotlib and other extension is the layout system. Since plots do not have an absolute size relative to one another it depends on the aspect of each plot. The main options to control the layout include:\n",
    "\n",
    "* **``aspect_weight``**: Whether to weight the aspect of plots when laying out plots (default=False).\n",
    "* **``hspace``**: Horizontal spacing between subplots.\n",
    "* **``tight``**: Whether to automatically reduce space between subplots.\n",
    "* **``vspace``**: Vertical space between subplots.\n",
    "\n",
    "First let us see what happens when we compose plots with different aspects, and use the ``tight`` option to reduce the vertical space between them (we could also manually reduce the ``vspace``):"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "line_contours = contours(img).opts(aspect=3)\n",
    "fill_contours = filled_contours.opts(aspect=2)\n",
    "\n",
    "opts.defaults(opts.Layout(sublabel_format='', fig_size=150))\n",
    "\n",
    "(line_contours + fill_contours).opts(tight=True)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "We can see that the two subplots have very different heights, to equalize this we can enable the ``aspect_weight`` option, which will rescale the subplots:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "(line_contours + fill_contours).opts(aspect_weight=True, tight=True)"
   ]
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python",
   "pygments_lexer": "ipython3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}
