From 809044c6983bc2dab2b6cf29803b19292c066c87 Mon Sep 17 00:00:00 2001 From: "Phyks (Lucas Verney)" Date: Wed, 2 Mar 2016 17:40:39 +0100 Subject: [PATCH] Handle groups of plots But no difference between grouped plots and ungrouped plots at the moment. --- Examples.ipynb | 1592 ++++++++++++++++++++++++++++++++++++++++++++ replot/__init__.py | 168 +++-- 2 files changed, 1697 insertions(+), 63 deletions(-) diff --git a/Examples.ipynb b/Examples.ipynb index 9ad0a94..a0ed52b 100644 --- a/Examples.ipynb +++ b/Examples.ipynb @@ -15099,6 +15099,1598 @@ " figure.plot()" ] }, + { + "cell_type": "code", + "execution_count": 47, + "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" + }, + { + "ename": "InvalidParameterError", + "evalue": "Group name cannot be longer than one unicode character.", + "output_type": "error", + "traceback": [ + "\u001b[1;31m---------------------------------------------------------------------------\u001b[0m", + "\u001b[1;31mInvalidParameterError\u001b[0m Traceback (most recent call last)", + "\u001b[1;32m\u001b[0m in \u001b[0;36m\u001b[1;34m()\u001b[0m\n\u001b[0;32m 1\u001b[0m \u001b[1;32mwith\u001b[0m \u001b[0mreplot\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mFigure\u001b[0m\u001b[1;33m(\u001b[0m\u001b[1;33m)\u001b[0m \u001b[1;32mas\u001b[0m \u001b[0mfigure\u001b[0m\u001b[1;33m:\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[1;32m----> 2\u001b[1;33m \u001b[0mfigure\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mplot\u001b[0m\u001b[1;33m(\u001b[0m\u001b[0mnp\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mcos\u001b[0m\u001b[1;33m,\u001b[0m \u001b[1;33m(\u001b[0m\u001b[1;33m-\u001b[0m\u001b[1;36m10\u001b[0m\u001b[1;33m,\u001b[0m \u001b[1;36m10\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m,\u001b[0m \u001b[0mgroup\u001b[0m\u001b[1;33m=\u001b[0m\u001b[1;34m\"abc\"\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0m", + "\u001b[1;32m/home/phyks/Code/replot/replot/__init__.py\u001b[0m in \u001b[0;36mplot\u001b[1;34m(self, *args, **kwargs)\u001b[0m\n\u001b[0;32m 129\u001b[0m \u001b[1;31m# Extra custom kwargs (the ones from replot but not matplotlib) from\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 130\u001b[0m \u001b[1;31m# kwargs\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[1;32m--> 131\u001b[1;33m \u001b[0mkwargs\u001b[0m\u001b[1;33m,\u001b[0m \u001b[0mcustom_kwargs\u001b[0m \u001b[1;33m=\u001b[0m \u001b[0m_handle_custom_plot_arguments\u001b[0m\u001b[1;33m(\u001b[0m\u001b[0mkwargs\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0m\u001b[0;32m 132\u001b[0m \u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 133\u001b[0m \u001b[1;32mif\u001b[0m \u001b[0mhasattr\u001b[0m\u001b[1;33m(\u001b[0m\u001b[0margs\u001b[0m\u001b[1;33m[\u001b[0m\u001b[1;36m0\u001b[0m\u001b[1;33m]\u001b[0m\u001b[1;33m,\u001b[0m \u001b[1;34m\"__call__\"\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m:\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n", + "\u001b[1;32m/home/phyks/Code/replot/replot/__init__.py\u001b[0m in \u001b[0;36m_handle_custom_plot_arguments\u001b[1;34m(kwargs)\u001b[0m\n\u001b[0;32m 253\u001b[0m \u001b[1;32mif\u001b[0m \u001b[0mlen\u001b[0m\u001b[1;33m(\u001b[0m\u001b[0mkwargs\u001b[0m\u001b[1;33m[\u001b[0m\u001b[1;34m\"group\"\u001b[0m\u001b[1;33m]\u001b[0m\u001b[1;33m)\u001b[0m \u001b[1;33m>\u001b[0m \u001b[1;36m1\u001b[0m\u001b[1;33m:\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 254\u001b[0m raise exc.InvalidParameterError(\n\u001b[1;32m--> 255\u001b[1;33m \"Group name cannot be longer than one unicode character.\")\n\u001b[0m\u001b[0;32m 256\u001b[0m \u001b[0mcustom_kwargs\u001b[0m\u001b[1;33m[\u001b[0m\u001b[1;34m\"group\"\u001b[0m\u001b[1;33m]\u001b[0m \u001b[1;33m=\u001b[0m \u001b[0mkwargs\u001b[0m\u001b[1;33m[\u001b[0m\u001b[1;34m\"group\"\u001b[0m\u001b[1;33m]\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 257\u001b[0m \u001b[1;32mdel\u001b[0m \u001b[0mkwargs\u001b[0m\u001b[1;33m[\u001b[0m\u001b[1;34m\"group\"\u001b[0m\u001b[1;33m]\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n", + "\u001b[1;31mInvalidParameterError\u001b[0m: Group name cannot be longer than one unicode character." + ] + } + ], + "source": [ + "with replot.Figure() as figure:\n", + " figure.plot(np.cos, (-10, 10), group=\"abc\")" + ] + }, { "cell_type": "code", "execution_count": null, diff --git a/replot/__init__.py b/replot/__init__.py index 5293388..021c0f8 100644 --- a/replot/__init__.py +++ b/replot/__init__.py @@ -2,6 +2,7 @@ The :mod:`replot` module is a (sane) Python plotting module, abstracting on top of Matplotlib. """ +import collections import shutil import matplotlib.pyplot as plt @@ -15,25 +16,6 @@ from replot import exceptions as exc __VERSION__ = "0.0.1" -def mpl_custom_rc_context(): - """ - Overload ``matplotlib.rcParams`` to enable advanced features if \ - available. In particular, use LaTeX if available. - - :returns: A ``matplotlib.rc_context`` object to use in a ``with`` \ - statement. - """ - custom_rc = {} - # Add LaTeX in rc if available - if(shutil.which("latex") is not None and - shutil.which("gs") is not None and - shutil.which("dvipng") is not None): - # LateX dependencies are all available - custom_rc["text.usetex"] = True - custom_rc["text.latex.unicode"] = True - return plt.rc_context(rc=custom_rc) - - class Figure(): """ The main class from :mod:`replot`, representing a figure. Can be used \ @@ -69,7 +51,7 @@ class Figure(): self.palette = palette self.max_colors = max_colors self.legend = legend - self.plots = [] + self.plots = collections.defaultdict(list) # keys are groups def __enter__(self): return self @@ -91,12 +73,13 @@ class Figure(): # Create figure figure, axes = plt.subplots() # Add plots - for plot_ in self.plots: - tmp_plots = axes.plot(*(plot_[0]), **(plot_[1])) - # Do not clip line at the axes boundaries to prevent - # extremas from being cropped. - for tmp_plot in tmp_plots: - tmp_plot.set_clip_on(False) + for group_ in self.plots: + for plot_ in self.plots[group_]: + tmp_plots = axes.plot(*(plot_[0]), **(plot_[1])) + # Do not clip line at the axes boundaries to prevent + # extremas from being cropped. + for tmp_plot in tmp_plots: + tmp_plot.set_clip_on(False) # Set properties axes.set_xlabel(self.xlabel) axes.set_ylabel(self.ylabel) @@ -123,66 +106,49 @@ class Figure(): - Two arguments being a function and an interval represented by \ a tuple of its bounds. - .. note:: ``kwargs`` arguments are directly passed to \ + .. note:: ``kwargs`` arguments are passed to \ ``matplotlib.pyplot.plot``. + .. note:: You can use some :mod:`replot` specific keyword arguments: + + - ``group`` which defines permits to group plots together, in \ + subplots (one unicode character maximum). + >>> with replot.figure() as fig: fig.plot(np.sin, (-1, 1)) >>> with replot.figure() as fig: fig.plot(np.sin, [-1, -0.9, …, 1]) >>> with replot.figure() as fig: fig.plot([1, 2, 3], [4, 5, 6]) >>> with replot.figure() as fig: fig.plot([1, 2, 3], [4, 5, 6], linewidth=2.0) + >>> with replot.figure() as fig: fig.plot([1, 2, 3], + [4, 5, 6], group="a") """ if len(args) == 0: raise exc.InvalidParameterError( "You should pass at least one argument to this function.") + # Extra custom kwargs (the ones from replot but not matplotlib) from + # kwargs + kwargs, custom_kwargs = _handle_custom_plot_arguments(kwargs) + if hasattr(args[0], "__call__"): # We want to plot a function - self._plot_function(args[0], *(args[1:]), **kwargs) + plot_ = _plot_function(args[0], *(args[1:]), **kwargs) else: # Else, it is a point series, and we just have to store it for # later plotting. - self.plots.append((args, kwargs)) + plot_ = (args, kwargs) + + # Add the plot to the correct group + if "group" in custom_kwargs: + self.plots[custom_kwargs["group"]].append(plot_) + else: + self.plots["default"].append(plot_) # Automatically set the legend if label is found # (only do it if legend is not explicitly suppressed) if "label" in kwargs and self.legend is None: self.legend = True - def _plot_function(self, data, *args, **kwargs): - """ - Helper function to handle plotting of unevaluated functions (trying \ - to evaluate it nicely and rendering the plot). - - :param data: The function to plot. - - .. seealso:: The documentation of the ``replot.Figure.plot`` method. - - .. note:: ``args`` is used to handle the interval or point series on \ - which the function should be evaluated. ``kwargs`` are passed \ - directly to ``matplotlib.pyplot.plot`. - """ - if len(args) == 0: - # If no interval specified, raise an issue - raise exc.InvalidParameterError( - "You should pass a plotting interval to the plot command.") - elif isinstance(args[0], tuple): - # Interval specified, use it and adaptive plotting - x_values, y_values = adaptive_sampling.sample_function( - data, - args[0], - tol=1e-3) - elif isinstance(args[0], (list, np.ndarray)): - # List of points specified, use them and compute values of the - # function - x_values = args[0] - y_values = [data(i) for i in x_values] - else: - raise exc.InvalidParameterError( - "Second parameter in plot command should be a tuple " + - "specifying plotting interval.") - self.plots.append(((x_values, y_values) + args[1:], kwargs)) - def _legend(self, axes): """ Helper function to handle ``legend`` attribute. It places the legend \ @@ -250,3 +216,79 @@ def plot(data, **kwargs): else: figure.plot(plot_) figure.show() + + +def mpl_custom_rc_context(): + """ + Overload ``matplotlib.rcParams`` to enable advanced features if \ + available. In particular, use LaTeX if available. + + :returns: A ``matplotlib.rc_context`` object to use in a ``with`` \ + statement. + """ + custom_rc = {} + # Add LaTeX in rc if available + if(shutil.which("latex") is not None and + shutil.which("gs") is not None and + shutil.which("dvipng") is not None): + # LateX dependencies are all available + custom_rc["text.usetex"] = True + custom_rc["text.latex.unicode"] = True + return plt.rc_context(rc=custom_rc) + + +def _handle_custom_plot_arguments(kwargs): + """ + This method handles custom keyword arguments from plot in \ + :mod:`replot` which are not in :mod:`matplotlib` function. + + :param kwargs: A dictionary of keyword arguments to handle. + :return: A tuple of :mod:`matplotlib` compatible keyword arguments \ + and of extra :mod:`replot` keyword arguments, both returned \ + as ``dict``. + """ + custom_kwargs = {} + # Handle "group" argument + if "group" in kwargs: + if len(kwargs["group"]) > 1: + raise exc.InvalidParameterError( + "Group name cannot be longer than one unicode character.") + custom_kwargs["group"] = kwargs["group"] + del kwargs["group"] + return (kwargs, custom_kwargs) + + +def _plot_function(data, *args, **kwargs): + """ + Helper function to handle plotting of unevaluated functions (trying \ + to evaluate it nicely and rendering the plot). + + :param data: The function to plot. + :returns: A tuple of ``(args, kwargs)`` representing the plot. + + .. seealso:: The documentation of the ``replot.Figure.plot`` method. + + .. note:: ``args`` is used to handle the interval or point series on \ + which the function should be evaluated. ``kwargs`` are passed \ + directly to ``matplotlib.pyplot.plot`. + """ + if len(args) == 0: + # If no interval specified, raise an issue + raise exc.InvalidParameterError( + "You should pass a plotting interval to the plot command.") + elif isinstance(args[0], tuple): + # Interval specified, use it and adaptive plotting + x_values, y_values = adaptive_sampling.sample_function( + data, + args[0], + tol=1e-3) + elif isinstance(args[0], (list, np.ndarray)): + # List of points specified, use them and compute values of the + # function + x_values = args[0] + y_values = [data(i) for i in x_values] + else: + raise exc.InvalidParameterError( + "Second parameter in plot command should be a tuple " + + "specifying plotting interval.") + return ((x_values, y_values) + args[1:], kwargs)