{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Visualizing Classical Music Influence with `networkx`" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## 0. Introduction" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "I came across this 1927 graphic showing the musical descendants of Czerny:" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![](https://img.apmcdn.org/19bd838d5e9e2d7da767e13e83aa551074e4ed12/uncropped/f62292-20131108-carl-czerny-forefather-pianoforte-technique.jpg)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "What follows is my attempt to create a similar music-ancestry graph directly from data." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## 1. Scraping the data" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Fortunately for us, Wikipedia has an incredible comprehensive series of [lists of music students by teacher](https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_A_to_B) that is perfect for our purposes – each teacher is given a heading and followed by a list of students." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Let's try scraping it." ] }, { "cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [], "source": [ "%matplotlib notebook\n", "import matplotlib.pyplot as plt" ] }, { "cell_type": "code", "execution_count": 2, "metadata": {}, "outputs": [], "source": [ "import codecs\n", "import json\n", "import urllib\n", "\n", "from requests import get\n", "from bs4 import BeautifulSoup\n", "import networkx as nx" ] }, { "cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [], "source": [ "pages = [\n", " 'https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_A_to_B',\n", " 'https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_C_to_F',\n", " 'https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_G_to_J',\n", " 'https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_K_to_M',\n", " 'https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_N_to_Q',\n", " 'https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_R_to_S',\n", " 'https://en.wikipedia.org/wiki/List_of_music_students_by_teacher:_T_to_Z'\n", "]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We'll go through each of the 7 pages and build up an adjacency list of teacher->student edges. \n", "\n", "We'll skip over students or teachers that don't have an associated Wikipedia link to ensure that the people we're getting are all notable enough to have Wikipedia entries." ] }, { "cell_type": "code", "execution_count": 4, "metadata": {}, "outputs": [], "source": [ "adjlist = ''\n", "\n", "for url in pages:\n", " response = get(url)\n", " soup = BeautifulSoup(response.text, 'html.parser')\n", " \n", " for heading in soup.find_all('h3'):\n", " if not heading.find('a'):\n", " continue\n", " url = heading.find('a')['href']\n", " if '/wiki/' not in url:\n", " continue\n", " teacher_name = url.split('/wiki/')[1].split('_(')[0].split('#')[0]\n", "\n", " student_entries = heading.find_next_sibling(\"div\", class_=\"columns\").find_all('li')\n", " student_names = []\n", " for student in student_entries:\n", " if not student.find('a'):\n", " continue\n", "\n", " url = student.find('a')['href']\n", " if '/wiki/' in url:\n", " student_names.append(url.split('/wiki/')[1].split('_(')[0].split('#')[0])\n", "\n", " adjlist += '{} {}\\n'.format(teacher_name, ' '.join(student_names))" ] }, { "cell_type": "code", "execution_count": 5, "metadata": { "scrolled": true }, "outputs": [ { "data": { "text/plain": [ "'Arkady_Abaza Nikolai_Roslavets\\nChristian_Ferdinand_Abel Carl_Friedrich_Abel\\nHermann_Abendroth Allard_de_Ridder Herbert_Eimert G%C3%BCnther_Herbig Wilhelm_Sch%C3%BCchter William_Steinberg\\nDieter_Acker Susanne_Erding-Swiridoff\\nAdolphe_Adam L%C3%A9o_Delibes Ferdinand_Poise Lo%C3%AFsa_Puget\\nLouis_Adam Joseph_Daussoigne-M%C3%A9hul Ferdinand_H%C3%A9rold Friedrich_Kalkbrenner Henry_Lemoine\\nJohn_Luther_Adams Corey_Dargel\\nMurray_Adaskin Andrew_Dawes Boyd_McDonald Paul_Pedersen Rodney_Sharman Timothy_Williams\\nGuido_Adler Karel_Navr%C3%A1til Anton_Webern Egon_Wellesz\\nOskar_Adler Hans_Keller J%C3%B3zef_Koffler Dragan_Plamenac Arnold_Schoenberg\\nSamuel_Adler Martin_Amlin Claude_Baker Roger_Briggs Jason_Robert_Brown David_Crumb Greg_Danner Eric_Ewazen Peng-Peng_Gong Jay_Greenberg Anthony_Iannaccone Kamran_Ince Michael_Isaacson Scott_Lindroth Marc_Mellits Carter_Pann Robert_Paterson Paul_Phillips Paul_Reller Michael_Alec_Rose Daria_Semegen Gordon_Stout Christopher_Theofanidis Michael_Sidney_Timpson Fi'" ] }, "execution_count": 5, "metadata": {}, "output_type": "execute_result" } ], "source": [ "adjlist[:1000]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The names are URL-encoded because we took them from the link `href`s, so let's decode as UTF-8." ] }, { "cell_type": "code", "execution_count": 6, "metadata": {}, "outputs": [], "source": [ "adjlist = urllib.unquote(adjlist).decode('utf-8')" ] }, { "cell_type": "code", "execution_count": 7, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Arkady_Abaza Nikolai_Roslavets\n", "Christian_Ferdinand_Abel Carl_Friedrich_Abel\n", "Hermann_Abendroth Allard_de_Ridder Herbert_Eimert Günther_Herbig Wilhelm_Schüchter William_Steinberg\n", "Dieter_Acker Susanne_Erding-Swiridoff\n", "Adolphe_Adam Léo_Delibes Ferdinand_Poise Loïsa_Puget\n", "Louis_Adam Joseph_Daussoigne-Méhul Ferdinand_Hérold Friedrich_Kalkbrenner Henry_Lemoine\n", "John_Luther_Adams Corey_Dargel\n", "Murray_Adaskin Andrew_Dawes Boyd_McDonald Paul_Pedersen Rodney_Sharman Timothy_Williams\n", "Guido_Adler Karel_Navrátil Anton_Webern Egon_Wellesz\n", "Oskar_Adler Hans_Keller Józef_Koffler Dragan_Plamenac Arnold_Schoenberg\n", "Samuel_Adler Martin_Amlin Claude_Baker Roger_Briggs Jason_Robert_Brown David_Crumb Greg_Danner Eric_Ewazen Peng-Peng_Gong Jay_Greenberg Anthony_Iannaccone Kamran_Ince Michael_Isaacson Scott_Lindroth Marc_Mellits Carter_Pann Robert_Paterson Paul_Phillips Paul_Reller Michael_Alec_Rose Daria_Semegen Gordon_Stout Christopher_Theofanidis Michael_Sidney_Timpson Fisher_Tull Dan_Welcher Michael_Glenn_Will\n" ] } ], "source": [ "print adjlist[:1000]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Let's write this adjacency list to a file, and load it into `networkx`." ] }, { "cell_type": "code", "execution_count": 8, "metadata": { "scrolled": false }, "outputs": [], "source": [ "with codecs.open(\"adjlist.txt\", \"w\", \"utf-8\") as temp:\n", " temp.write(adjlist)" ] }, { "cell_type": "code", "execution_count": 9, "metadata": {}, "outputs": [], "source": [ "G = nx.read_adjlist('adjlist.txt', create_using=nx.DiGraph())" ] }, { "cell_type": "code", "execution_count": 10, "metadata": {}, "outputs": [ { "data": { "text/plain": [ "4926" ] }, "execution_count": 10, "metadata": {}, "output_type": "execute_result" } ], "source": [ "G.number_of_nodes()" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Let's also export our graph to a JSON format that [Cytoscape.js](http://js.cytoscape.org/) can understand. This might be useful later on if we want to make a JavaScript visualization of the data." ] }, { "cell_type": "code", "execution_count": 11, "metadata": {}, "outputs": [], "source": [ "def pretty_node(node):\n", " \"\"\"Given a node name, format it for display purposes - e.g. 'Carl_Friedrich_Abel' => 'C. Abel'.\"\"\"\n", " return u'{}. {}'.format(node[0], node.split('_I')[0].split('_')[-1])" ] }, { "cell_type": "code", "execution_count": 12, "metadata": {}, "outputs": [], "source": [ "def export_to_cytoscape_json(graph, filename, weight_fn=None):\n", " def exported_node(node, weight_fn=None):\n", " return {\n", " 'data': {\n", " 'id': unicode(pretty_node(node)),\n", " 'fullName': unicode(node.replace('_', ' ')),\n", " 'weight': weight_fn(node) if weight_fn else 1\n", " }\n", " }\n", " \n", " # Topologically sort the nodes if possible (i.e. the graph is acyclic)\n", " try:\n", " nodes = [exported_node(i, weight_fn) for i in nx.topological_sort(graph)]\n", " except:\n", " nodes = [exported_node(i, weight_fn) for i in graph.nodes()]\n", " links = [{'data': {'source': pretty_node(u[0]), 'target': pretty_node(u[1])}} for u in graph.edges()]\n", " with codecs.open(filename, \"w\", \"utf-8\") as file:\n", " json.dump(nodes + links, file, indent=2)" ] }, { "cell_type": "code", "execution_count": 13, "metadata": {}, "outputs": [], "source": [ "export_to_cytoscape_json(G, 'cytoscape.json')" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## 2. Who are the most influential teachers?" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Now that we have our graph, let's analyze it!" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "For starters, let's see if we can figure out who the most influential teacher is." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "But how do we quantify \"influence\"? One natural metric to use is [Katz centrality](https://en.wikipedia.org/wiki/Katz_centrality), which works similarly to Google's PageRank – nodes that are connected to influential nodes themselves gain influence, and so on.\n", "\n", "Katz centrality is a directional measure, and it turns out we need to compute it over the reversed graph to find the most influential teachers – otherwise we just end up getting the most \"influential students\"." ] }, { "cell_type": "code", "execution_count": 14, "metadata": { "scrolled": true }, "outputs": [], "source": [ "c = nx.katz_centrality(G.reverse())" ] }, { "cell_type": "code", "execution_count": 16, "metadata": { "scrolled": true }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Nadia_Boulanger 0.274464766203\n", "Darius_Milhaud 0.133984907008\n", "Karlheinz_Stockhausen 0.112095058281\n", "Olivier_Messiaen 0.108104999101\n", "Roger_Sessions 0.0924535118831\n", "André_Gedalge 0.0821795297328\n", "Vincent_d'Indy 0.0676563365134\n", "Arnold_Schoenberg 0.067113904931\n", "Paul_Hindemith 0.0660738864042\n", "Charles-Marie_Widor 0.0585465871662\n", "Gabriel_Fauré 0.0567998995\n", "Franz_Liszt 0.0564699447567\n", "Aaron_Copland 0.0560713201348\n", "Antoine_François_Marmontel 0.0542184811049\n", "Louis_Vierne 0.0539401495126\n", "Louis_Andriessen 0.0533430371564\n", "Charles_Villiers_Stanford 0.0533227668023\n", "Milton_Babbitt 0.0531766068805\n", "Ferruccio_Busoni 0.0523346432626\n", "Salomon_Jadassohn 0.0500280441408\n" ] } ], "source": [ "for teacher in sorted(c, key=c.get)[::-1][:20]:\n", " print teacher, c[teacher]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "There's a lot of famous names there, but in the end, it's not even close. [Nadia Boulanger](https://en.wikipedia.org/wiki/Nadia_Boulanger) has more than double the centrality of anybody else. Given that Boulanger taught everyone from Copland to Piazzolla to Quincy Jones, her rank is well-deserved." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "And let's make a subgraph of just the 100 most-influential teachers – it'll be easier to work with than the whole graph of ~5,000 people." ] }, { "cell_type": "code", "execution_count": 17, "metadata": {}, "outputs": [], "source": [ "most_important_teachers = sorted(c, key=c.get)[::-1][:100]" ] }, { "cell_type": "code", "execution_count": 18, "metadata": {}, "outputs": [], "source": [ "important_teachers_graph = nx.subgraph(G, most_important_teachers)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## 3. Let's visualize it!" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "I stole [some code from StackOverflow](https://stackoverflow.com/questions/29586520/can-one-get-hierarchical-graphs-from-networkx-with-python-3/29597209) to visualize hierarchical graphs in a pretty way:" ] }, { "cell_type": "code", "execution_count": 19, "metadata": {}, "outputs": [], "source": [ "# https://stackoverflow.com/questions/29586520/can-one-get-hierarchical-graphs-from-networkx-with-python-3/29597209\n", "def hierarchy_pos(G, root, levels=None, width=1., height=1.):\n", " '''If there is a cycle that is reachable from root, then this will see infinite recursion.\n", " G: the graph\n", " root: the root node\n", " levels: a dictionary\n", " key: level number (starting from 0)\n", " value: number of nodes in this level\n", " width: horizontal space allocated for drawing\n", " height: vertical space allocated for drawing'''\n", " TOTAL = \"total\"\n", " CURRENT = \"current\"\n", " def make_levels(levels, node=root, currentLevel=0, parent=None):\n", " \"\"\"Compute the number of nodes for each level\n", " \"\"\"\n", " if not currentLevel in levels:\n", " levels[currentLevel] = {TOTAL : 0, CURRENT : 0}\n", " levels[currentLevel][TOTAL] += 1\n", " try:\n", " neighbors = G.neighbors(node)\n", " for neighbor in neighbors:\n", " if not neighbor == parent:\n", " levels = make_levels(levels, neighbor, currentLevel + 1, node)\n", " except:\n", " pass\n", " return levels\n", "\n", " def make_pos(pos, node=root, currentLevel=0, parent=None, vert_loc=0):\n", " dx = 1.0/levels[currentLevel][TOTAL]\n", " left = dx/2\n", " pos[node] = ((left + dx*levels[currentLevel][CURRENT])*width, vert_loc)\n", " levels[currentLevel][CURRENT] += 1\n", " try:\n", " neighbors = G.neighbors(node)\n", " for neighbor in neighbors:\n", " if not neighbor == parent:\n", " pos = make_pos(pos, neighbor, currentLevel + 1, node, vert_loc-vert_gap)\n", " except:\n", " pass\n", " return pos\n", " \n", " if levels is None:\n", " levels = make_levels({})\n", " else:\n", " levels = {l:{TOTAL: levels[l], CURRENT:0} for l in levels}\n", " vert_gap = height / (max([l for l in levels])+1)\n", " return make_pos({})" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "And wrapped some helpful logic around it:" ] }, { "cell_type": "code", "execution_count": 20, "metadata": {}, "outputs": [], "source": [ "def draw_hierarchical_graph(graph, root=None):\n", " plt.figure(figsize=(10, 10))\n", "\n", " root = root or nx.topological_sort(graph).next()\n", " pos = hierarchy_pos(graph, root)\n", " reduced_graph = nx.subgraph(graph, pos.keys())\n", " \n", " relabeled_graph = nx.relabel_nodes(reduced_graph, pretty_node)\n", " relabeled_pos = {pretty_node(node): p for node, p in pos.items()}\n", " nx.draw(relabeled_graph, pos=relabeled_pos, with_labels=True, node_size=500, node_color='w', font_size=9, arrowsize=8)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Ok, let's try it! Note that if we don't provide a root node, the graph will be drawn from the first node in topological order (in other words, any node that doesn't have any parents):" ] }, { "cell_type": "code", "execution_count": 21, "metadata": { "scrolled": false }, "outputs": [ { "data": { "application/javascript": [ "/* Put everything inside the global mpl namespace */\n", "window.mpl = {};\n", "\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", " if (mpl.ratio != 1) {\n", " fig.send_message(\"set_dpi_ratio\", {'dpi_ratio': mpl.ratio});\n", " }\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", " fig.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 backingStore = this.context.backingStorePixelRatio ||\n", "\tthis.context.webkitBackingStorePixelRatio ||\n", "\tthis.context.mozBackingStorePixelRatio ||\n", "\tthis.context.msBackingStorePixelRatio ||\n", "\tthis.context.oBackingStorePixelRatio ||\n", "\tthis.context.backingStorePixelRatio || 1;\n", "\n", " mpl.ratio = (window.devicePixelRatio || 1) / backingStore;\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 * mpl.ratio);\n", " canvas.attr('height', height * mpl.ratio);\n", " canvas.attr('style', 'width: ' + width + 'px; height: ' + height + 'px;');\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.addClass('ui-button ui-widget ui-state-default ui-corner-all ' +\n", " 'ui-button-icon-only');\n", " button.attr('role', 'button');\n", " button.attr('aria-disabled', 'false');\n", " button.click(method_name, toolbar_event);\n", " button.mouseover(tooltip, toolbar_mouse_event);\n", "\n", " var icon_img = $('');\n", " icon_img.addClass('ui-button-icon-primary ui-icon');\n", " icon_img.addClass(image);\n", " icon_img.addClass('ui-corner-all');\n", "\n", " var tooltip_span = $('');\n", " tooltip_span.addClass('ui-button-text');\n", " tooltip_span.html(tooltip);\n", "\n", " button.append(icon_img);\n", " button.append(tooltip_span);\n", "\n", " nav_element.append(button);\n", " }\n", "\n", " var fmt_picker_span = $('');\n", "\n", " var fmt_picker = $('');\n", " fmt_picker.addClass('mpl-toolbar-option ui-widget ui-widget-content');\n", " fmt_picker_span.append(fmt_picker);\n", " nav_element.append(fmt_picker_span);\n", " this.format_dropdown = fmt_picker[0];\n", "\n", " for (var ind in mpl.extensions) {\n", " var fmt = mpl.extensions[ind];\n", " var option = $(\n", " '', {selected: fmt === mpl.default_extension}).html(fmt);\n", " fmt_picker.append(option)\n", " }\n", "\n", " // Add hover states to the ui-buttons\n", " $( \".ui-button\" ).hover(\n", " function() { $(this).addClass(\"ui-state-hover\");},\n", " function() { $(this).removeClass(\"ui-state-hover\");}\n", " );\n", "\n", " var status_bar = $('');\n", " nav_element.append(status_bar);\n", " this.message = status_bar[0];\n", "}\n", "\n", "mpl.figure.prototype.request_resize = function(x_pixels, y_pixels) {\n", " // Request matplotlib to resize the figure. Matplotlib will then trigger a resize in the client,\n", " // which will in turn request a refresh of the image.\n", " this.send_message('resize', {'width': x_pixels, 'height': y_pixels});\n", "}\n", "\n", "mpl.figure.prototype.send_message = function(type, properties) {\n", " properties['type'] = type;\n", " properties['figure_id'] = this.id;\n", " this.ws.send(JSON.stringify(properties));\n", "}\n", "\n", "mpl.figure.prototype.send_draw_message = function() {\n", " if (!this.waiting) {\n", " this.waiting = true;\n", " this.ws.send(JSON.stringify({type: \"draw\", figure_id: this.id}));\n", " }\n", "}\n", "\n", "\n", "mpl.figure.prototype.handle_save = function(fig, msg) {\n", " var format_dropdown = fig.format_dropdown;\n", " var format = format_dropdown.options[format_dropdown.selectedIndex].value;\n", " fig.ondownload(fig, format);\n", "}\n", "\n", "\n", "mpl.figure.prototype.handle_resize = function(fig, msg) {\n", " var size = msg['size'];\n", " if (size[0] != fig.canvas.width || size[1] != fig.canvas.height) {\n", " fig._resize_canvas(size[0], size[1]);\n", " fig.send_message(\"refresh\", {});\n", " };\n", "}\n", "\n", "mpl.figure.prototype.handle_rubberband = function(fig, msg) {\n", " var x0 = msg['x0'] / mpl.ratio;\n", " var y0 = (fig.canvas.height - msg['y0']) / mpl.ratio;\n", " var x1 = msg['x1'] / mpl.ratio;\n", " var y1 = (fig.canvas.height - msg['y1']) / mpl.ratio;\n", " x0 = Math.floor(x0) + 0.5;\n", " y0 = Math.floor(y0) + 0.5;\n", " x1 = Math.floor(x1) + 0.5;\n", " y1 = Math.floor(y1) + 0.5;\n", " var min_x = Math.min(x0, x1);\n", " var min_y = Math.min(y0, y1);\n", " var width = Math.abs(x1 - x0);\n", " var height = Math.abs(y1 - y0);\n", "\n", " fig.rubberband_context.clearRect(\n", " 0, 0, fig.canvas.width, fig.canvas.height);\n", "\n", " fig.rubberband_context.strokeRect(min_x, min_y, width, height);\n", "}\n", "\n", "mpl.figure.prototype.handle_figure_label = function(fig, msg) {\n", " // Updates the figure title.\n", " fig.header.textContent = msg['label'];\n", "}\n", "\n", "mpl.figure.prototype.handle_cursor = function(fig, msg) {\n", " var cursor = msg['cursor'];\n", " switch(cursor)\n", " {\n", " case 0:\n", " cursor = 'pointer';\n", " break;\n", " case 1:\n", " cursor = 'default';\n", " break;\n", " case 2:\n", " cursor = 'crosshair';\n", " break;\n", " case 3:\n", " cursor = 'move';\n", " break;\n", " }\n", " fig.rubberband_canvas.style.cursor = cursor;\n", "}\n", "\n", "mpl.figure.prototype.handle_message = function(fig, msg) {\n", " fig.message.textContent = msg['message'];\n", "}\n", "\n", "mpl.figure.prototype.handle_draw = function(fig, msg) {\n", " // Request the server to send over a new figure.\n", " fig.send_draw_message();\n", "}\n", "\n", "mpl.figure.prototype.handle_image_mode = function(fig, msg) {\n", " fig.image_mode = msg['mode'];\n", "}\n", "\n", "mpl.figure.prototype.updated_canvas_event = function() {\n", " // Called whenever the canvas gets updated.\n", " this.send_message(\"ack\", {});\n", "}\n", "\n", "// A function to construct a web socket function for onmessage handling.\n", "// Called in the figure constructor.\n", "mpl.figure.prototype._make_on_message_function = function(fig) {\n", " return function socket_on_message(evt) {\n", " if (evt.data instanceof Blob) {\n", " /* FIXME: We get \"Resource interpreted as Image but\n", " * transferred with MIME type text/plain:\" errors on\n", " * Chrome. But how to set the MIME type? It doesn't seem\n", " * to be part of the websocket stream */\n", " evt.data.type = \"image/png\";\n", "\n", " /* Free the memory for the previous frames */\n", " if (fig.imageObj.src) {\n", " (window.URL || window.webkitURL).revokeObjectURL(\n", " fig.imageObj.src);\n", " }\n", "\n", " fig.imageObj.src = (window.URL || window.webkitURL).createObjectURL(\n", " evt.data);\n", " fig.updated_canvas_event();\n", " fig.waiting = false;\n", " return;\n", " }\n", " else if (typeof evt.data === 'string' && evt.data.slice(0, 21) == \"data:image/png;base64\") {\n", " fig.imageObj.src = evt.data;\n", " fig.updated_canvas_event();\n", " fig.waiting = false;\n", " return;\n", " }\n", "\n", " var msg = JSON.parse(evt.data);\n", " var msg_type = msg['type'];\n", "\n", " // Call the \"handle_{type}\" callback, which takes\n", " // the figure and JSON message as its only arguments.\n", " try {\n", " var callback = fig[\"handle_\" + msg_type];\n", " } catch (e) {\n", " console.log(\"No handler for the '\" + msg_type + \"' message type: \", msg);\n", " return;\n", " }\n", "\n", " if (callback) {\n", " try {\n", " // console.log(\"Handling '\" + msg_type + \"' message: \", msg);\n", " callback(fig, msg);\n", " } catch (e) {\n", " console.log(\"Exception inside the 'handler_\" + msg_type + \"' callback:\", e, e.stack, msg);\n", " }\n", " }\n", " };\n", "}\n", "\n", "// from http://stackoverflow.com/questions/1114465/getting-mouse-location-in-canvas\n", "mpl.findpos = function(e) {\n", " //this section is from http://www.quirksmode.org/js/events_properties.html\n", " var targ;\n", " if (!e)\n", " e = window.event;\n", " if (e.target)\n", " targ = e.target;\n", " else if (e.srcElement)\n", " targ = e.srcElement;\n", " if (targ.nodeType == 3) // defeat Safari bug\n", " targ = targ.parentNode;\n", "\n", " // jQuery normalizes the pageX and pageY\n", " // pageX,Y are the mouse positions relative to the document\n", " // offset() returns the position of the element relative to the document\n", " var x = e.pageX - $(targ).offset().left;\n", " var y = e.pageY - $(targ).offset().top;\n", "\n", " return {\"x\": x, \"y\": y};\n", "};\n", "\n", "/*\n", " * return a copy of an object with only non-object keys\n", " * we need this to avoid circular references\n", " * http://stackoverflow.com/a/24161582/3208463\n", " */\n", "function simpleKeys (original) {\n", " return Object.keys(original).reduce(function (obj, key) {\n", " if (typeof original[key] !== 'object')\n", " obj[key] = original[key]\n", " return obj;\n", " }, {});\n", "}\n", "\n", "mpl.figure.prototype.mouse_event = function(event, name) {\n", " var canvas_pos = mpl.findpos(event)\n", "\n", " if (name === 'button_press')\n", " {\n", " this.canvas.focus();\n", " this.canvas_div.focus();\n", " }\n", "\n", " var x = canvas_pos.x * mpl.ratio;\n", " var y = canvas_pos.y * mpl.ratio;\n", "\n", " this.send_message(name, {x: x, y: y, button: event.button,\n", " step: event.step,\n", " guiEvent: simpleKeys(event)});\n", "\n", " /* This prevents the web browser from automatically changing to\n", " * the text insertion cursor when the button is pressed. We want\n", " * to control all of the cursor setting manually through the\n", " * 'cursor' event from matplotlib */\n", " event.preventDefault();\n", " return false;\n", "}\n", "\n", "mpl.figure.prototype._key_event_extra = function(event, name) {\n", " // Handle any extra behaviour associated with a key event\n", "}\n", "\n", "mpl.figure.prototype.key_event = function(event, name) {\n", "\n", " // Prevent repeat events\n", " if (name == 'key_press')\n", " {\n", " if (event.which === this._key)\n", " return;\n", " else\n", " this._key = event.which;\n", " }\n", " if (name == 'key_release')\n", " this._key = null;\n", "\n", " var value = '';\n", " if (event.ctrlKey && event.which != 17)\n", " value += \"ctrl+\";\n", " if (event.altKey && event.which != 18)\n", " value += \"alt+\";\n", " if (event.shiftKey && event.which != 16)\n", " value += \"shift+\";\n", "\n", " value += 'k';\n", " value += event.which.toString();\n", "\n", " this._key_event_extra(event, name);\n", "\n", " this.send_message(name, {key: value,\n", " guiEvent: simpleKeys(event)});\n", " return false;\n", "}\n", "\n", "mpl.figure.prototype.toolbar_button_onclick = function(name) {\n", " if (name == 'download') {\n", " this.handle_save(this, null);\n", " } else {\n", " this.send_message(\"toolbar_button\", {name: name});\n", " }\n", "};\n", "\n", "mpl.figure.prototype.toolbar_button_onmouseover = function(tooltip) {\n", " this.message.textContent = tooltip;\n", "};\n", "mpl.toolbar_items = [[\"Home\", \"Reset original view\", \"fa fa-home icon-home\", \"home\"], [\"Back\", \"Back to previous view\", \"fa fa-arrow-left icon-arrow-left\", \"back\"], [\"Forward\", \"Forward to next view\", \"fa fa-arrow-right icon-arrow-right\", \"forward\"], [\"\", \"\", \"\", \"\"], [\"Pan\", \"Pan axes with left mouse, zoom with right\", \"fa fa-arrows icon-move\", \"pan\"], [\"Zoom\", \"Zoom to rectangle\", \"fa fa-square-o icon-check-empty\", \"zoom\"], [\"\", \"\", \"\", \"\"], [\"Download\", \"Download plot\", \"fa fa-floppy-o icon-save\", \"download\"]];\n", "\n", "mpl.extensions = [\"eps\", \"pdf\", \"png\", \"ps\", \"raw\", \"svg\"];\n", "\n", "mpl.default_extension = \"png\";var comm_websocket_adapter = function(comm) {\n", " // Create a \"websocket\"-like object which calls the given IPython comm\n", " // object with the appropriate methods. Currently this is a non binary\n", " // socket, so there is still some room for performance tuning.\n", " var ws = {};\n", "\n", " ws.close = function() {\n", " comm.close()\n", " };\n", " ws.send = function(m) {\n", " //console.log('sending', m);\n", " comm.send(m);\n", " };\n", " // Register the callback with on_msg.\n", " comm.on_msg(function(msg) {\n", " //console.log('receiving', msg['content']['data'], msg);\n", " // Pass the mpl event to the overridden (by mpl) onmessage function.\n", " ws.onmessage(msg['content']['data'])\n", " });\n", " return ws;\n", "}\n", "\n", "mpl.mpl_figure_comm = function(comm, msg) {\n", " // This is the function which gets called when the mpl process\n", " // starts-up an IPython Comm through the \"matplotlib\" channel.\n", "\n", " var id = msg.content.data.id;\n", " // Get hold of the div created by the display call when the Comm\n", " // socket was opened in Python.\n", " var element = $(\"#\" + id);\n", " var ws_proxy = comm_websocket_adapter(comm)\n", "\n", " function ondownload(figure, format) {\n", " window.open(figure.imageObj.src);\n", " }\n", "\n", " var fig = new mpl.figure(id, ws_proxy,\n", " ondownload,\n", " element.get(0));\n", "\n", " // Call onopen now - mpl needs it, as it is assuming we've passed it a real\n", " // web socket which is closed, not our websocket->open comm proxy.\n", " ws_proxy.onopen();\n", "\n", " fig.parent_element = element.get(0);\n", " fig.cell_info = mpl.find_output_cell(\"\");\n", " if (!fig.cell_info) {\n", " console.error(\"Failed to find cell for figure\", id, fig);\n", " return;\n", " }\n", "\n", " var output_index = fig.cell_info[2]\n", " var cell = fig.cell_info[0];\n", "\n", "};\n", "\n", "mpl.figure.prototype.handle_close = function(fig, msg) {\n", " var width = fig.canvas.width/mpl.ratio\n", " fig.root.unbind('remove')\n", "\n", " // Update the output cell to use the data from the current canvas.\n", " fig.push_to_output();\n", " var dataURL = fig.canvas.toDataURL();\n", " // Re-enable the keyboard manager in IPython - without this line, in FF,\n", " // the notebook keyboard shortcuts fail.\n", " IPython.keyboard_manager.enable()\n", " $(fig.parent_element).html('');\n", " fig.close_ws(fig, msg);\n", "}\n", "\n", "mpl.figure.prototype.close_ws = function(fig, msg){\n", " fig.send_message('closing', msg);\n", " // fig.ws.close()\n", "}\n", "\n", "mpl.figure.prototype.push_to_output = function(remove_interactive) {\n", " // Turn the data on the canvas into data in the output cell.\n", " var width = this.canvas.width/mpl.ratio\n", " var dataURL = this.canvas.toDataURL();\n", " this.cell_info[1]['text/html'] = '';\n", "}\n", "\n", "mpl.figure.prototype.updated_canvas_event = function() {\n", " // Tell IPython that the notebook contents must change.\n", " IPython.notebook.set_dirty(true);\n", " this.send_message(\"ack\", {});\n", " var fig = this;\n", " // Wait a second, then push the new image to the DOM so\n", " // that it is saved nicely (might be nice to debounce this).\n", " setTimeout(function () { fig.push_to_output() }, 1000);\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) { 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