{ "cells": [ { "cell_type": "markdown", "metadata": { "nbpages": { "level": 0, "link": "[](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html)", "section": "" } }, "source": [ "\n", "*This notebook contains material from [CBE32338](https://jckantor.github.io/CBE32338);\n", "content is available [on Github](https://github.com/jckantor/CBE32338.git).*\n" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 0, "link": "[](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html)", "section": "" } }, "source": [ "\n", "< [1.1 The Temperature Control Laboratory](https://jckantor.github.io/CBE32338/01.01-TCLab.html) | [Contents](toc.html) | [1.11 TCLab Lab 1: Coding a relay controller](https://jckantor.github.io/CBE32338/01.11-TCLab-Lab-1-Coding-a-relay-controller.html) >

\"Open

\"Download\"" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 1, "link": "[1.2 The TCLab Python Package](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2-The-TCLab-Python-Package)", "section": "1.2 The TCLab Python Package" }, "slideshow": { "slide_type": "slide" } }, "source": [ "# 1.2 The TCLab Python Package\n", "The accompanying diagram shows how to access the temperature contol laboratory using the TCLab library.\n", "\n", "\n", "\n", "**_Jupyter notebooks and Python scripts:_**\n", "The highest level consists of the you code you write to implement control algorithms. This can be done in Jupyter/Python notebooks, directly from Python using a development environment such as Spyder or PyCharm. This repository contains several examples, lessons, and student projects.\n", "\n", "**_TCLab:_**\n", "[TCLab](https://github.com/jckantor/TCLab) consists of a Python library entitled `tclab` that provides high-level access to sensors, heaters, a pseudo-realtime clock. The package includes `TCLab()` class that creates an object to access to the device, an iterator `clock` for synchronizing with a real time clock, `Historian()` class to create objects for data logging, and a `Plotter()` class to visualize data in realtime.\n", "\n", "**_TCLab-sketch:_**\n", "The [TCLab-sketch](https://github.com/jckantor/TCLab-sketch) github repository provides firmware to ensure intrisically safe operation of the Arduino board and shield. The sketch is downloaded to the Arduino using the [Arduino IDE](https://www.arduino.cc/en/Main/Software). Loading firmware to the Arduino is a one-time operation. \n", "\n", "**_Arduino:_**\n", "The hardware platform for the Temperature Control Laboratory. The Python tools and libraries have been tested with the Arduino Uno and Arduino Leonardo boards." ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.1 Connecting to the Temperature Control Laboratory](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.1-Connecting-to-the-Temperature-Control-Laboratory)", "section": "1.2.1 Connecting to the Temperature Control Laboratory" }, "slideshow": { "slide_type": "skip" } }, "source": [ "## 1.2.1 Connecting to the Temperature Control Laboratory" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 3, "link": "[1.2.1.1 Installation](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.1.1-Installation)", "section": "1.2.1.1 Installation" }, "slideshow": { "slide_type": "skip" } }, "source": [ "### 1.2.1.1 Installation\n", "\n", "The TCLab package is installed from a terminal window (MacOS) or command window (PC) with the command\n", "\n", " pip install tclab\n", "\n", "Alternatively, the installation can be performed from within a Jupyter/Python notebook with the command\n", "\n", " !pip install tclab\n", "\n", "There are occasional updates to the library. These can be installed by appending a ` --upgrade` to the above commands and demonstrated in the next cell." ] }, { "cell_type": "code", "execution_count": 1, "metadata": { "nbpages": { "level": 3, "link": "[1.2.1.1 Installation](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.1.1-Installation)", "section": "1.2.1.1 Installation" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Requirement already up-to-date: tclab in /Users/jeff/opt/anaconda3/lib/python3.7/site-packages (0.4.9)\r\n", "Requirement already satisfied, skipping upgrade: pyserial in /Users/jeff/opt/anaconda3/lib/python3.7/site-packages (from tclab) (3.4)\r\n" ] } ], "source": [ "!pip install tclab --upgrade" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 3, "link": "[1.2.1.2 Importing](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.1.2-Importing)", "section": "1.2.1.2 Importing" }, "slideshow": { "slide_type": "skip" } }, "source": [ "### 1.2.1.2 Importing\n", " \n", "Once installed, the `tclab` package can be imported into Python and an instance created with the Python statements\n", "\n", " from tclab import TCLab\n", " lab = TCLab()\n", "\n", "TCLab() attempts to find a device connected to a serial port and return a connection. An error is generated if no device is found. The connection should be closed when no longer in use.\n", "\n", "The following cell demonstrates this process, and uses the tclab `LED()` function to flash the LED on the Temperature Control Lab for a period of 10 seconds at a 100% brightness level. " ] }, { "cell_type": "code", "execution_count": 4, "metadata": { "nbpages": { "level": 3, "link": "[1.2.1.2 Importing](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.1.2-Importing)", "section": "1.2.1.2 Importing" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.9\n", "Arduino Leonardo connected on port /dev/cu.usbmodem142101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n", "TCLab disconnected successfully.\n" ] } ], "source": [ "from tclab import TCLab\n", "\n", "lab = TCLab()\n", "lab.LED(100)\n", "lab.close()" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 3, "link": "[1.2.1.3 Using TCLab with Python's `with` statement](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.1.3-Using-TCLab-with-Python's-`with`-statement)", "section": "1.2.1.3 Using TCLab with Python's `with` statement" } }, "source": [ "### 1.2.1.3 Using TCLab with Python's `with` statement\n", "\n", "The Python `with` statement provides a convenient means of setting up and closing a connection to the Temperature Control Laboratory. In particular, the with statement establishes a context where a tclab instance is created, assigned to a variable, and automatically closed upon completion. The `with` statement is the preferred way to connect the Temperature Control Laboratory for most uses." ] }, { "cell_type": "code", "execution_count": 5, "metadata": { "nbpages": { "level": 3, "link": "[1.2.1.3 Using TCLab with Python's `with` statement](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.1.3-Using-TCLab-with-Python's-`with`-statement)", "section": "1.2.1.3 Using TCLab with Python's `with` statement" }, "slideshow": { "slide_type": "skip" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.9\n", "Arduino Leonardo connected on port /dev/cu.usbmodem142101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n", "TCLab disconnected successfully.\n" ] } ], "source": [ "from tclab import TCLab\n", "\n", "with TCLab() as lab:\n", " lab.LED(100)" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.2 Reading Temperatures](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.2-Reading-Temperatures)", "section": "1.2.2 Reading Temperatures" } }, "source": [ "## 1.2.2 Reading Temperatures\n", "\n", "Once a tclab instance is created and connected to a device, the temperature sensors on the temperature control lab can be acccessed with the attributes `.T1` and `.T2`. For example, given an instance `lab`, the temperatures are accessed as\n", "\n", " T1 = lab.T1\n", " T2 = lab.T2\n", "\n", "`lab.T1` and `lab.T2` are read-only properties. Any attempt to set them to a value will return a Python error." ] }, { "cell_type": "code", "execution_count": 6, "metadata": { "nbpages": { "level": 2, "link": "[1.2.2 Reading Temperatures](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.2-Reading-Temperatures)", "section": "1.2.2 Reading Temperatures" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.9\n", "Arduino Leonardo connected on port /dev/cu.usbmodem142101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n", "Temperature 1: 23.48 C\n", "Temperature 2: 23.81 C\n", "TCLab disconnected successfully.\n" ] } ], "source": [ "from tclab import TCLab\n", "\n", "with TCLab() as a:\n", " print(\"Temperature 1: {0:0.2f} C\".format(a.T1))\n", " print(\"Temperature 2: {0:0.2f} C\".format(a.T2))" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.3 Setting Heaters](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.3-Setting-Heaters)", "section": "1.2.3 Setting Heaters" }, "slideshow": { "slide_type": "skip" } }, "source": [ "## 1.2.3 Setting Heaters\n", "\n", "For legacy reasons, there are two ways to set the power levels of the heaters. \n", "\n", "The first way is to the functions`.Q1()` and `.Q2()` of a `TCLab` instance. For example, both heaters can be set to 100% power with the functions\n", "\n", " lab = TCLab()\n", " lab.Q1(100)\n", " lab.Q2(100)\n", "\n", "The device firmware limits the heaters to a range of 0 to 100%. The current value of attributes may be accessed via\n", "\n", " Q1 = lab.Q1()\n", " Q2 = lab.Q2()\n", " \n", "Important notes:\n", "1. The led on the temperature control laboratory will turns from dim to bright when either heater is on.\n", "2. Closing the TCLab instance turns the heaters off.\n", "3. The power level of the two heaters may be different. Current versions of the firmware limit maximum power of first heater to 4 watts, and maxium power of the second heater to 2 watts.\n", "4. In addition to the constraints imposed by the firmware, the power supply may not be capable of providing all of the power needed to operate both heaters at 100%\n", "5. The values retrieved from these functions may be different than the values set due to the power limits enforced by the device firmware." ] }, { "cell_type": "code", "execution_count": 18, "metadata": { "nbpages": { "level": 2, "link": "[1.2.3 Setting Heaters](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.3-Setting-Heaters)", "section": "1.2.3 Setting Heaters" }, "slideshow": { "slide_type": "skip" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.8\n", "Arduino Leonardo connected on port /dev/cu.usbmodem14101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n", "\n", "Starting Temperature 1: 23.81 C\n", "Starting Temperature 2: 23.16 C\n", "\n", "Set Heater 1: 100.0 %\n", "Set Heater 2: 100.0 %\n", "\n", "Heat for 30 seconds\n", "\n", "Turn Heaters Off\n", "\n", "Set Heater 1: 0.0 %\n", "Set Heater 2: 0.0 %\n", "\n", "Final Temperature 1: 28.00 C\n", "Final Temperature 2: 24.77 C\n", "TCLab disconnected successfully.\n" ] } ], "source": [ "from tclab import TCLab\n", "import time\n", "\n", "with TCLab() as a:\n", " print(\"\\nStarting Temperature 1: {0:0.2f} C\".format(a.T1),flush=True)\n", " print(\"Starting Temperature 2: {0:0.2f} C\".format(a.T2),flush=True)\n", "\n", " a.Q1(100)\n", " a.Q2(100)\n", " print(\"\\nSet Heater 1:\", a.Q1(), \"%\",flush=True)\n", " print(\"Set Heater 2:\", a.Q2(), \"%\",flush=True)\n", " \n", " t_heat = 30\n", " print(\"\\nHeat for\", t_heat, \"seconds\")\n", " time.sleep(t_heat)\n", "\n", " print(\"\\nTurn Heaters Off\")\n", " a.Q1(0)\n", " a.Q2(0)\n", " print(\"\\nSet Heater 1:\", a.Q1(), \"%\",flush=True)\n", " print(\"Set Heater 2:\", a.Q2(), \"%\",flush=True)\n", " \n", " print(\"\\nFinal Temperature 1: {0:0.2f} C\".format(a.T1))\n", " print(\"Final Temperature 2: {0:0.2f} C\".format(a.T2))" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.3 Setting Heaters](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.3-Setting-Heaters)", "section": "1.2.3 Setting Heaters" } }, "source": [ "Alternatively, the heaters can be set using the `.U1` and `.U2` attributes of a `TCLab` instance. " ] }, { "cell_type": "code", "execution_count": 20, "metadata": { "nbpages": { "level": 2, "link": "[1.2.3 Setting Heaters](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.3-Setting-Heaters)", "section": "1.2.3 Setting Heaters" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.8\n", "Arduino Leonardo connected on port /dev/cu.usbmodem14101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n", "Setting power levels on heaters 1 and 2\n", "Current power level on Heater 1 is: 50.0 %\n", "Current power level on Heater 1 is: 25.0 %\n", "TCLab disconnected successfully.\n" ] } ], "source": [ "lab = TCLab()\n", "\n", "print('Setting power levels on heaters 1 and 2')\n", "lab.U1 = 50\n", "lab.U2 = 25\n", "\n", "print('Current power level on Heater 1 is: ', lab.U1, '%')\n", "print('Current power level on Heater 1 is: ', lab.U2, '%')\n", "\n", "lab.close()" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.4 Synchronizing with Real Time using `clock`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.4-Synchronizing-with-Real-Time-using-`clock`)", "section": "1.2.4 Synchronizing with Real Time using `clock`" }, "slideshow": { "slide_type": "skip" } }, "source": [ "## 1.2.4 Synchronizing with Real Time using `clock`\n", "\n", "The `tclab` module includes `clock` for synchronizing calculations with real time. `clock(tperiod, tstep)` generates a sequence of iterations over a period of `tperiod` seconds evenly by `tstep` seconds. If `tstep` is omitted then the default period is set to 1 second." ] }, { "cell_type": "code", "execution_count": 24, "metadata": { "nbpages": { "level": 2, "link": "[1.2.4 Synchronizing with Real Time using `clock`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.4-Synchronizing-with-Real-Time-using-`clock`)", "section": "1.2.4 Synchronizing with Real Time using `clock`" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "0 sec.\n", "2.0 sec.\n", "4.0 sec.\n", "6.0 sec.\n" ] } ], "source": [ "from tclab import clock\n", "\n", "tperiod = 6\n", "tstep = 2\n", "for t in clock(tperiod,tstep):\n", " print(t, \"sec.\")" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.4 Synchronizing with Real Time using `clock`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.4-Synchronizing-with-Real-Time-using-`clock`)", "section": "1.2.4 Synchronizing with Real Time using `clock`" } }, "source": [ "There are some considerations to keep in mind when using `clock`. Most important, by its nature Python is not a real-time environment. `clock` makes a best effort to stay in sync with evenly spaced ticks of the real time clock. If, for some reason, the loop falls behind the real time clock, then the generator will skip over the event to get back in sync with the real time clock. Thus the total number of iterations may be less than expected. This behavior is demonstrated in the following cell." ] }, { "cell_type": "code", "execution_count": 27, "metadata": { "nbpages": { "level": 2, "link": "[1.2.4 Synchronizing with Real Time using `clock`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.4-Synchronizing-with-Real-Time-using-`clock`)", "section": "1.2.4 Synchronizing with Real Time using `clock`" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "0 sec.\n", "2.0 sec.\n", "4.0 sec.\n", "8.0 sec.\n", "10.0 sec.\n", "12.0 sec.\n" ] } ], "source": [ "from tclab import TCLab, clock\n", "\n", "import time\n", "\n", "tfinal = 12\n", "tstep = 2\n", "for t in clock(tfinal, tstep):\n", " print(t, \"sec.\")\n", " \n", " # insert a long time out between 3 and 5 seconds into the event loop\n", " if (t > 3) and (t < 5):\n", " time.sleep(2.2)" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 3, "link": "[1.2.4.1 Using `clock` with TCLab](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.4.1-Using-`clock`-with-TCLab)", "section": "1.2.4.1 Using `clock` with TCLab" } }, "source": [ "### 1.2.4.1 Using `clock` with TCLab" ] }, { "cell_type": "code", "execution_count": 29, "metadata": { "nbpages": { "level": 3, "link": "[1.2.4.1 Using `clock` with TCLab](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.4.1-Using-`clock`-with-TCLab)", "section": "1.2.4.1 Using `clock` with TCLab" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.8\n", "Arduino Leonardo connected on port /dev/cu.usbmodem14101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n", "\n", "Set Heater 1 to 100.000000 %\n", "Set Heater 2 to 100.000000 %\n", " 0.0 sec: T1 = 24.8 C T2 = 22.8 C\n", " 1.0 sec: T1 = 24.8 C T2 = 24.1 C\n", " 2.0 sec: T1 = 24.8 C T2 = 23.2 C\n", " 3.0 sec: T1 = 24.8 C T2 = 22.8 C\n", " 4.0 sec: T1 = 24.8 C T2 = 23.2 C\n", " 5.0 sec: T1 = 25.1 C T2 = 24.1 C\n", " 6.0 sec: T1 = 25.1 C T2 = 24.1 C\n", " 7.0 sec: T1 = 25.1 C T2 = 23.2 C\n", " 8.0 sec: T1 = 25.4 C T2 = 23.2 C\n", " 9.0 sec: T1 = 25.4 C T2 = 23.5 C\n", " 10.0 sec: T1 = 25.7 C T2 = 24.4 C\n", " 11.0 sec: T1 = 25.7 C T2 = 23.5 C\n", " 12.0 sec: T1 = 25.7 C T2 = 23.5 C\n", " 13.0 sec: T1 = 26.1 C T2 = 23.5 C\n", " 14.0 sec: T1 = 26.4 C T2 = 23.8 C\n", " 15.0 sec: T1 = 26.4 C T2 = 24.8 C\n", " 16.0 sec: T1 = 26.7 C T2 = 23.8 C\n", " 17.0 sec: T1 = 26.7 C T2 = 24.1 C\n", " 18.0 sec: T1 = 27.0 C T2 = 24.1 C\n", " 19.0 sec: T1 = 27.0 C T2 = 25.1 C\n", " 20.0 sec: T1 = 27.4 C T2 = 25.4 C\n", "TCLab disconnected successfully.\n" ] } ], "source": [ "from tclab import TCLab, clock\n", "\n", "tperiod = 20\n", "\n", "# connect to the temperature control lab\n", "with TCLab() as a:\n", " # turn heaters on\n", " a.Q1(100)\n", " a.Q2(100)\n", " print(\"\\nSet Heater 1 to {0:f} %\".format(a.Q1()))\n", " print(\"Set Heater 2 to {0:f} %\".format(a.Q2()))\n", "\n", " # report temperatures for the next tperiod seconds\n", " sfmt = \" {0:5.1f} sec: T1 = {1:0.1f} C T2 = {2:0.1f} C\"\n", " for t in clock(tperiod):\n", " print(sfmt.format(t, a.T1, a.T2), flush=True)\n", " " ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.5 The TCLab `Historian`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.5-The-TCLab-`Historian`)", "section": "1.2.5 The TCLab `Historian`" } }, "source": [ "## 1.2.5 The TCLab `Historian`" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.5 The TCLab `Historian`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.5-The-TCLab-`Historian`)", "section": "1.2.5 The TCLab `Historian`" } }, "source": [ "The `Historian` class provides means for data logging. Given an instance `lab` of a TCLab object, `lab.sources` is a list of all data sources and methods to access the data.\n", "\n", " lab = TCLab()\n", " h = Historian(lab.sources)\n", " \n", "The historian initializes a data log. The data log is updated by issuing a command\n", "\n", " h.update(t)\n", " \n", "where `t` marks the current time. The following cell logs 10 seconds of data with a chaning power level to heater 1, then saves the data to a file." ] }, { "cell_type": "code", "execution_count": 7, "metadata": { "nbpages": { "level": 2, "link": "[1.2.5 The TCLab `Historian`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.5-The-TCLab-`Historian`)", "section": "1.2.5 The TCLab `Historian`" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.9\n", "Arduino Leonardo connected on port /dev/cu.usbmodem142101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n", "TCLab disconnected successfully.\n" ] } ], "source": [ "from tclab import TCLab, clock, Historian\n", "\n", "with TCLab() as lab:\n", " h = Historian(lab.sources)\n", " for t in clock(10):\n", " lab.Q1(100 if t <= 5 else 0)\n", " h.update(t)\n", " \n", "h.to_csv('data.csv')" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.5 The TCLab `Historian`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.5-The-TCLab-`Historian`)", "section": "1.2.5 The TCLab `Historian`" } }, "source": [ "Once saved, data can be read and plotted using the [Pandas Data Analysis Library](https://pandas.pydata.org/) as demonstrated in this cell." ] }, { "cell_type": "code", "execution_count": 59, "metadata": { "nbpages": { "level": 2, "link": "[1.2.5 The TCLab `Historian`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.5-The-TCLab-`Historian`)", "section": "1.2.5 The TCLab `Historian`" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ " Time T1 T2 Q1 Q2\n", "Time \n", "0.0 0.0 20.26 19.94 100.0 0.0\n", "1.0 1.0 20.26 19.94 100.0 0.0\n", "2.0 2.0 20.26 19.94 100.0 0.0\n", "3.0 3.0 20.26 19.94 100.0 0.0\n", "4.0 4.0 20.26 19.94 100.0 0.0\n", "5.0 5.0 20.26 19.94 100.0 0.0\n", "6.0 6.0 20.26 19.94 0.0 0.0\n", "7.0 7.0 20.26 19.94 0.0 0.0\n", "8.0 8.0 20.26 19.94 0.0 0.0\n", "9.0 9.0 20.26 19.94 0.0 0.0\n", "10.0 10.0 20.26 19.94 0.0 0.0\n" ] }, { "data": { "text/plain": [ "" ] }, "execution_count": 59, "metadata": {}, "output_type": "execute_result" }, { "data": { "image/png": "iVBORw0KGgoAAAANSUhEUgAAAXoAAAEKCAYAAAAcgp5RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAALEgAACxIB0t1+/AAAADl0RVh0U29mdHdhcmUAbWF0cGxvdGxpYiB2ZXJzaW9uIDMuMC4yLCBodHRwOi8vbWF0cGxvdGxpYi5vcmcvOIA7rQAAGbtJREFUeJzt3X9s1Ped5/Hn278wnoEA9uCyGGJmyqWbkivU7o8kq8gpzand3VvS3kZquhehNBI6XWiym0hJdlupPUVqs1K72Z56isQ12YCuatKDVMn2uptEgK9bpZdrSLpNgOwBJqQmBAMNAQM2GL/vj/maeMFg+zvz/TV+PSTLnu98v/P9fAJ58fFnPvP+mLsjIiK1qy7pBoiISLQU9CIiNU5BLyJS4xT0IiI1TkEvIlLjFPQiIjVOQS8iUuMU9CIiNU5BLyJS4xqSbgBAW1ubd3Z2hrr21KlT5HK56jYo5dTnmUF9nhkq6fOOHTuOunthsvNSEfSdnZ288soroa7t7e2lp6enug1KOfV5ZlCfZ4ZK+mxmB6ZynqZuRERqnIJeRKTGKehFRGpcKuboRUSicu7cOfr7+xkaGkq6KRO66qqr2L179xXPaW5upqOjg8bGxlD3UNCLSE3r7+9nzpw5dHZ2YmZJN+cSJ0+eZM6cOZd93t05duwY/f39LFu2LNQ9Jp26MbMnzGzAzN4Yd2yBmb1oZnuC7/OD42Zm/9XM9prZb8zs46FaJSJSJUNDQ7S2tqYy5KfCzGhtba3oN5KpzNE/CXzuomMPAVvdfTmwNXgM8HlgefC1DngsdMtERKokqyE/ptL2Tzp14+4/N7POiw6vAXqCnzcCvcCDwfFNXt6f8P+Y2TwzW+Tuhypq5WX86q3f8cyes7x69l+iePnUeuuA+hyX3KwGvvIHy2is17oFya6wc/TtY+Ht7ofMbGFwfDHw23Hn9QfHLgl6M1tHedRPe3s7vb29027Ez/af5e/3nYV9e6d9bba5+hzPHQE4d+QtVrTVx3pvgMHBwVD/X2RZFH2+6qqrOHnyZFVfc7oOHjzI/fffz5tvvsno6Ci33HIL3/rWtxgcHOSOO+7gtdde48tf/jLf/e53L/saQ0ND4f/buPukX0An8Ma4x8cvev694Pv/Av5g3PGtQNdkr9/V1eVhbd++PfS1WaU+x+PwiTN+9YM/9b/7RV/s93bXn3O17Nq1q+qvOR2jo6P+iU98wp944gl3dx8ZGfGvfOUrfs899/jg4KA///zz/thjj/ndd999xdeZqB/AKz6FDA/7++hhM1sEEHwfCI73A0vGndcBvBPyHiKJKuRnMae5gb6jp5JuimTYtm3baG5u5s477wSgvr6eRx99lE2bNuHuXH/99TQ3N0fahrBTN88Ba4FHgu/Pjju+3syeAj4FvO8Rzc+LRM3MKBby7DsymHRTpEr+y9/vZNc7J6r6mtf+3ly+8e8/etnnd+7cSVdX1786NnfuXDo7O9m7dy+lUqmq7ZnIVJZX/gj4JXCNmfWb2V2UA/4WM9sD3BI8BvgZ0AfsBf478J8jabVITEptOfqOaEQv4bn7hKtmyjMv8ZjKqpvbL/PU6gnOdeDuShslkhalhXmeee0gp4ZHyM3S5wuz7koj76h89KMfZcuWLf/q2IkTJzh8+DDXXHMNIyMjkbdBa8ZErqDYVq4Tvl/z9BLS6tWrOX36NJs2bQLg/Pnz3H///axfv57Zs2fH0gYFvcgVlBbmATRPL6GZGT/5yU/YvHkzy5cvp7W1lbq6Or72ta8BsGLFCu677z6efPJJOjo62LVrV9XboN9FRa7g6tYW6gz2aZ5eKrBkyRKee+45AF566SVuv/12duzYQVdXF2+88cYVa91Ug4Je5ApmNdSzZEELfRrRS5XccMMNHDgwpY2hqkZTNyKTKLblNKKXTFPQi0yiWMiz/+ggo6PxLYcTqSYFvcgkSoU8Q+dGOXQinRtXiExGQS8yiWKhvMRy34Dm6SWbFPQikygVykss9YasZJWCXmQSbfkm5jQ36A1ZCa2/v581a9awfPlyisUi69evZ3h4mBdffJGbbrqJ6667jq6uLrZt2xbJ/RX0IpMwM0qFPH1HNaKX6XN3vvjFL3LrrbeyZ88e9uzZw5kzZ3jggQdoa2vj6aef5vXXX2fjxo3ccccdkbRBQS8yBcVCjn0DGtHL9F2pTPHy5ctZtGgRUK6JMzQ0xPDwcNXboA9MiUxBqZDnmVdV3Czz/uEhePf16r7mh66Dzz9y2aenWqZ4y5YtrFq1ilmzZlW3fSjoRaakVPiguNmKxVcl3BrJkqmUKd65cycPPvggL7zwQiRtUNCLTEGx8EFxMwV9hl1h5B2VycoUHzhwgC984Qts2rQpsk1INEcvMgUqbiZhXalM8fDwMLfddhvf/va3ufHGGyNrg4JeZArGipupXLFM15XKFH//+9+nr6+Phx9+mJUrV7Jy5UoGBgYmf9Fp0tSNyBQVta2ghHS5MsVf//rXuffee1WmWCQtSoU8v+w7xuioU1d36ZtrIlOhMsUiKVYMipu98/6ZpJsiMi0KepEpGltiqemb7Bm/lDGLKm2/gl5kisYvsZTsaG5u5tixY5kNe3fn2LFjNDc3h34NzdGLTFFbvom5zQ0a0WdMR0cH/f39HDlyJOmmTGhoaGjSEG9ubqajoyP0PRT0IlNkZhQLeY3oM6axsZFly5Yl3YzL6u3tZdWqVZHeQ1M3ItNQLGiJpWSPgl5kGkqFPO+eGGJweCTppohMmYJeZBouFDfTqF4yREEvMg0XthXUJiSSIQp6kWlYOlbcTBuFS4Yo6EWm4UJxs6OaupHsqCjozewvzGynmb1hZj8ys2YzW2ZmL5vZHjN72syaqtVYkTQoFfJaeSOZEjrozWwxcA/Q7e4rgHrgS8BfA4+6+3LgPeCuajRUJC2KbTn2Hx1kdDSbn7SUmafSqZsGYLaZNQAtwCHgM8Dm4PmNwK0V3kMkVUoLVdxMsiV00Lv7QeA7wNuUA/59YAdw3N3HFhn3A4srbaRImhTbyksstduUZEXoEghmNh9YAywDjgP/E/j8BKdO+Putma0D1gG0t7fT29sbqh2Dg4Ohr80q9TlZJ4bLf6VfeOnX+DuNkd0nTX2Oi/ocjUpq3XwW2O/uRwDM7BngBmCemTUEo/oO4J2JLnb3DcAGgO7ubu/p6QnViN7eXsJem1Xqc7Lcna//8gVs3ofo6bkusvukqc9xUZ+jUckc/dvAp82sxcwMWA3sArYDfxqcsxZ4trImiqTLWHEzrbyRrKhkjv5lym+6vgq8HrzWBuBB4D4z2wu0Ao9XoZ0iqaIllpIlFZUpdvdvAN+46HAf8MlKXlck7YqFHFte7WdweIT8LFX7lnTTJ2NFQhireaPiZpIFCnqREMaqWGoTEskCBb1ICGPFzfoU9JIBCnqREGY11LN0QYs+NCWZoKAXCUn7x0pWKOhFQioVcuw/ekrFzST1FPQiIRULeYZHRjl4XMXNJN0U9CIhfbCtoObpJd0U9CIhFceWWGpbQUk5Bb1ISK25JuY2N2ijcEk9Bb1ISGZGaaFq3kj6KehFKlBs0xJLST8FvUgFSgtzHD4xzODwyOQniyREQS9SgWJbsPJGo3pJMQW9SAU+vLC88kbz9JJmCnqRCixdkKO+zjRPL6mmoBepQFNDHUvmz9aIXlJNQS9SoZKKm0nKKehFKlRUcTNJOQW9SIVKKm4mKaegF6lQMShupukbSSsFvUiFxoqb6Q1ZSSsFvUiFWnNNXDW7UcXNJLUU9CIVMjOKhRz7BjSil3RS0ItUQamQ14heUktBL1IFxUK5uNnJoXNJN0XkEgp6kSoY21Zwv7YVlBRS0ItUQWlsW0EtsZQUUtCLVMFYcTMtsZQ0UtCLVEFTQx1LF7Qo6CWVFPQiVVJsy2nqRlKpoqA3s3lmttnM3jSz3WZ2vZktMLMXzWxP8H1+tRorkmalhXn2Hz3FeRU3k5SpdET/PeAf3f0jwMeA3cBDwFZ3Xw5sDR6L1LxiW47hkVHeUXEzSZnQQW9mc4GbgMcB3P2sux8H1gAbg9M2ArdW2kiRLFBxM0krcw/3a6aZrQQ2ALsoj+Z3APcCB9193rjz3nP3S6ZvzGwdsA6gvb2966mnngrVjsHBQfL5fKhrs0p9TqcTZ517tp3myx9p4t91Nlb8elnoc7Wpz9Nz880373D37klPdPdQX0A3MAJ8Knj8PeBh4PhF57032Wt1dXV5WNu3bw99bVapz+k0Ojrq//abz/tfPfObqrxeFvpcberz9ACv+BTyupI5+n6g391fDh5vBj4OHDazRQDB94EK7iGSGWZGqZDTEktJndBB7+7vAr81s2uCQ6spT+M8B6wNjq0Fnq2ohSIZUtT+sZJCDRVe/1Xgh2bWBPQBd1L+x+PHZnYX8DZwW4X3EMmMUiHP5h39nBw6x5zmyufpRaqhoqB3919Tnqu/2OpKXlckq8bvNvWxJfMmOVskHvpkrEgVjRU3U216SRMFvUgVqbiZpJGCXqSKxoqb6Q1ZSRMFvUiVaYmlpI2CXqTKioU8fSpuJimioBepsmJbjrMqbiYpoqAXqbLSwnLdkr2ap5eUUNCLVFmx7YO19CJpoKAXqbIFuSbmtTTSpxG9pISCXqTKzEzbCkqqKOhFIlAq5DV1I6mhoBeJQLGQZ+DkMCeHziXdFBEFvUgUxhc3E0magl4kAqVg/1gVN5M0UNCLRGDpghbq64x9AxrRS/IU9CIRaGqo4+oFLRrRSyoo6EUiUizkNKKXVFDQi0SkVMiz/5iKm0nyFPQiESkWysXNDr6n4maSLAW9SESKwcqbfZqnl4Qp6EUicmGJpdbSS8IU9CIRGStuppo3kjQFvUiEyjVvFPSSLAW9SITKVSw1dSPJUtCLRKhYyHNExc0kYQp6kQiVVNxMUkBBLxKhC0ssNU8vCVLQi0To6tYWGupMI3pJlIJeJEKN9XUsXdCiEb0kSkEvErGithWUhFUc9GZWb2avmdlPg8fLzOxlM9tjZk+bWVPlzRTJrlIhp+JmkqhqjOjvBXaPe/zXwKPuvhx4D7irCvcQySwVN5OkVRT0ZtYB/BHwg+CxAZ8BNgenbARureQeIllXUnEzSVilI/q/BR4ARoPHrcBxdx8JHvcDiyu8h0imXVhiOaCgl2Q0hL3QzP4YGHD3HWbWM3Z4glMnnJg0s3XAOoD29nZ6e3tDtWNwcDD0tVmlPmdPvhF+8Zs9fPj821O+Jut9DkN9jkbooAduBP7EzP4QaAbmUh7hzzOzhmBU3wG8M9HF7r4B2ADQ3d3tPT09oRrR29tL2GuzSn3Onmt2v8SZOqOn5/opX5P1PoehPkcj9NSNu/+lu3e4eyfwJWCbu/8ZsB340+C0tcCzFbdSJOOKbTn6jmqJpSQjinX0DwL3mdleynP2j0dwD5FMKS0sFzc7oeJmkoBKpm4ucPdeoDf4uQ/4ZDVeV6RWFNs+KG62csm8hFsjM40+GSsSg9LCsW0FtfJG4qegF4nB0gXl4maqeSNJUNCLxKCxvo6lrS2qeSOJUNCLxKTYlteIXhKhoBeJSamQ461jp1XcTGKnoBeJSamQV3EzSYSCXiQmxWD/WE3fSNwU9CIxKWn/WEmIgl4kJvNzTcxvaWSfVt5IzBT0IjEqbyuoEb3ES0EvEqNSIacRvcROQS8So2Ihz9FBFTeTeCnoRWI09oasPiErcVLQi8TowhJLbSsoMVLQi8RorLhZnzYKlxgp6EViNFbcbN+Apm4kPgp6kZgV2/Ia0UusFPQiMSstzPHWURU3k/go6EViVmrLc/b8KP3vnU66KTJDKOhFYlZa+MH+sSJxUNCLxKzYpuJmEi8FvUjM5ueaWJBrUikEiY2CXiQBxbacRvQSGwW9SAKKhZzm6CU2CnqRBJSC4mbvn1FxM4megl4kAcULxc00fSPRU9CLJKBU0BJLiY+CXiQBS4LiZnpDVuKgoBdJwFhxM43oJQ4KepGElAoqbibxUNCLJKRYUHEziUfooDezJWa23cx2m9lOM7s3OL7AzF40sz3B9/nVa65I7SgVVNxM4lHJiH4EuN/dfx/4NHC3mV0LPARsdfflwNbgsYhcZGzljd6QlaiFDnp3P+TurwY/nwR2A4uBNcDG4LSNwK2VNlKkFo0VN9MbshI1c698ftDMOoGfAyuAt9193rjn3nP3S6ZvzGwdsA6gvb2966mnngp178HBQfL5fKhrs0p9rh1f3XqKj7c3cOeKWZc8V6t9vhL1eXpuvvnmHe7ePdl5DaFefRwzywNbgD939xNmNqXr3H0DsAGgu7vbe3p6Qt2/t7eXsNdmlfpcO67Z/RJn6oyenusvea5W+3wl6nM0Klp1Y2aNlEP+h+7+THD4sJktCp5fBAxU1kSR2lUq5DV1I5GrZNWNAY8Du939b8Y99RywNvh5LfBs+OaJ1LZiIafiZhK5Skb0NwJ3AJ8xs18HX38IPALcYmZ7gFuCxyIygZKKm0kMQs/Ru/svgMtNyK8O+7oiM0nxwhLLU6xaqo+cSDT0yViRBI0VN9OIXqKkoBdJUGN9HVeruJlETEEvkrBiIa9Px0qkFPQiCSsV8hw4dpqR86NJN0VqlIJeJGHFQi4obnYm6aZIjVLQiyTswhJL1aaXiCjoRRJ2oYrlgN6QlWgo6EUSNq+liQW5Jo3oJTIKepEUKBVy7NMSS4mIgl4kBYpteX1oSiKjoBdJgdLCHEcHz/L+aRU3k+pT0IukwNhuU/s0Ty8RUNCLpMBYcTOVQpAoKOhFUmDJghYa602lECQSCnqRFGisr2Ppgha9ISuRUNCLpIS2FZSoKOhFUqJYyPPWsVMqbiZVp6AXSYlSIce5867iZlJ1CnqRlCgGxc30hqxUm4JeJCVKWmIpEVHQi6TEvJYmWlXcTCKgoBdJkWIhp3LFUnUKepEUKRXyGtFL1SnoRVKkWFBxM6k+Bb1IioxtK6jiZlJNCnqRFLmwxHJAQS/Vo6AXSZEl82fTWG/0HdUbslI9CnqRFGmor+Pq1pyKm0lVKehFUqbYpv1jpboU9CIpU1qY58CxU5wf9aSbIjUikqA3s8+Z2b+Y2V4zeyiKe4jUqmJbubjZkTMKeqmOqge9mdUD/w34PHAtcLuZXVvt+4jUqrGVN++eUrliqY4oRvSfBPa6e5+7nwWeAtZEcB+RmjRW3OzQKY3opToaInjNxcBvxz3uBz4VwX3gHx5i5Zv/BPvnRfLyabXy+HH1uYbNAzY3/47Rt5x/fvibSTcnVnPPn+ef/6k+6WbEKj/3aujpifQeUQS9TXDskqGJma0D1gG0t7fT29s77Rt9uL+f2efPc/z48Wlfm2Xn1eea19oMp86CMbOmb+rrZl6fz42eD5V/0xFF0PcDS8Y97gDeufgkd98AbADo7u72njD/ovX00NvbS6hrM0x9rn3zmHl9BvU5KlHM0f8KWG5my8ysCfgS8FwE9xERkSmo+oje3UfMbD3wPFAPPOHuO6t9HxERmZoopm5w958BP4vitUVEZHr0yVgRkRqnoBcRqXEKehGRGqegFxGpcQp6EZEaZ+7J19MwsyPAgZCXtwFHq9icLFCfZwb1eWaopM9Xu3thspNSEfSVMLNX3L076XbESX2eGdTnmSGOPmvqRkSkxinoRURqXC0E/YakG5AA9XlmUJ9nhsj7nPk5ehERubJaGNGLiMgVZDroZ9om5Ga2xMy2m9luM9tpZvcm3aY4mFm9mb1mZj9Nui1xMLN5ZrbZzN4M/qyvT7pNUTOzvwj+Tr9hZj8ys+ak21RtZvaEmQ2Y2Rvjji0wsxfNbE/wfX4U985s0M/QTchHgPvd/feBTwN3z4A+A9wL7E66ETH6HvCP7v4R4GPUeN/NbDFwD9Dt7isolzf/UrKtisSTwOcuOvYQsNXdlwNbg8dVl9mgZwZuQu7uh9z91eDnk5QDYHGyrYqWmXUAfwT8IOm2xMHM5gI3AY8DuPtZd58Jeyg2ALPNrAFoYYJd6bLO3X8O/O6iw2uAjcHPG4Fbo7h3loN+ok3Iazr0xjOzTmAV8HKyLYnc3wIPwIzZSLQIHAH+Lpiu+oGZ5ZJuVJTc/SDwHeBt4BDwvru/kGyrYtPu7oegPJADFkZxkywH/ZQ2Ia9FZpYHtgB/7u4nkm5PVMzsj4EBd9+RdFti1AB8HHjM3VcBp4jo1/m0COal1wDLgN8Dcmb2H5NtVW3JctBPaRPyWmNmjZRD/ofu/kzS7YnYjcCfmNlblKfmPmNm/yPZJkWuH+h397Hf1DZTDv5a9llgv7sfcfdzwDPADQm3KS6HzWwRQPB9IIqbZDnoZ9wm5GZmlOdud7v73yTdnqi5+1+6e4e7d1L+893m7jU90nP3d4Hfmtk1waHVwK4EmxSHt4FPm1lL8Hd8NTX+BvQ4zwFrg5/XAs9GcZNI9oyNwwzdhPxG4A7gdTP7dXDsr4I9eqV2fBX4YTCA6QPuTLg9kXL3l81sM/Aq5ZVlr1GDn5A1sx8BPUCbmfUD3wAeAX5sZndR/gfvtkjurU/GiojUtixP3YiIyBQo6EVEapyCXkSkxinoRURqnIJeRKTGZXZ5pUgYZtZKuXgUwIeA85RLDgCcdveZ8kEdmUG0vFJmLDP7JjDo7t9Jui0iUdLUjUjAzAaD7z1m9r/N7Mdm9v/M7BEz+zMz+79m9rqZlYLzCma2xcx+FXzdmGwPRCamoBeZ2Mco18G/jvKnkf+Nu3+ScrnkrwbnfA941N0/AfwHZkgpZckezdGLTOxXY+VjzWwfMFY293Xg5uDnzwLXlsuzADDXzOYEewWIpIaCXmRiw+N+Hh33eJQP/r+pA6539zNxNkxkujR1IxLeC8D6sQdmtjLBtohcloJeJLx7gG4z+42Z7QL+U9INEpmIlleKiNQ4jehFRGqcgl5EpMYp6EVEapyCXkSkxinoRURqnIJeRKTGKehFRGqcgl5EpMb9f6Y/bqCIgUu/AAAAAElFTkSuQmCC\n", "text/plain": [ "

" ] }, "metadata": { "needs_background": "light" }, "output_type": "display_data" } ], "source": [ "%matplotlib inline\n", "\n", "import pandas as pd\n", "data = pd.read_csv('data.csv')\n", "data.index = data['Time']\n", "print(data)\n", "data[['Q1','Q2']].plot(grid=True)" ] }, { "cell_type": "markdown", "metadata": { "nbpages": { "level": 2, "link": "[1.2.6 The TCLab `Plotter`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.6-The-TCLab-`Plotter`)", "section": "1.2.6 The TCLab `Plotter`" } }, "source": [ "## 1.2.6 The TCLab `Plotter`\n", "\n", "The `Plotter` class adds a real time plotting of experimental data. A plotter is created from an instance of an historian as follows\n", "\n", " h = Historian(lab.sources)\n", " p = Plotter(h)\n", " \n", "Updating the plotter also updates the associated historian.\n", "\n", " p.update(t)\n", " \n", "The following example shows how this works." ] }, { "cell_type": "code", "execution_count": 9, "metadata": { "nbpages": { "level": 2, "link": "[1.2.6 The TCLab `Plotter`](https://jckantor.github.io/CBE32338/01.02-The-TCLab-Python-Package.html#1.2.6-The-TCLab-`Plotter`)", "section": "1.2.6 The TCLab `Plotter`" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "TCLab version 0.4.9\n", "Arduino Leonardo connected on port /dev/cu.usbmodem142101 at 115200 baud.\n", "TCLab Firmware 1.4.3 Arduino Leonardo/Micro.\n" ] }, { "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 = $('