{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Assumed knowledge\n", "\n", "This course assumes a certain level of knowledge on the reader and will not be formally taught in class - you will have been taught this at earlier levels in your undergraduate studies but:\n", "- Students forget things\n", "- Repetition helps to reinforce learning\n", "\n", "So a review of what is assumed of your knowledge is suitable at this juncture.\n", "\n", "## Aircraft Anatomy\n", "\n", "The basic parts of a standard fixed-wing aircraft are labelled in {numref}`AircraftComponents`. Flight is controlled through movable parts of the aircraft, and from adjusting the propulsion.\n", "\n", "```{figure} ../Images/AircraftComponents.png\n", "---\n", "height: 300px\n", "name: AircraftComponents\n", "---\n", "Major Aircraft Components\n", "```\n", "\n", "Aircraft have control surfaces in red and high-lift devices in blue in {numref}`ControlSurfaces`. Note that some aircraft have additional flow control devices such as *spoilers* but there are not discussed here.\n", "\n", "```{figure} ../Images/ControlSurfaces.png\n", "---\n", "height: 300px\n", "name: ControlSurfaces\n", "---\n", "Aircraft Control Surfaces and High Lift Devices\n", "```\n", "\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The control surfaces are there to alter the aircraft's attitude (its orientation in 3D space). They are:\n", "\n", "- **Ailerons** - these are outboard on each wing, and operate in *differential mode*, meaning if one goes up, the other goes down. These are effected via a sideways stick/yoke movement. This increases lift on one wing, and decreases it on the other, effecting a *roll rate*, $p$, which changes the roll angle, $\\phi$.\n", "\n", "- The **elevator** is usually situated on the horizontal stabiliser, and both sides move together. This increases/decreases the tail lift, and changes the aircraft pitch attitude, $\\theta$. This is controlled by moving the stick/yoke forward/aft.\n", "\n", "- The **rudder** is on the vertical tail, and is a single control surface. If the rudder moves to the port (left), it creates a sideways aerodynamic force on the tail towards starboard (right), which moves the aircraft nose-port to a *sideslip angle*, $\\beta$. This is controlled using pedals in the cockpit.\n", "\n", "We will look at *trapezoidal wings* for most of this course - see {numref}`TrapezoidalWing`. In general, we usually define wing parameters in terms of **gross wing** - see {numred}`WingAreas`, $S$. We represent the wing with a simple trapezoid:\n", "\n", "```{figure} ../Images/TrapezoidalWing2.png\n", "---\n", "height: 300px\n", "name: TrapezoidalWing\n", "---\n", "Aircraft Trapezoidal Wing\n", "```\n", "\n", "```{figure} ../Images/TrapezoidalWing.png\n", "---\n", "height: 300px\n", "name: WingAreas\n", "---\n", "Aircraft Wing Areas\n", "```\n", "\n", "you will note that the swing, *sweep*, which is a measure of how far back the tip is compared to the root, is measured by the sweep of the quarter-chord line. The *chord* is the length of the wing in the direction of travel (hence vertical in the image). The so-called **root chord** is usually defined on the aircraft centerline, and not at the actual aircraft root. \n", "\n", "(wing-parameters)=\n", "### Wing parameters\n", "We can define a few parameters:\n", "\n", "$$\\begin{aligned}\n", " \\text{Wing taper ratio: } \\lambda &= \\frac{c_t}{c_0}\\\\\n", " \\text{Wing area: } S &= \\frac{c_t + c_0}{2}\\cdot b =\\bar{c}\\cdot b\\\\\n", " \\text{Standard Mean chord: } \\bar{c} &= \\frac{c_t + c_0}{2}=\\frac{S}{b}\\\\\n", " \\text{Aspect Ratio: } \\bar{AR} &= \\frac{b}{\\bar{c}}=\\frac{b^2}{S}\\\\\n", " \\text{Mean aerodynamic chord: } \\bar{\\bar{c}} &= \\frac{1}{S}\\int^{+s}_{-s}c^2\\text{d}y\n", "\\end{aligned}$$" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Aerodynamic, Propulsive, and Inertial Forces\n", "\n", "As will be covered in the Aircraft Performance module, the simplest regime of flight is that of *steady, level flight*. Steady means not accelerating, and level means that there is no variation in altitude - this *does not* mean that the wings are level, so the aircraft may be turning in a *steady turn*.\n", "\n", "Whilst this will be covered in detail later, the basics of this regime *should* be familiar from previous courses.\n", "\n", "Since the aircraft is not accelerating, the forces must be in equilibrium. We summarise our forces on the aircraft as two aerodynamic forces, one propulsive, and one inertial:\n", "\n", "- **Lift** - $L$ - the aerodynamic force normal to the incident flow velocity, acting in a 'lifting' sense.\n", "\n", "- **Drag** - $D$ - the aerodynamic force parallel to the incident flow velocity, opposing motion.\n", "\n", "- **Weight** - $W$ - the inertial force acting downward; $W=m\\,g$ where $g=9.80665\\text{m}\\,\\text{s}^{-2}$, the acceleration due to gravity.\n", "\n", "- **Thrust** - $T$ - the propulsive force parallel to the aircraft longitudinal axis, providing motion.\n", "\n", "\n", "```{figure} ../Images/EqForces.png\n", "---\n", "height: 300px\n", "name: EqForces\n", "---\n", "Equilibrium Forces\n", "```\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Aerodynamic Coefficients\n", "\n", "In general, it's useful to be able to remove units from expressions in engineering for a number of reasons:\n", "\n", "- It enables us to work between unit systems (i.e., between metric and imperial unit systems) without conversion.\n", "\n", "- It enables us to compare aircraft of differing sizes in terms of performance.\n", "\n", "- It enables us to perform scale model work of aircraft and extend the results to full-size.\n", "\n", "Hence, as presented in the preceding section forces $L$ and $D$ represent *dimensional* lift and drag, which we may measure in Newtons, Pounds-Force, Dyne, or Kip. \n", "\n", "```{note}\n", ":class: dropdown\n", "You may not have heard of the last two. Don't worry - we won't be using them.\n", "```\n", "\n", "To remove the dimensions from these forces, we divide by something else with the same dimensions. You should be comfortable with the fact that the lift is proportional to the 'dynamic pressure', $q_\\infty$ \n", "\n", "$$q_\\infty=\\frac{1}{2}\\,\\rho\\, V^2$$ \n", "\n", "where $\\rho$ is the fluid density, and $V$ is the density of the fluid. Dynamic pressure has dimensions of: \n", "\n", "$$\\begin{aligned}\n", " q_\\infty=\\frac{1}{2}\\,\\rho\\, V^2 &: \\frac{\\text{kg}}{{\\text{m}^3}}\\,\\left\\{\\frac{{\\text{m}}}{{{\\text{s}}}}\\right\\}^2\\\\\n", " &: \\frac{\\text{kg}}{{\\text{m}\\text{s}^2}}\\\\\n", " &: \\left[\\frac{\\text{M}}{\\text{L}\\,\\text{T}^2}\\right]\\end{aligned}$$ \n", " \n", "We know that lift and drag may be represented in *Newtons*, which have units of ${\\text{N}}={\\text{kg}\\,\\text{m}\\,\\text{s}^{-2}}$ which has dimensions of\n", "\n", "$$\\begin{aligned}\n", " \\left[\\frac{\\text{M}\\,\\text{L}}{\\text{T}^2}\\right] \\end{aligned}$$\n", " \n", "to get something that has the same dimensions as the aerodynamic forces, we need to multiply the dynamic pressure by *some* area. The area that we choose is the *wing area*, $S$, which we'll define in more detail later. But now we've reached the definition of the three-dimensional lift and drag coefficients:\n", "\n", "$$\\begin{aligned}\n", " C_L = \\frac{L}{\\frac{1}{2}\\,\\rho\\,V^2\\,S}\\\\\n", " C_D = \\frac{D}{\\frac{1}{2}\\,\\rho\\,V^2\\,S} \\end{aligned}$$\n", "\n", "The uppercase $L$ and $D$ in the subscript means that we're looking at the three-dimensional lift and drag coefficients. As aeronautical engineers we often like to look at an infinitesimal slice of a wing, which we call an aerofoil/airfoil. \n", "\n", "```{note}\n", ":class: dropdown\n", "Though I live and work in America, I'm a Brit. Hence the 'u's and 's' in place of 'z's. Aerofoil is British English, Airfoil is US English.\n", "```\n", "\n", "If we wish to have the lift and drag quantified on 2D aerofoil, then we look at the *lift and drag per unit span*, which we denote with a lowercase $l$ and $d$. The corresponding two-dimensional lift and drag coefficients are:\n", "\n", "$$\\begin{aligned}\n", " C_l = \\frac{l}{\\frac{1}{2}\\,\\rho\\,V^2\\,c}\\\\\n", " C_d = \\frac{d}{\\frac{1}{2}\\,\\rho\\,V^2\\,c} \\end{aligned}$$\n", "\n", "where we've now introduced a new parameter, $c$, in place of the wing area. This $c$ represents the *chord* of the aerofoil, which is simply the length from the very front (the leading edge) to the very aft (the trailing edge)." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Aerofoils and Lift\n", "\n", "As discussed above, an aerofoil is an infinitesimal section of a wing, which we can represent in two dimensions (this is helpful, as drawing in 3d is difficult!). The simplest aerofoil is a symmetric one. \n", "\n", "```{note}\n", ":class: dropdown\n", "The simplest aerofoil with thickness - as the simplest 'foil' could be argued to be a flat plate.\n", "```\n", "\n", "The nondimensional longitudinal axis is the $x$ direction, and the distance from the front (leading edge) to the tail (trailing edge) of the airfoil is the *chord* line.\n", "\n", "The simplest 'standard' airfoils are the NACA 4-digit series. Where the four digits are numbers. The format is $MPXX$ where:\n", "\n", "- $M$ is the maximum camber expressed as a percentage of the chord. In the example $M$=2 so the camber is 0.02 or 2% of the chord.\n", "\n", "- $P$ is the position (in the $x$ direction) of the maximum camber expressed in tenths of the chord length. In the example P=4 so the maximum camber is at 0.4 or 40% of the chord.\n", "\n", "- $XX$ is the thickness as a percentage. In the example $XX$=12 so the thickness is 0.12 or 12% of the chord.\n", "\n", "We have already discussed the chord line, and now also the *camber line*. For reasons that you should have discovered in your studies, a *cambered* aerofoil produces more lift and a symmetric one for the same angle of attack (before stall). The camber line is defined as the locus of points midway between the upper and lower surface. For a NACA 4-digit airfoil with nonzero first and second digit, you can immediately observe that the aerofoil will have *camber*. The camber line is the midpoint between the upper and lower surface at all points.\n", "\n", "You should be comfortable with NACA 4 and 5 digit series aerofoils - these are defined by polynominal functions representing the *camber line* and the *thickness distribution*. A code snippet below enables you to plot the NACA 4-digit series. Click the rocket and choose 'launch thebe' or open this page in Binder to change the aerofoil section.\n" ] }, { "cell_type": "code", "execution_count": 7, "metadata": { "tags": [ "hide-cell", "thebe-init" ] }, "outputs": [], "source": [ "import matplotlib.pyplot as plt\n", "import numpy as np\n", "plt.close('all')\n", "\n", "\n", "def naca4(number='0012', n=1000):\n", " \n", " \"\"\"\n", " Plots the aerofoil for the given 4 digit NACA number string\n", " \"\"\"\n", "\n", " m = float(number[0])/100.0\n", " p = float(number[1])/10.0\n", " t = float(number[2:])/100.0\n", "\n", " a0 = +0.2969\n", " a1 = -0.1260\n", " a2 = -0.3516\n", " a3 = +0.2843\n", " a4 = -0.1015\n", "\n", " # Make a vector of the x spacing\n", " x = np.linspace(0, 1, n)\n", "\n", " # Get the thickness distribution\n", " yt = 5 * t * (a0*x**.5 + a1*x + a2*x**2 + a3*x**3 + a4*x**4)\n", " \n", " # Get the camber line\n", " yc = np.zeros(x.shape)\n", " if p > 0:\n", " yc[x <= p] = m / p**2 * (2 * p * x[x <= p] - x[x <= p] **2)\n", " yc[x > p] = m / (1 - p)**2 * ((1 - 2 * p) + 2 * p * x[x > p] - x[x > p]**2)\n", "\n", " # Get the gradient of the lines\n", " dyc_dx = np.zeros(x.shape)\n", " if p > 0:\n", " dyc_dx[x <= p] = 2 * m / p**2 * (p-x[x <= p])\n", " dyc_dx[x > p] = 2 * m / (1-p)**2 * (p-x[x > p])\n", " \n", " theta = np.arctan(dyc_dx)\n", " \n", " # Get the upper and lower surfaces\n", " yu = yc + yt * np.cos(theta)\n", " yl = yc - yt * np.cos(theta)\n", " \n", " xu = x - yt * np.sin(theta)\n", " xl = x + yt * np.sin(theta)\n", " \n", " # Put into Selig format\n", "# Y = np.concatenate((yu[::-1], yl))\n", "# X = np.concatenate((x[::-1], x))\n", " \n", " plt.figure()\n", " plt.plot(xu, yu, label=\"Upper Surface\")\n", " plt.plot(xl, yl, label=\"Lower Surface\")\n", " plt.plot(x, yc, label=\"Camber Line\")\n", " plt.plot([x[0], x[-1]], [yc[0], yc[-1]], '--', label='Chord Line')\n", " plt.legend()\n", " plt.gca().set_aspect('equal')\n", "# plt.gca().axis('off')\n", " plt.title(f\"Normalised aerofoil for NACA {number}\")\n", " plt.gca().legend(bbox_to_anchor=(1.1, 1.05))\n", " return" ] }, { "cell_type": "code", "execution_count": 8, "metadata": {}, "outputs": [ { "data": { "application/javascript": [ "/* Put everything inside the global mpl namespace */\n", "/* global mpl */\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(\n", " '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", "\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 = document.createElement('div');\n", " this.root.setAttribute('style', 'display: inline-block');\n", " this._root_extra_style(this.root);\n", "\n", " parent_element.appendChild(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 = document.createElement('div');\n", " titlebar.classList =\n", " 'ui-dialog-titlebar ui-widget-header ui-corner-all ui-helper-clearfix';\n", " var titletext = document.createElement('div');\n", " titletext.classList = 'ui-dialog-title';\n", " titletext.setAttribute(\n", " 'style',\n", " 'width: 100%; text-align: center; padding: 3px;'\n", " );\n", " titlebar.appendChild(titletext);\n", " this.root.appendChild(titlebar);\n", " this.header = titletext;\n", "};\n", "\n", "mpl.figure.prototype._canvas_extra_style = function (_canvas_div) {};\n", "\n", "mpl.figure.prototype._root_extra_style = function (_canvas_div) {};\n", "\n", "mpl.figure.prototype._init_canvas = function () {\n", " var fig = this;\n", "\n", " var canvas_div = (this.canvas_div = document.createElement('div'));\n", " canvas_div.setAttribute(\n", " 'style',\n", " 'border: 1px solid #ddd;' +\n", " 'box-sizing: content-box;' +\n", " 'clear: both;' +\n", " 'min-height: 1px;' +\n", " 'min-width: 1px;' +\n", " 'outline: 0;' +\n", " 'overflow: hidden;' +\n", " 'position: relative;' +\n", " 'resize: both;'\n", " );\n", "\n", " function on_keyboard_event_closure(name) {\n", " return function (event) {\n", " return fig.key_event(event, name);\n", " };\n", " }\n", "\n", " canvas_div.addEventListener(\n", " 'keydown',\n", " on_keyboard_event_closure('key_press')\n", " );\n", " canvas_div.addEventListener(\n", " 'keyup',\n", " on_keyboard_event_closure('key_release')\n", " );\n", "\n", " this._canvas_extra_style(canvas_div);\n", " this.root.appendChild(canvas_div);\n", "\n", " var canvas = (this.canvas = document.createElement('canvas'));\n", " canvas.classList.add('mpl-canvas');\n", " canvas.setAttribute('style', 'box-sizing: content-box;');\n", "\n", " this.context = canvas.getContext('2d');\n", "\n", " var backingStore =\n", " this.context.backingStorePixelRatio ||\n", " this.context.webkitBackingStorePixelRatio ||\n", " this.context.mozBackingStorePixelRatio ||\n", " this.context.msBackingStorePixelRatio ||\n", " this.context.oBackingStorePixelRatio ||\n", " this.context.backingStorePixelRatio ||\n", " 1;\n", "\n", " mpl.ratio = (window.devicePixelRatio || 1) / backingStore;\n", "\n", " var rubberband_canvas = (this.rubberband_canvas = document.createElement(\n", " 'canvas'\n", " ));\n", " rubberband_canvas.setAttribute(\n", " 'style',\n", " 'box-sizing: content-box; position: absolute; left: 0; top: 0; z-index: 1;'\n", " );\n", "\n", " var resizeObserver = new ResizeObserver(function (entries) {\n", " var nentries = entries.length;\n", " for (var i = 0; i < nentries; i++) {\n", " var entry = entries[i];\n", " var width, height;\n", " if (entry.contentBoxSize) {\n", " if (entry.contentBoxSize instanceof Array) {\n", " // Chrome 84 implements new version of spec.\n", " width = entry.contentBoxSize[0].inlineSize;\n", " height = entry.contentBoxSize[0].blockSize;\n", " } else {\n", " // Firefox implements old version of spec.\n", " width = entry.contentBoxSize.inlineSize;\n", " height = entry.contentBoxSize.blockSize;\n", " }\n", " } else {\n", " // Chrome <84 implements even older version of spec.\n", " width = entry.contentRect.width;\n", " height = entry.contentRect.height;\n", " }\n", "\n", " // Keep the size of the canvas and rubber band canvas in sync with\n", " // the canvas container.\n", " if (entry.devicePixelContentBoxSize) {\n", " // Chrome 84 implements new version of spec.\n", " canvas.setAttribute(\n", " 'width',\n", " entry.devicePixelContentBoxSize[0].inlineSize\n", " );\n", " canvas.setAttribute(\n", " 'height',\n", " entry.devicePixelContentBoxSize[0].blockSize\n", " );\n", " } else {\n", " canvas.setAttribute('width', width * mpl.ratio);\n", " canvas.setAttribute('height', height * mpl.ratio);\n", " }\n", " canvas.setAttribute(\n", " 'style',\n", " 'width: ' + width + 'px; height: ' + height + 'px;'\n", " );\n", "\n", " rubberband_canvas.setAttribute('width', width);\n", " rubberband_canvas.setAttribute('height', height);\n", "\n", " // And update the size in Python. We ignore the initial 0/0 size\n", " // that occurs as the element is placed into the DOM, which should\n", " // otherwise not happen due to the minimum size styling.\n", " if (width != 0 && height != 0) {\n", " fig.request_resize(width, height);\n", " }\n", " }\n", " });\n", " resizeObserver.observe(canvas_div);\n", "\n", " function on_mouse_event_closure(name) {\n", " return function (event) {\n", " return fig.mouse_event(event, name);\n", " };\n", " }\n", "\n", " rubberband_canvas.addEventListener(\n", " 'mousedown',\n", " on_mouse_event_closure('button_press')\n", " );\n", " rubberband_canvas.addEventListener(\n", " 'mouseup',\n", " on_mouse_event_closure('button_release')\n", " );\n", " // Throttle sequential mouse events to 1 every 20ms.\n", " rubberband_canvas.addEventListener(\n", " 'mousemove',\n", " on_mouse_event_closure('motion_notify')\n", " );\n", "\n", " rubberband_canvas.addEventListener(\n", " 'mouseenter',\n", " on_mouse_event_closure('figure_enter')\n", " );\n", " rubberband_canvas.addEventListener(\n", " 'mouseleave',\n", " on_mouse_event_closure('figure_leave')\n", " );\n", "\n", " canvas_div.addEventListener('wheel', function (event) {\n", " if (event.deltaY < 0) {\n", " event.step = 1;\n", " } else {\n", " event.step = -1;\n", " }\n", " on_mouse_event_closure('scroll')(event);\n", " });\n", "\n", " canvas_div.appendChild(canvas);\n", " canvas_div.appendChild(rubberband_canvas);\n", "\n", " this.rubberband_context = rubberband_canvas.getContext('2d');\n", " this.rubberband_context.strokeStyle = '#000000';\n", "\n", " this._resize_canvas = function (width, height, forward) {\n", " if (forward) {\n", " canvas_div.style.width = width + 'px';\n", " canvas_div.style.height = height + 'px';\n", " }\n", " };\n", "\n", " // Disable right mouse context menu.\n", " this.rubberband_canvas.addEventListener('contextmenu', function (_e) {\n", " event.preventDefault();\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 toolbar = document.createElement('div');\n", " toolbar.classList = 'mpl-toolbar';\n", " this.root.appendChild(toolbar);\n", "\n", " function on_click_closure(name) {\n", " return function (_event) {\n", " return fig.toolbar_button_onclick(name);\n", " };\n", " }\n", "\n", " function on_mouseover_closure(tooltip) {\n", " return function (event) {\n", " if (!event.currentTarget.disabled) {\n", " return fig.toolbar_button_onmouseover(tooltip);\n", " }\n", " };\n", " }\n", "\n", " fig.buttons = {};\n", " var buttonGroup = document.createElement('div');\n", " buttonGroup.classList = 'mpl-button-group';\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", " /* Instead of a spacer, we start a new button group. */\n", " if (buttonGroup.hasChildNodes()) {\n", " toolbar.appendChild(buttonGroup);\n", " }\n", " buttonGroup = document.createElement('div');\n", " buttonGroup.classList = 'mpl-button-group';\n", " continue;\n", " }\n", "\n", " var button = (fig.buttons[name] = document.createElement('button'));\n", " button.classList = 'mpl-widget';\n", " button.setAttribute('role', 'button');\n", " button.setAttribute('aria-disabled', 'false');\n", " button.addEventListener('click', on_click_closure(method_name));\n", " button.addEventListener('mouseover', on_mouseover_closure(tooltip));\n", "\n", " var icon_img = document.createElement('img');\n", " icon_img.src = '_images/' + image + '.png';\n", " icon_img.srcset = '_images/' + image + '_large.png 2x';\n", " icon_img.alt = tooltip;\n", " button.appendChild(icon_img);\n", "\n", " buttonGroup.appendChild(button);\n", " }\n", "\n", " if (buttonGroup.hasChildNodes()) {\n", " toolbar.appendChild(buttonGroup);\n", " }\n", "\n", " var fmt_picker = document.createElement('select');\n", " fmt_picker.classList = 'mpl-widget';\n", " toolbar.appendChild(fmt_picker);\n", " this.format_dropdown = fmt_picker;\n", "\n", " for (var ind in mpl.extensions) {\n", " var fmt = mpl.extensions[ind];\n", " var option = document.createElement('option');\n", " option.selected = fmt === mpl.default_extension;\n", " option.innerHTML = fmt;\n", " fmt_picker.appendChild(option);\n", " }\n", "\n", " var status_bar = document.createElement('span');\n", " status_bar.classList = 'mpl-message';\n", " toolbar.appendChild(status_bar);\n", " this.message = status_bar;\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", "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", "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], msg['forward']);\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,\n", " 0,\n", " fig.canvas.width / mpl.ratio,\n", " fig.canvas.height / mpl.ratio\n", " );\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", " 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.handle_history_buttons = function (fig, msg) {\n", " for (var key in msg) {\n", " if (!(key in fig.buttons)) {\n", " continue;\n", " }\n", " fig.buttons[key].disabled = !msg[key];\n", " fig.buttons[key].setAttribute('aria-disabled', !msg[key]);\n", " }\n", "};\n", "\n", "mpl.figure.prototype.handle_navigate_mode = function (fig, msg) {\n", " if (msg['mode'] === 'PAN') {\n", " fig.buttons['Pan'].classList.add('active');\n", " fig.buttons['Zoom'].classList.remove('active');\n", " } else if (msg['mode'] === 'ZOOM') {\n", " fig.buttons['Pan'].classList.remove('active');\n", " fig.buttons['Zoom'].classList.add('active');\n", " } else {\n", " fig.buttons['Pan'].classList.remove('active');\n", " fig.buttons['Zoom'].classList.remove('active');\n", " }\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", "\n", " fig.imageObj.src = (window.URL || window.webkitURL).createObjectURL(\n", " evt.data\n", " );\n", " fig.updated_canvas_event();\n", " fig.waiting = false;\n", " return;\n", " } else if (\n", " typeof evt.data === 'string' &&\n", " evt.data.slice(0, 21) === 'data:image/png;base64'\n", " ) {\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(\n", " \"No handler for the '\" + msg_type + \"' message type: \",\n", " msg\n", " );\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(\n", " \"Exception inside the 'handler_\" + msg_type + \"' callback:\",\n", " e,\n", " e.stack,\n", " msg\n", " );\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", " }\n", " if (e.target) {\n", " targ = e.target;\n", " } else if (e.srcElement) {\n", " targ = e.srcElement;\n", " }\n", " if (targ.nodeType === 3) {\n", " // defeat Safari bug\n", " targ = targ.parentNode;\n", " }\n", "\n", " // pageX,Y are the mouse positions relative to the document\n", " var boundingRect = targ.getBoundingClientRect();\n", " var x = e.pageX - (boundingRect.left + document.body.scrollLeft);\n", " var y = e.pageY - (boundingRect.top + document.body.scrollTop);\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", " }\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", " 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, {\n", " x: x,\n", " y: y,\n", " button: event.button,\n", " step: event.step,\n", " guiEvent: simpleKeys(event),\n", " });\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", " // Prevent repeat events\n", " if (name === 'key_press') {\n", " if (event.which === this._key) {\n", " return;\n", " } else {\n", " this._key = event.which;\n", " }\n", " }\n", " if (name === 'key_release') {\n", " this._key = null;\n", " }\n", "\n", " var value = '';\n", " if (event.ctrlKey && event.which !== 17) {\n", " value += 'ctrl+';\n", " }\n", " if (event.altKey && event.which !== 18) {\n", " value += 'alt+';\n", " }\n", " if (event.shiftKey && event.which !== 16) {\n", " value += 'shift+';\n", " }\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, 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\", \"Left button pans, Right button zooms\\nx/y fixes axis, CTRL fixes aspect\", \"fa fa-arrows icon-move\", \"pan\"], [\"Zoom\", \"Zoom to rectangle\\nx/y fixes axis, CTRL fixes aspect\", \"fa fa-square-o icon-check-empty\", \"zoom\"], [\"\", \"\", \"\", \"\"], [\"Download\", \"Download plot\", \"fa fa-floppy-o icon-save\", \"download\"]];\n", "\n", "mpl.extensions = [\"eps\", \"jpeg\", \"pdf\", \"png\", \"ps\", \"raw\", \"svg\", \"tif\"];\n", "\n", "mpl.default_extension = \"png\";/* global mpl */\n", "\n", "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 = document.getElementById(id);\n", " var ws_proxy = comm_websocket_adapter(comm);\n", "\n", " function ondownload(figure, _format) {\n", " window.open(figure.canvas.toDataURL());\n", " }\n", "\n", " var fig = new mpl.figure(id, ws_proxy, ondownload, element);\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;\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", "\n", "mpl.figure.prototype.handle_close = function (fig, msg) {\n", " var width = fig.canvas.width / mpl.ratio;\n", " fig.root.removeEventListener('remove', this._remove_fig_handler);\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.innerHTML =\n", " '