diff --git a/Examples.ipynb b/Examples.ipynb index 078cb40..fb49d46 100644 --- a/Examples.ipynb +++ b/Examples.ipynb @@ -15889,7 +15889,7 @@ }, { "cell_type": "code", - "execution_count": 29, + "execution_count": 71, "metadata": { "collapsed": false }, @@ -16669,7 +16669,7 @@ { "data": { "text/html": [ - "" + "" ], "text/plain": [ "" @@ -16680,16 +16680,21 @@ } ], "source": [ - "# Gridify example\n", + "# Using apply_grid, you can define very easily (and visually) a quite complex grid layout\n", "with replot.Figure() as figure:\n", " figure.plot(np.cos, (-10, 10), group=\"a\")\n", " figure.plot(np.cos, (-10, 10), group=\"b\")\n", - " figure.gridify()" + " figure.plot(np.cos, (-10, 10), group=\"c\")\n", + " figure.plot(np.cos, (-10, 10), group=\"d\")\n", + " figure.plot(np.cos, (-10, 10), group=\"e\")\n", + " figure.apply_grid([\"aaa\",\n", + " \"bbc\",\n", + " \"dec\"])" ] }, { "cell_type": "code", - "execution_count": 30, + "execution_count": 70, "metadata": { "collapsed": false }, @@ -17479,12 +17484,1620 @@ "output_type": "display_data" } ], + "source": [ + "# Gridify example\n", + "# Use ignore_groups=True to put every plot in a different subplot,\n", + "# without having to deal with groups.\n", + "with replot.Figure() as figure:\n", + " figure.plot(np.cos, (-10, 10))\n", + " figure.plot(np.cos, (-10, 10))\n", + " figure.plot(np.cos, (-10, 10))\n", + " figure.gridify(ignore_groups=True)" + ] + }, + { + "cell_type": "code", + "execution_count": 72, + "metadata": { + "collapsed": false + }, + "outputs": [ + { + "name": "stderr", + "output_type": "stream", + "text": [ + "/home/phyks/.local/share/virtualenvs/physique/lib/python3.5/site-packages/matplotlib/pyplot.py:516: RuntimeWarning: More than 20 figures have been opened. Figures created through the pyplot interface (`matplotlib.pyplot.figure`) are retained until explicitly closed and may consume too much memory. (To control this warning, see the rcParam `figure.max_open_warning`).\n", + " max_open_warning, RuntimeWarning)\n" + ] + }, + { + "data": { + "application/javascript": [ + "/* Put everything inside the global mpl namespace */\n", + "window.mpl = {};\n", + "\n", + "mpl.get_websocket_type = function() {\n", + " if (typeof(WebSocket) !== 'undefined') {\n", + " return WebSocket;\n", + " } else if (typeof(MozWebSocket) !== 'undefined') {\n", + " return MozWebSocket;\n", + " } else {\n", + " alert('Your browser does not have WebSocket support.' +\n", + " 'Please try Chrome, Safari or Firefox ≥ 6. ' +\n", + " 'Firefox 4 and 5 are also supported but you ' +\n", + " 'have to enable WebSockets in about:config.');\n", + " };\n", + "}\n", + "\n", + "mpl.figure = function(figure_id, websocket, ondownload, parent_element) {\n", + " this.id = figure_id;\n", + "\n", + " this.ws = websocket;\n", + "\n", + " this.supports_binary = (this.ws.binaryType != undefined);\n", + "\n", + " if (!this.supports_binary) {\n", + " var warnings = document.getElementById(\"mpl-warnings\");\n", + " if (warnings) {\n", + " warnings.style.display = 'block';\n", + " warnings.textContent = (\n", + " \"This browser does not support binary websocket messages. \" +\n", + " \"Performance may be slow.\");\n", + " }\n", + " }\n", + "\n", + " this.imageObj = new Image();\n", + "\n", + " this.context = undefined;\n", + " this.message = undefined;\n", + " this.canvas = undefined;\n", + " this.rubberband_canvas = undefined;\n", + " this.rubberband_context = undefined;\n", + " this.format_dropdown = undefined;\n", + "\n", + " this.image_mode = 'full';\n", + "\n", + " this.root = $('
');\n", + " this._root_extra_style(this.root)\n", + " this.root.attr('style', 'display: inline-block');\n", + "\n", + " $(parent_element).append(this.root);\n", + "\n", + " this._init_header(this);\n", + " this._init_canvas(this);\n", + " this._init_toolbar(this);\n", + "\n", + " var fig = this;\n", + "\n", + " this.waiting = false;\n", + "\n", + " this.ws.onopen = function () {\n", + " fig.send_message(\"supports_binary\", {value: fig.supports_binary});\n", + " fig.send_message(\"send_image_mode\", {});\n", + " fig.send_message(\"refresh\", {});\n", + " }\n", + "\n", + " this.imageObj.onload = function() {\n", + " if (fig.image_mode == 'full') {\n", + " // Full images could contain transparency (where diff images\n", + " // almost always do), so we need to clear the canvas so that\n", + " // there is no ghosting.\n", + " fig.context.clearRect(0, 0, fig.canvas.width, fig.canvas.height);\n", + " }\n", + " fig.context.drawImage(fig.imageObj, 0, 0);\n", + " };\n", + "\n", + " this.imageObj.onunload = function() {\n", + " this.ws.close();\n", + " }\n", + "\n", + " this.ws.onmessage = this._make_on_message_function(this);\n", + "\n", + " this.ondownload = ondownload;\n", + "}\n", + "\n", + "mpl.figure.prototype._init_header = function() {\n", + " var titlebar = $(\n", + " '
');\n", + " var titletext = $(\n", + " '
');\n", + " titlebar.append(titletext)\n", + " this.root.append(titlebar);\n", + " this.header = titletext[0];\n", + "}\n", + "\n", + "\n", + "\n", + "mpl.figure.prototype._canvas_extra_style = function(canvas_div) {\n", + "\n", + "}\n", + "\n", + "\n", + "mpl.figure.prototype._root_extra_style = function(canvas_div) {\n", + "\n", + "}\n", + "\n", + "mpl.figure.prototype._init_canvas = function() {\n", + " var fig = this;\n", + "\n", + " var canvas_div = $('
');\n", + "\n", + " canvas_div.attr('style', 'position: relative; clear: both; outline: 0');\n", + "\n", + " function canvas_keyboard_event(event) {\n", + " return fig.key_event(event, event['data']);\n", + " }\n", + "\n", + " canvas_div.keydown('key_press', canvas_keyboard_event);\n", + " canvas_div.keyup('key_release', canvas_keyboard_event);\n", + " this.canvas_div = canvas_div\n", + " this._canvas_extra_style(canvas_div)\n", + " this.root.append(canvas_div);\n", + "\n", + " var canvas = $('');\n", + " canvas.addClass('mpl-canvas');\n", + " canvas.attr('style', \"left: 0; top: 0; z-index: 0; outline: 0\")\n", + "\n", + " this.canvas = canvas[0];\n", + " this.context = canvas[0].getContext(\"2d\");\n", + "\n", + " var rubberband = $('');\n", + " rubberband.attr('style', \"position: absolute; left: 0; top: 0; z-index: 1;\")\n", + "\n", + " var pass_mouse_events = true;\n", + "\n", + " canvas_div.resizable({\n", + " start: function(event, ui) {\n", + " pass_mouse_events = false;\n", + " },\n", + " resize: function(event, ui) {\n", + " fig.request_resize(ui.size.width, ui.size.height);\n", + " },\n", + " stop: function(event, ui) {\n", + " pass_mouse_events = true;\n", + " fig.request_resize(ui.size.width, ui.size.height);\n", + " },\n", + " });\n", + "\n", + " function mouse_event_fn(event) {\n", + " if (pass_mouse_events)\n", + " return fig.mouse_event(event, event['data']);\n", + " }\n", + "\n", + " rubberband.mousedown('button_press', mouse_event_fn);\n", + " rubberband.mouseup('button_release', mouse_event_fn);\n", + " // Throttle sequential mouse events to 1 every 20ms.\n", + " rubberband.mousemove('motion_notify', mouse_event_fn);\n", + "\n", + " rubberband.mouseenter('figure_enter', mouse_event_fn);\n", + " rubberband.mouseleave('figure_leave', mouse_event_fn);\n", + "\n", + " canvas_div.on(\"wheel\", function (event) {\n", + " event = event.originalEvent;\n", + " event['data'] = 'scroll'\n", + " if (event.deltaY < 0) {\n", + " event.step = 1;\n", + " } else {\n", + " event.step = -1;\n", + " }\n", + " mouse_event_fn(event);\n", + " });\n", + "\n", + " canvas_div.append(canvas);\n", + " canvas_div.append(rubberband);\n", + "\n", + " this.rubberband = rubberband;\n", + " this.rubberband_canvas = rubberband[0];\n", + " this.rubberband_context = rubberband[0].getContext(\"2d\");\n", + " this.rubberband_context.strokeStyle = \"#000000\";\n", + "\n", + " this._resize_canvas = function(width, height) {\n", + " // Keep the size of the canvas, canvas container, and rubber band\n", + " // canvas in synch.\n", + " canvas_div.css('width', width)\n", + " canvas_div.css('height', height)\n", + "\n", + " canvas.attr('width', width);\n", + " canvas.attr('height', height);\n", + "\n", + " rubberband.attr('width', width);\n", + " rubberband.attr('height', height);\n", + " }\n", + "\n", + " // Set the figure to an initial 600x600px, this will subsequently be updated\n", + " // upon first draw.\n", + " this._resize_canvas(600, 600);\n", + "\n", + " // Disable right mouse context menu.\n", + " $(this.rubberband_canvas).bind(\"contextmenu\",function(e){\n", + " return false;\n", + " });\n", + "\n", + " function set_focus () {\n", + " canvas.focus();\n", + " canvas_div.focus();\n", + " }\n", + "\n", + " window.setTimeout(set_focus, 100);\n", + "}\n", + "\n", + "mpl.figure.prototype._init_toolbar = function() {\n", + " var fig = this;\n", + "\n", + " var nav_element = $('
')\n", + " nav_element.attr('style', 'width: 100%');\n", + " this.root.append(nav_element);\n", + "\n", + " // Define a callback function for later on.\n", + " function toolbar_event(event) {\n", + " return fig.toolbar_button_onclick(event['data']);\n", + " }\n", + " function toolbar_mouse_event(event) {\n", + " return fig.toolbar_button_onmouseover(event['data']);\n", + " }\n", + "\n", + " for(var toolbar_ind in mpl.toolbar_items) {\n", + " var name = mpl.toolbar_items[toolbar_ind][0];\n", + " var tooltip = mpl.toolbar_items[toolbar_ind][1];\n", + " var image = mpl.toolbar_items[toolbar_ind][2];\n", + " var method_name = mpl.toolbar_items[toolbar_ind][3];\n", + "\n", + " if (!name) {\n", + " // put a spacer in here.\n", + " continue;\n", + " }\n", + " var button = $('');\n", + " button.click(method_name, toolbar_event);\n", + " button.mouseover(tooltip, toolbar_mouse_event);\n", + " nav_element.append(button);\n", + " }\n", + "\n", + " // Add the status bar.\n", + " var status_bar = $('');\n", + " nav_element.append(status_bar);\n", + " this.message = status_bar[0];\n", + "\n", + " // Add the close button to the window.\n", + " var buttongrp = $('
');\n", + " var button = $('');\n", + " button.click(function (evt) { fig.handle_close(fig, {}); } );\n", + " button.mouseover('Stop Interaction', toolbar_mouse_event);\n", + " buttongrp.append(button);\n", + " var titlebar = this.root.find($('.ui-dialog-titlebar'));\n", + " titlebar.prepend(buttongrp);\n", + "}\n", + "\n", + "mpl.figure.prototype._root_extra_style = function(el){\n", + " var fig = this\n", + " el.on(\"remove\", function(){\n", + "\tfig.close_ws(fig, {});\n", + " });\n", + "}\n", + "\n", + "mpl.figure.prototype._canvas_extra_style = function(el){\n", + " // this is important to make the div 'focusable\n", + " el.attr('tabindex', 0)\n", + " // reach out to IPython and tell the keyboard manager to turn it's self\n", + " // off when our div gets focus\n", + "\n", + " // location in version 3\n", + " if (IPython.notebook.keyboard_manager) {\n", + " IPython.notebook.keyboard_manager.register_events(el);\n", + " }\n", + " else {\n", + " // location in version 2\n", + " IPython.keyboard_manager.register_events(el);\n", + " }\n", + "\n", + "}\n", + "\n", + "mpl.figure.prototype._key_event_extra = function(event, name) {\n", + " var manager = IPython.notebook.keyboard_manager;\n", + " if (!manager)\n", + " manager = IPython.keyboard_manager;\n", + "\n", + " // Check for shift+enter\n", + " if (event.shiftKey && event.which == 13) {\n", + " this.canvas_div.blur();\n", + " event.shiftKey = false;\n", + " // Send a \"J\" for go to next cell\n", + " event.which = 74;\n", + " event.keyCode = 74;\n", + " manager.command_mode();\n", + " manager.handle_keydown(event);\n", + " }\n", + "}\n", + "\n", + "mpl.figure.prototype.handle_save = function(fig, msg) {\n", + " fig.ondownload(fig, null);\n", + "}\n", + "\n", + "\n", + "mpl.find_output_cell = function(html_output) {\n", + " // Return the cell and output element which can be found *uniquely* in the notebook.\n", + " // Note - this is a bit hacky, but it is done because the \"notebook_saving.Notebook\"\n", + " // IPython event is triggered only after the cells have been serialised, which for\n", + " // our purposes (turning an active figure into a static one), is too late.\n", + " var cells = IPython.notebook.get_cells();\n", + " var ncells = cells.length;\n", + " for (var i=0; i= 3 moved mimebundle to data attribute of output\n", + " data = data.data;\n", + " }\n", + " if (data['text/html'] == html_output) {\n", + " return [cell, data, j];\n", + " }\n", + " }\n", + " }\n", + " }\n", + "}\n", + "\n", + "// Register the function which deals with the matplotlib target/channel.\n", + "// The kernel may be null if the page has been refreshed.\n", + "if (IPython.notebook.kernel != null) {\n", + " IPython.notebook.kernel.comm_manager.register_target('matplotlib', mpl.mpl_figure_comm);\n", + "}\n" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], "source": [ "# Gridify example\n", "with replot.Figure() as figure:\n", " figure.plot(np.cos, (-10, 10), group=\"a\")\n", " figure.plot(np.cos, (-10, 10), group=\"b\")\n", " figure.plot(np.cos, (-10, 10))\n", + " figure.plot(np.sin, (-10, 10))\n", " figure.gridify()" ] }, diff --git a/README.md b/README.md index 0162cae..6ff79d7 100644 --- a/README.md +++ b/README.md @@ -16,54 +16,66 @@ design in the API, or required feature!
Matplotlib plots are quite ugly by default, colors are not really suited for optimal black and white print, or ease reading for colorblind people. This module imports and makes use of - [Seaborn](https://github.com/mwaskom/seaborn) for saner default params.
+ [Seaborn](https://github.com/mwaskom/seaborn) for saner default + params. -
Support `with` statement
+
Support with statement
Ever got tired of having to start any figure with a call to - `matplotlib.pyplot.subplots()`? This module abstracts it using `with` - statement. New figures are defined by a `with` statement, and are `show`n - automatically (or `save`d) upon leaving the `with` context. + matplotlib.pyplot.subplots()? This module abstracts it using + with statement. New figures are defined by a + with statement, and are shown automatically (or + saved) upon leaving the with context.
Plot functions
-
Ever got annoyed by the fact that `matplotlib` can only plot point - series and not evaluate a function _à la_ Mathematica? This module let - you do things like `plot(sin, (-10, 10))` to plot a sine function between - -10 and 10, using adaptive sampling. +
Ever got annoyed by the fact that matplotlib can only + plot point series and not evaluate a function à la Mathematica? + This module let you do things like plot(sin, (-10, 10)) to + plot a sine function between -10 and 10, using adaptive sampling.
Order of call of methods is no longer important
-
When calling a method from `matplotlib`, it is directly applied to the - figure, and not deferred to the final render call. Then, if calling - `matplotlib.pyplot.legend()` **before** having actually `plot`ted - anything, it will fail. This is not the case with this module, as it - abstracts on top of `matplotlib` and do the actual render only when the - figure is to be `show`n. Even after having called the `show` method, you - can still change everything in your figure!
+
When calling a method from matplotlib, it is directly + applied to the figure, and not deferred to the final render call. Then, if + calling matplotlib.pyplot.legend() **before** having actually + plotted anything, it will fail. This is not the case with + this module, as it abstracts on top of matplotlib and do the + actual render only when the figure is to be shown. Even after + having called the show method, you can still change + everything in your figure!
-
Does not interfere with `matplotlib`
-
You can still use the default `matplotlib` if you want, as - `matplotlib` state and parameters are not directly affected by this - module, contrary to what `seaborn` do when you import it for - instance.
+
Does not interfere with matplotlib
+
You can still use the default matplotlib if you want, as + matplotlib state and parameters are not directly affected by + this module, contrary to what seaborn do when you import it + for instance.
Useful aliases
-
You think `loc="top left"` is easier to remember than `loc="upper - left"` in a `matplotlib.pyplot.legend()` call? No worry, this module - aliases it for you! (same for "bottom" with respect to "lower")
+
You think loc="top left" is easier to remember than + loc="upper left" in a matplotlib.pyplot.legend() + call? No worry, this module aliases it for you! (same for "bottom" with + respect to "lower")
Automatic legend
-
If any of your plots contains a `label` keyword, a legend will be - added automatically on your graph (you can still explicitly tell it not to - add a legend by setting the `legend` attribute to `False`).
+
If any of your plots contains a label keyword, a legend + will be added automatically on your graph (you can still explicitly tell + it not to add a legend by setting the legend attribute to + False).
-
Use `LaTeX` rendering in `matplotlib`, if available.
-
If `replot` finds `LaTeX` installed on your machine, it will overload - `matplotlib` settings to use `LaTeX` rendering.
+
Use LaTeX rendering in matplotlib, if + available.
+
If replot finds LaTeX installed on your + machine, it will overload matplotlib settings to use + LaTeX rendering.
Handle subplots more easily
-
**TODO**
+
Have you ever struggled with matplotlib to define a subplot + grid and arrange your plot? replot lets you describe your + grid visually using ascii art!
"Gridify"
-
**TODO**
+
You have some plots that you would like to arrange into a grid, to + compare them easily, but you do not want to waste time setting up a grid + and placing your plots at the correct place? gridify method + just does it for you!
diff --git a/replot/__init__.py b/replot/__init__.py index f8a84ef..311bdde 100644 --- a/replot/__init__.py +++ b/replot/__init__.py @@ -155,7 +155,7 @@ class Figure(): "Invalid grid provided. You did not use rectangular areas " + "for each group.") - def gridify(self, height=None, width=None): + def gridify(self, height=None, width=None, ignore_groups=False): """ Apply an automatic grid on the figure, trying to fit best to the \ number of plots. @@ -169,7 +169,22 @@ class Figure(): :param height: An optional ``height`` for the grid. :param width: An optional ``height`` for the grid. + :param ignore_groups: By default, ``gridify`` will use groups to \ + organize plots in different subplots. If you want to put \ + every plot in a different subplot, without dealing with \ + groups, you can set this to ``True``. """ + if ignore_groups: + # If we want to ignore groups, we will start by creating a new + # group for every existing plot + existing_plots = [] + for group_ in self.plots: + existing_plots.extend(self.plots[group_]) + self.plots = collections.defaultdict(list, + {chr(i): [existing_plots[i]] + for i in + range(len(existing_plots))}) + # Find the optimal layout nb_groups = len(self.plots) if height is None and width is not None: