diff --git a/Examples.ipynb b/Examples.ipynb index cc43433..49bf383 100644 --- a/Examples.ipynb +++ b/Examples.ipynb @@ -23,7 +23,7 @@ }, { "cell_type": "code", - "execution_count": 1, + "execution_count": 2, "metadata": { "collapsed": false }, @@ -36,7 +36,7 @@ }, { "cell_type": "code", - "execution_count": 2, + "execution_count": 3, "metadata": { "collapsed": false }, @@ -21403,6 +21403,1574 @@ " figure.plot(x, x, rotate=90)" ] }, + { + "cell_type": "code", + "execution_count": 6, + "metadata": { + "collapsed": false + }, + "outputs": [ + { + "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": [ + "# You can plot multiple times the same figure\n", + "with replot.Figure() as fig:\n", + " fig.plot(range(10))\n", + " fig.show()\n", + " fig.plot(range(10), [-i for i in range(10)])" + ] + }, { "cell_type": "markdown", "metadata": {}, @@ -36511,7 +38079,7 @@ }, { "cell_type": "code", - "execution_count": 46, + "execution_count": 109, "metadata": { "collapsed": false }, @@ -37283,7 +38851,7 @@ { "data": { "text/html": [ - "" + "" ], "text/plain": [ "" diff --git a/replot/constants.py b/replot/constants.py index 337c77e..ff1e055 100644 --- a/replot/constants.py +++ b/replot/constants.py @@ -6,3 +6,10 @@ __VERSION__ = "0.0.1" # Default subplot group (reserved name) DEFAULT_GROUP = "_" + +# Default animation arguments +DEFAULT_ANIMATION_KWARGS = { + "frames": 200, + "interval": 20, + "blit": True, +} diff --git a/replot/figure.py b/replot/figure.py index 66e4b8f..c90a374 100644 --- a/replot/figure.py +++ b/replot/figure.py @@ -91,8 +91,6 @@ class Figure(): self.savepath = savepath self.custom_mpl_rc = custom_mpl_rc # Working attributes - self.figure = None - self.axes = None self.animation = {"type": False, "args": (), "kwargs": {}, "persist": []} @@ -126,9 +124,9 @@ class Figure(): if len(args) == 0 and self.savepath is not None: args = (self.savepath,) - self.render() - if self.figure is not None: - self.figure.savefig(*args, **kwargs) + figure = self.render() + if figure is not None: + figure.savefig(*args, **kwargs) else: raise exc.InvalidFigure("Invalid figure.") @@ -136,37 +134,36 @@ class Figure(): """ Render and show the :class:`Figure` object. """ - self.render() - if self.figure is not None: - self.figure.show() + figure = self.render() + if figure is not None: + figure.show() else: raise exc.InvalidFigure("Invalid figure.") def render(self): """ - Actually render the figure. Update ``self.figure`` attribute, but do \ - not show or save it. + Actually render the figure. - :returns: None. + :returns: A :mod:`matplotlib` figure object. """ # Use custom matplotlib context with plt.rc_context(rc=custom_mpl.custom_rc(rc=self.custom_mpl_rc)): - if self.figure is None or self.axes is None: - # Create figure if necessary - self._render_grid() + # Create figure if necessary + figure, axes = self._render_grid() # Render depending on animation type if self.animation["type"] is False: - self._render_no_animation() + self._render_no_animation(axes) elif self.animation["type"] == "gif": - self._render_gif_animation() + self._render_gif_animation(figure, axes) elif self.animation["type"] == "animation": # TODO return None else: return None # Use tight_layout to optimize layout, use custom padding - self.figure.tight_layout(pad=1) + figure.tight_layout(pad=1) # TODO: Messes up animations + return figure def set_grid(self, grid_description=None, height=None, width=None, ignore_groups=False, @@ -464,7 +461,7 @@ class Figure(): def _render_grid(self): """ - Helper method to fill ``self.figure`` and ``self.axes`` with \ + Helper method to create figure and axes with \ subplots according to the grid description. :returns: A tuple containing the figure object as first element, and \ @@ -505,9 +502,7 @@ class Figure(): # Set the axis for every subplot for subplot in self.plots: axes[subplot] = axis - # Set attributes - self.figure = figure - self.axes = axes + return (figure, axes) def _set_axes_properties(self, axis, group_): """ @@ -546,17 +541,19 @@ class Figure(): # Set yrange render_helpers.set_axis_property(group_, axis.set_ylim, self.yrange) - def _render_gif_animation(self): + def _render_gif_animation(self, figure, axes): """ Handle the render of a GIF-like animation, cycling through the plots. - :returns: A :mod:`matplotlib` figure. + :param figure: A :mod:`matplotlib` figure. + :param axes: A dict mapping the symbols of the groups to matplotlib \ + axes as second element. """ # Init # TODO - self.axes[constants.DEFAULT_GROUP].set_xlim((-2, 2)) - self.axes[constants.DEFAULT_GROUP].set_ylim((-2, 2)) - line, = self.axes[constants.DEFAULT_GROUP].plot([], []) + axes[constants.DEFAULT_GROUP].set_xlim((-2, 2)) + axes[constants.DEFAULT_GROUP].set_ylim((-2, 2)) + line, = axes[constants.DEFAULT_GROUP].plot([], []) # Define an animation function (closure) def animate(i): # TODO @@ -565,34 +562,30 @@ class Figure(): line.set_data(x, y) return line, # Set default kwargs - default_args = (self.figure, animate) - default_kwargs = { - "frames": 200, - "interval": 20, - "blit": True, - } + args = (figure, animate) + kwargs = constants.DEFAULT_ANIMATION_KWARGS # Update with overloaded arguments - default_args = default_args + self.animation["args"] - default_kwargs.update(self.animation["kwargs"]) + args += self.animation["args"] + kwargs.update(self.animation["kwargs"]) # Keep track of animation object, as it has to persist self.animation["persist"] = [ - animation.FuncAnimation(*default_args, **default_kwargs)] - return self.figure + animation.FuncAnimation(*args, **kwargs)] - def _render_no_animation(self): + def _render_no_animation(self, axes): """ Handle the render of the figure when no animation is used. - :returns: A :mod:`matplotlib` figure. + :param axes: A dict mapping the symbols of the groups to matplotlib \ + axes as second element. """ # Add plots for group_ in self.plots: # Get the axis corresponding to current group try: - axis = self.axes[group_] + axis = axes[group_] except KeyError: # If not found, plot in the default group - axis = self.axes[constants.DEFAULT_GROUP] + axis = axes[constants.DEFAULT_GROUP] # Skip this plot if the axis is None if axis is None: continue @@ -618,4 +611,3 @@ class Figure(): tmp_plot.set_clip_on(False) # Set ax properties self._set_axes_properties(axis, group_) - return self.figure