rparedis
/
pyCBD


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149
							

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>CBD.realtime.plotting module &mdash; CBD Simulation Development Kit  documentation</title>
  

  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
  <link rel="stylesheet" href="_static/style.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="CBD.realtime.threadingBackend module" href="CBD.realtime.threadingBackend.html" />
    <link rel="prev" title="CBD.realtime.accurate_time module" href="CBD.realtime.accurate_time.html" /> 

  
  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
  <script src="_static/js/googleanalytics.min.js"></script>
  
  <script src="_static/js/modernizr.min.js"></script>

  <!-- Preload the theme fonts -->

<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<!-- Preload the katex fonts -->

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
</head>

<div class="container-fluid header-holder tutorials-header" id="header-holder">
  <div class="container">
    <div class="header-container">
      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>

      <div class="main-menu">
        <ul>

          <li>
            <div class="ecosystem-dropdown">
              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
                Ecosystem
              </a>
              <div class="ecosystem-dropdown-menu">
                <a class="nav-dropdown-item" href="https://alchemy.host">
                  <span class=dropdown-title>Alchemy</span>
                  <p>Experiments logging & visualization</p>
                </a>
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
                  <span class=dropdown-title>Catalyst</span>
                  <p>Accelerated deep learning R&D</p>
                </a>
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
                  <span class=dropdown-title>Reaction</span>
                  <p>Convenient deep learning models serving</p>
                </a>
              </div>
            </div>
          </li>

          <li>
            <div class="projects-dropdown">
              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
                Projects
              </a>
              <div class="projects-dropdown-menu">
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
                  <span class=dropdown-title>Codestyle</span>
                  <p>Joint R&D codestyle</p>
                </a>
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
                  <span class=dropdown-title>Catalyst.Neuro</span>
                  <p>Catalyst.Team and TReNDS collaborative project</p>
                </a>
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
                  <span class=dropdown-title>Classification</span>
                  <p>Image classification pipeline with transfer learning</p>
                </a>
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
                  <span class=dropdown-title>Detection</span>
                  <p>Object detection pipeline</p>
                </a>
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
                  <span class=dropdown-title>Segmentation</span>
                  <p>Image semantic segmentation pipeline</p>
                </a>
                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
                  <span class=dropdown-title>Catalyst.GAN</span>
                  <p>GAN pipelines</p>
                </a>
              </div>
            </div>
          </li>

          <li>
            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
          </li>
        </ul>
      </div>

      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
    </div>

  </div>
</div>


<body class="catalyst-body">

   
    <div class="table-of-contents-link-wrapper">
      <span>Table of Contents</span>
      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
    </div>

    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
      <div class="catalyst-side-scroll">
        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          <div class="catalyst-left-menu-search">
            

<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search Docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

            
          </div>

          
              <p class="caption"><span class="caption-text">Setup</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="install.html">How to install the CBD framework?</a></li>
<li class="toctree-l1"><a class="reference internal" href="running.html">How to run a CBD simulation?</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
<p class="caption"><span class="caption-text">Simple Examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/SinGen.html">Sine Generator</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/EvenNumberGen.html">Hierarchical Even Number Generator</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/Fibonacci.html">Fibonacci Sequence Generator</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/LCG.html">Linear Congruential Generator</a></li>
</ul>
<p class="caption"><span class="caption-text">Advanced Examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/RealTime.html">Realtime Simulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/LivePlot.html">Live Plotting of Data During the Simulation</a></li>
</ul>
<p class="caption"><span class="caption-text">Internal Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="CBD.html">CBD package</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <div class="catalyst-container">
      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
        <div class="catalyst-breadcrumbs-wrapper">
          

<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="catalyst-breadcrumbs">
    
      <li>
        <a href="index.html">
          
            Docs
          
        </a> &gt;
      </li>

        
          <li><a href="install.html">How to install the CBD framework?</a> &gt;</li>
        
          <li><a href="CBD.realtime.html">CBD.realtime package</a> &gt;</li>
        
      <li>CBD.realtime.plotting module</li>
    
    
      <li class="catalyst-breadcrumbs-aside">
        
            
      </li>
    
  </ul>

  
</div>
        </div>

        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
          Shortcuts
        </div>
      </div>

      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
        <div class="catalyst-content-left">
          
          <div class="rst-content">
          
            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
              
  <div class="section" id="module-CBD.realtime.plotting">
<span id="cbd-realtime-plotting-module"></span><h1>CBD.realtime.plotting module<a class="headerlink" href="#module-CBD.realtime.plotting" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="CBD.realtime.plotting.Backend">
<em class="property">class </em><code class="descclassname">CBD.realtime.plotting.</code><code class="descname">Backend</code><a class="reference internal" href="_modules/CBD/realtime/plotting.html#Backend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.Backend" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>In which framework the plots need to be made.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Some attributes won’t be available if the corresponding framework is not installed.</p>
</div>
<dl class="attribute">
<dt id="CBD.realtime.plotting.Backend.MPL">
<code class="descname">MPL</code><em class="property"> = 1</em><a class="headerlink" href="#CBD.realtime.plotting.Backend.MPL" title="Permalink to this definition">¶</a></dt>
<dd><p>Use <a class="reference external" href="https://matplotlib.org/">Matplotlib</a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="CBD.realtime.plotting.Backend.MATPLOTLIB">
<code class="descname">MATPLOTLIB</code><em class="property"> = 1</em><a class="headerlink" href="#CBD.realtime.plotting.Backend.MATPLOTLIB" title="Permalink to this definition">¶</a></dt>
<dd><p>Use <a class="reference external" href="https://matplotlib.org/">Matplotlib</a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="CBD.realtime.plotting.Backend.BOKEH">
<code class="descname">BOKEH</code><em class="property"> = 2</em><a class="headerlink" href="#CBD.realtime.plotting.Backend.BOKEH" title="Permalink to this definition">¶</a></dt>
<dd><p>Use <a class="reference external" href="//docs.bokeh.org/en/latest/index.html">Bokeh</a>.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p>For <code class="code docutils literal notranslate"><span class="pre">BOKEH</span></code>, a server must be started with:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>bokeh serve
</pre></div>
</div>
<div class="last line-block">
<div class="line"><br /></div>
</div>
</div>
<div class="admonition attention">
<p class="first admonition-title">Attention</p>
<p class="last">This backend is still in beta.</p>
</div>
</dd></dl>

<dl class="staticmethod">
<dt id="CBD.realtime.plotting.Backend.exists">
<em class="property">static </em><code class="descname">exists</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#Backend.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.Backend.exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks that a given backend exists.</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="CBD.realtime.plotting.PlotHandler">
<em class="property">class </em><code class="descclassname">CBD.realtime.plotting.</code><code class="descname">PlotHandler</code><span class="sig-paren">(</span><em>object</em>, <em>figure</em>, <em>kind</em>, <em>backend=1</em>, <em>interval=100</em>, <em>frames=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Handles Real-Time plotting, independent of a plotting framework.</p>
<p>Every <code class="code docutils literal notranslate"><span class="pre">interval</span></code> time, data will be polled from the <code class="code docutils literal notranslate"><span class="pre">object</span></code>,
w.r.t. the given plotting <code class="code docutils literal notranslate"><span class="pre">backend</span></code>. The handler will use the knowledge
of a backend to determine how the given <code class="code docutils literal notranslate"><span class="pre">figure</span></code> must be updated.</p>
<p>This class can be used in any simulation context, where plotting data can be
polled from an object or a resource.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">While technically framework-independent, matplotlib has the least external
overhead in your code.</p>
</div>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">When using multiple plots/plotting instances, you should make use of the
<a class="reference internal" href="#CBD.realtime.plotting.PlotManager" title="CBD.realtime.plotting.PlotManager"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotManager</span></code></a>.</p>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Bokeh is still in beta. Not all features will work as required.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AssertionError</span></code> – if the backend cannot be located.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>object</strong> (<em>Any</em>) – The object from which data needs to be polled. By default,
the <code class="code docutils literal notranslate"><span class="pre">data_xy</span></code> attribute will be used on the object,
which should result in a 2xN array in the form of
<code class="code docutils literal notranslate"><span class="pre">([x1,</span> <span class="pre">x2,</span> <span class="pre">x3...],</span> <span class="pre">[y1,</span> <span class="pre">y2,</span> <span class="pre">y3...])</span></code>. Change this
behaviour with the <a class="reference internal" href="#CBD.realtime.plotting.PlotHandler.set_data_getter" title="CBD.realtime.plotting.PlotHandler.set_data_getter"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_data_getter()</span></code></a> function.</li>
<li><strong>figure</strong> – <p>The figure object required for plotting. This has been made
externally to allow for full manipulation of the plotting
framework itself. The following explains the axxepted data
types:</p>
<ul>
<li><strong>matplotlib:</strong> Tuple (pair) of <code class="code docutils literal notranslate"><span class="pre">(Figure,</span> <span class="pre">Axes)</span></code></li>
<li><strong>bokeh:</strong> <code class="code docutils literal notranslate"><span class="pre">Figure</span></code></li>
</ul>
</li>
<li><strong>kind</strong> (<a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><em>PlotKind</em></a>) – What needs to be plotted. See <a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotKind</span></code></a> for more
info.</li>
<li><strong>backend</strong> (<a class="reference internal" href="#CBD.realtime.plotting.Backend" title="CBD.realtime.plotting.Backend"><em>Backend</em></a>) – The backend to use for plotting. Defaults to
<a class="reference internal" href="#CBD.realtime.plotting.Backend.MPL" title="CBD.realtime.plotting.Backend.MPL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Backend.MPL</span></code></a> (= matplotlib).</li>
<li><strong>interval</strong> (<em>int</em>) – Amount of milliseconds between plot refreshes.</li>
<li><strong>frames</strong> (<em>int</em>) – The amount of frames for the animation. Only used if the
animation needs to be saved.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.Backend" title="CBD.realtime.plotting.Backend"><code class="xref py py-class docutils literal notranslate"><span class="pre">Backend</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotKind</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotManager" title="CBD.realtime.plotting.PlotManager"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotManager</span></code></a></li>
</ul>
</div>
<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.signal">
<code class="descname">signal</code><span class="sig-paren">(</span><em>name</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.signal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.signal" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise a signal with a specific name and arguments.</p>
<p>The accepted signals are:</p>
<ul class="simple">
<li><code class="code docutils literal notranslate"><span class="pre">update_event(data)</span></code>: Raised whenever the plot updates. It takes the
new plot data that has been polled.</li>
<li><code class="code docutils literal notranslate"><span class="pre">close_event</span></code>: Raised whenever the plot closes. No additional arguments
are associated with this event.</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Normally, users do not need to call this function.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<em>str</em>) – The name of the signal to raise.</li>
<li><strong>*args</strong> – Additional arguments to pass to the connected events.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotHandler.connect" title="CBD.realtime.plotting.PlotHandler.connect"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotHandler.connect()</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotManager.connect" title="CBD.realtime.plotting.PlotManager.connect"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotManager.connect()</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.follow" title="CBD.realtime.plotting.follow"><code class="xref py py-func docutils literal notranslate"><span class="pre">follow()</span></code></a></li>
</ul>
</div>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.connect">
<code class="descname">connect</code><span class="sig-paren">(</span><em>name</em>, <em>function</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Connect an event with an additional function.
Useful for e.g. updating the plot axes w.r.t. the data.</p>
<p>The functions will be called in the order they were connected to the
events, with the associated arguments. The accepted signals are:</p>
<ul class="simple">
<li><code class="code docutils literal notranslate"><span class="pre">update_event(data)</span></code>: Raised whenever the plot updates. It takes the
new plot data that has been polled.</li>
<li><code class="code docutils literal notranslate"><span class="pre">close_event</span></code>: Raised whenever the plot closes. No additional arguments
are associated with this event.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<em>str</em>) – The name of the signal to raise.</li>
<li><strong>function</strong> – A function that will be called with the optional arguments
whenever the event is raised.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotHandler.signal" title="CBD.realtime.plotting.PlotHandler.signal"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotHandler.signal()</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotManager.connect" title="CBD.realtime.plotting.PlotManager.connect"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotManager.connect()</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.follow" title="CBD.realtime.plotting.follow"><code class="xref py py-func docutils literal notranslate"><span class="pre">follow()</span></code></a></li>
</ul>
</div>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.set_data_getter">
<code class="descname">set_data_getter</code><span class="sig-paren">(</span><em>function</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.set_data_getter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.set_data_getter" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the data getter function call. By default, the <code class="code docutils literal notranslate"><span class="pre">data_xy</span></code> attribute
is polled, but this function provides the flexibility to alter this behaviour.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>function</strong> – The function to obtain the data. Takes the <code class="code docutils literal notranslate"><span class="pre">object</span></code> as an
input and should return a 2xN array in the form of
<code class="code docutils literal notranslate"><span class="pre">([x1,</span> <span class="pre">x2,</span> <span class="pre">x3...],</span> <span class="pre">[y1,</span> <span class="pre">y2,</span> <span class="pre">y3...])</span></code>.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.get_data">
<code class="descname">get_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.get_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.get_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Actually gets the data from the object.</p>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.get_animation">
<code class="descname">get_animation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.get_animation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.get_animation" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the animation object, if MatPlotLib is used as a backend.</p>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.close_plot">
<code class="descname">close_plot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.close_plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.close_plot" title="Permalink to this definition">¶</a></dt>
<dd><p>Closes the plot/figure associated with this handler.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#CBD.realtime.plotting.PlotHandler.close_event" title="CBD.realtime.plotting.PlotHandler.close_event"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotHandler.close_event()</span></code></a></p>
</div>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.close_event">
<code class="descname">close_event</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.close_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.close_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Closes the plots and raises the <cite>close_event</cite> signal.</p>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.is_opened">
<code class="descname">is_opened</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.is_opened"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.is_opened" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if the plots are still open.</p>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotHandler.update">
<code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotHandler.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotHandler.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the plot information.</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="CBD.realtime.plotting.follow">
<code class="descclassname">CBD.realtime.plotting.</code><code class="descname">follow</code><span class="sig-paren">(</span><em>data</em>, <em>size</em>, <em>lower_bound=-inf</em>, <em>upper_bound=inf</em>, <em>perc_keep=0.5</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#follow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.follow" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the new limits for the given dataset if the last data point must be followed.
This is a convenience function for updating the plotting axes’ limits. Whenever not
enough data is available, the axis won’t scale down.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>data</strong> (<em>list</em>) – The data that must be plotted on the axes. Can be a
shortened version of only the final n values (n &gt; 0).</li>
<li><strong>size</strong> (<em>float</em>) – The total size of the axis to show, even if the data
did not get there.</li>
<li><strong>lower_bound</strong> (<em>float</em>) – The lower bound of the axis, i.e. the minimal value to
show, even if the data lies outside of this interval.
Defaults to <code class="code docutils literal notranslate"><span class="pre">-float('inf')</span></code> (-infinity = no limit).</li>
<li><strong>upper_bound</strong> (<em>float</em>) – The upper bound of the axis, i.e. the maximal value to
show, even if the data lies outside of this interval.
Defaults to <code class="code docutils literal notranslate"><span class="pre">float('inf')</span></code> (infinity = no limit).</li>
<li><strong>perc_keep</strong> (<em>float</em>) – The percentage at which the final data point must be
shown. When <code class="code docutils literal notranslate"><span class="pre">0.0</span></code>, this point is the lowest value
shown. When <code class="code docutils literal notranslate"><span class="pre">1.0</span></code>, this point is the highest value
shown. Use this value to change how “centered” the last
datapoint will be. When the axis grows in a positive
direction, a value of <code class="code docutils literal notranslate"><span class="pre">0.0</span></code> will never show the
data. When growing negatively, the opposite is true:
the data will not be shown for a value of <code class="code docutils literal notranslate"><span class="pre">1.0</span></code>.
Defaults to <code class="code docutils literal notranslate"><span class="pre">0.5</span></code> (= the middle).</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition danger">
<p class="first admonition-title">Danger</p>
<ul class="last simple">
<li>The lower bound must be strictly smaller than the upper bound.</li>
<li>The size cannot be larger than the distance between the bounds.</li>
</ul>
</div>
<p class="rubric">Examples</p>
<ul class="simple">
<li>Follow a sine wave in the positive-x direction, always keeping a width of 10, in matplotlib.</li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">manager</span> <span class="o">=</span> <span class="n">PlotManager</span><span class="p">()</span>
<span class="n">manager</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s2">&quot;sin&quot;</span><span class="p">,</span> <span class="n">cbd</span><span class="o">.</span><span class="n">findBlock</span><span class="p">(</span><span class="s2">&quot;plot&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span><span class="p">),</span> <span class="n">LinePlot</span><span class="p">())</span>
<span class="n">manager</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s1">&#39;sin&#39;</span><span class="p">,</span> <span class="s1">&#39;update_event&#39;</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">d</span><span class="p">,</span> <span class="n">a</span><span class="o">=</span><span class="n">ax</span><span class="p">:</span> <span class="n">a</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">follow</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">lower_bound</span><span class="o">=</span><span class="mf">0.0</span><span class="p">)))</span>
</pre></div>
</div>
<ul class="simple">
<li>Follow a sine wave in the negative-x direction, always keeping a width of 10, in matplotlib.</li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">manager</span> <span class="o">=</span> <span class="n">PlotManager</span><span class="p">()</span>
<span class="n">manager</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s2">&quot;sin&quot;</span><span class="p">,</span> <span class="n">cbd</span><span class="o">.</span><span class="n">findBlock</span><span class="p">(</span><span class="s2">&quot;plot&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span><span class="p">),</span> <span class="n">LinePlot</span><span class="p">())</span>
<span class="n">manager</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s1">&#39;sin&#39;</span><span class="p">,</span> <span class="s1">&#39;update_event&#39;</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">d</span><span class="p">,</span> <span class="n">a</span><span class="o">=</span><span class="n">ax</span><span class="p">:</span> <span class="n">a</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">follow</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">upper_bound</span><span class="o">=</span><span class="mf">0.0</span><span class="p">)))</span>
</pre></div>
</div>
<ul class="simple">
<li>Follow a positive sine-wave, but keep a 10% margin from the right edge of the plot, in matplotlib.</li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">manager</span> <span class="o">=</span> <span class="n">PlotManager</span><span class="p">()</span>
<span class="n">manager</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s2">&quot;sin&quot;</span><span class="p">,</span> <span class="n">cbd</span><span class="o">.</span><span class="n">findBlock</span><span class="p">(</span><span class="s2">&quot;plot&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span><span class="p">),</span> <span class="n">LinePlot</span><span class="p">())</span>
<span class="n">manager</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s1">&#39;sin&#39;</span><span class="p">,</span> <span class="s1">&#39;update_event&#39;</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">d</span><span class="p">,</span> <span class="n">a</span><span class="o">=</span><span class="n">ax</span><span class="p">:</span> <span class="n">a</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="n">follow</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mf">10.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="n">perc_keep</span><span class="o">=</span><span class="mf">0.9</span><span class="p">)))</span>
</pre></div>
</div>
</dd></dl>

<dl class="class">
<dt id="CBD.realtime.plotting.PlotKind">
<em class="property">class </em><code class="descclassname">CBD.realtime.plotting.</code><code class="descname">PlotKind</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotKind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotKind" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The kind of plot that needs to be rendered. This class is an abstract superclass.</p>
<p>Not all backends provide the same functionality for plotting the same shape.
This class provides a wrapper around all those functionalities to allow for users
that they only need to change the figure information.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>*args</strong> – The arguments to add to the ‘shape’, excluding the data points.</li>
<li><strong>**kwargs</strong> – The keyword arguments to add to the ‘shape’.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.LinePlot" title="CBD.realtime.plotting.LinePlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinePlot</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.StepPlot" title="CBD.realtime.plotting.StepPlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">StepPlot</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.ScatterPlot" title="CBD.realtime.plotting.ScatterPlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScatterPlot</span></code></a></li>
<li>Information on the individual plot instances in the corresponding frameworks.</li>
</ul>
</div>
<dl class="method">
<dt id="CBD.realtime.plotting.PlotKind.is_backend">
<code class="descname">is_backend</code><span class="sig-paren">(</span><em>backend</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotKind.is_backend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotKind.is_backend" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks the backend for the plot.</p>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotKind.create">
<code class="descname">create</code><span class="sig-paren">(</span><em>figure</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotKind.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotKind.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is first created in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The ‘shape’ information that is created on the plot.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotKind.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>element</em>, <em>*data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotKind.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotKind.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is updated in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>element</strong> – The shape that was returned from the <a class="reference internal" href="#CBD.realtime.plotting.PlotKind.create" title="CBD.realtime.plotting.PlotKind.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotKind.create()</span></code></a>
method.</li>
<li><strong>*data</strong> – The data with which to update the plot.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="CBD.realtime.plotting.LinePlot">
<em class="property">class </em><code class="descclassname">CBD.realtime.plotting.</code><code class="descname">LinePlot</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#LinePlot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.LinePlot" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.realtime.plotting.PlotKind</span></code></a></p>
<p>Draws a line between all given coordinates.</p>
<dl class="docutils">
<dt>Backend Information:</dt>
<dd><ul class="first last simple">
<li><strong>matplotlib:</strong> <code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.plot()</span></code></li>
<li><strong>bokeh:</strong> <code class="xref py py-func docutils literal notranslate"><span class="pre">bokeh.plotting.Figure.line()</span></code></li>
</ul>
</dd>
</dl>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotKind</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.StepPlot" title="CBD.realtime.plotting.StepPlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">StepPlot</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.ScatterPlot" title="CBD.realtime.plotting.ScatterPlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScatterPlot</span></code></a></li>
</ul>
</div>
<dl class="method">
<dt id="CBD.realtime.plotting.LinePlot.create">
<code class="descname">create</code><span class="sig-paren">(</span><em>figure</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#LinePlot.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.LinePlot.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is first created in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The ‘shape’ information that is created on the plot.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.LinePlot.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>element</em>, <em>*data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#LinePlot.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.LinePlot.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is updated in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>element</strong> – The shape that was returned from the <a class="reference internal" href="#CBD.realtime.plotting.PlotKind.create" title="CBD.realtime.plotting.PlotKind.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotKind.create()</span></code></a>
method.</li>
<li><strong>*data</strong> – The data with which to update the plot.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="CBD.realtime.plotting.StepPlot">
<em class="property">class </em><code class="descclassname">CBD.realtime.plotting.</code><code class="descname">StepPlot</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#StepPlot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.StepPlot" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.realtime.plotting.PlotKind</span></code></a></p>
<p>Draws a stepped line between all given coordinates.
See the corresponding backend information to change the step “levels”.</p>
<dl class="docutils">
<dt>Backend Information:</dt>
<dd><ul class="first last simple">
<li><strong>matplotlib:</strong> <code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.step()</span></code></li>
<li><strong>bokeh:</strong> <code class="xref py py-func docutils literal notranslate"><span class="pre">bokeh.plotting.Figure.step()</span></code></li>
</ul>
</dd>
</dl>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotKind</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.LinePlot" title="CBD.realtime.plotting.LinePlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinePlot</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.StepPlot" title="CBD.realtime.plotting.StepPlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">StepPlot</span></code></a></li>
</ul>
</div>
<dl class="method">
<dt id="CBD.realtime.plotting.StepPlot.create">
<code class="descname">create</code><span class="sig-paren">(</span><em>figure</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#StepPlot.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.StepPlot.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is first created in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The ‘shape’ information that is created on the plot.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.StepPlot.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>element</em>, <em>*data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#StepPlot.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.StepPlot.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is updated in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>element</strong> – The shape that was returned from the <a class="reference internal" href="#CBD.realtime.plotting.PlotKind.create" title="CBD.realtime.plotting.PlotKind.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotKind.create()</span></code></a>
method.</li>
<li><strong>*data</strong> – The data with which to update the plot.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="CBD.realtime.plotting.ScatterPlot">
<em class="property">class </em><code class="descclassname">CBD.realtime.plotting.</code><code class="descname">ScatterPlot</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#ScatterPlot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.ScatterPlot" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.realtime.plotting.PlotKind</span></code></a></p>
<p>Draws all given coordinates as points in a 2D space.
See the corresponding backend information to change the shape of the indicators.</p>
<dl class="docutils">
<dt>Backend Information:</dt>
<dd><ul class="first last simple">
<li><strong>matplotlib:</strong> <code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.scatter()</span></code></li>
<li><strong>bokeh:</strong> <code class="xref py py-func docutils literal notranslate"><span class="pre">bokeh.plotting.Figure.scatter()</span></code></li>
</ul>
</dd>
</dl>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotKind</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.LinePlot" title="CBD.realtime.plotting.LinePlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinePlot</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.StepPlot" title="CBD.realtime.plotting.StepPlot"><code class="xref py py-class docutils literal notranslate"><span class="pre">StepPlot</span></code></a></li>
</ul>
</div>
<dl class="method">
<dt id="CBD.realtime.plotting.ScatterPlot.create">
<code class="descname">create</code><span class="sig-paren">(</span><em>figure</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#ScatterPlot.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.ScatterPlot.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is first created in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The ‘shape’ information that is created on the plot.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.ScatterPlot.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>element</em>, <em>*data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#ScatterPlot.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.ScatterPlot.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the figure is updated in the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>element</strong> – The shape that was returned from the <a class="reference internal" href="#CBD.realtime.plotting.PlotKind.create" title="CBD.realtime.plotting.PlotKind.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotKind.create()</span></code></a>
method.</li>
<li><strong>*data</strong> – The data with which to update the plot.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="CBD.realtime.plotting.PlotManager">
<em class="property">class </em><code class="descclassname">CBD.realtime.plotting.</code><code class="descname">PlotManager</code><span class="sig-paren">(</span><em>backend=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Manages multiple <a class="reference internal" href="#CBD.realtime.plotting.PlotHandler" title="CBD.realtime.plotting.PlotHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotHandler</span></code></a> instances.
Use this class as a centralized unit to manage one or more plots in the system.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>backend</strong> (<a class="reference internal" href="#CBD.realtime.plotting.Backend" title="CBD.realtime.plotting.Backend"><em>Backend</em></a>) – The backend to use.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AssertionError</span></code> – if the backend cannot be located.</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.Backend" title="CBD.realtime.plotting.Backend"><code class="xref py py-class docutils literal notranslate"><span class="pre">Backend</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotHandler" title="CBD.realtime.plotting.PlotHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotHandler</span></code></a></li>
</ul>
</div>
<dl class="method">
<dt id="CBD.realtime.plotting.PlotManager.is_opened">
<code class="descname">is_opened</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotManager.is_opened"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotManager.is_opened" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if there is at least a single plot left open.</p>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotManager.all_opened">
<code class="descname">all_opened</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotManager.all_opened"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotManager.all_opened" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if all plots are still open.</p>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotManager.register">
<code class="descname">register</code><span class="sig-paren">(</span><em>name</em>, <em>object</em>, <em>figure</em>, <em>kind</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotManager.register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotManager.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a single <a class="reference internal" href="#CBD.realtime.plotting.PlotHandler" title="CBD.realtime.plotting.PlotHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotHandler</span></code></a> to plot information.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<em>str</em>) – The name for this handler. Will be used to optionally
access it afterwards.</li>
<li><strong>object</strong> (<em>Any</em>) – The object from which data needs to be polled. By default,
the <code class="code docutils literal notranslate"><span class="pre">data_xy</span></code> attribute will be used on the object,
which should result in a 2xN array in the form of
<code class="code docutils literal notranslate"><span class="pre">([x1,</span> <span class="pre">x2,</span> <span class="pre">x3...],</span> <span class="pre">[y1,</span> <span class="pre">y2,</span> <span class="pre">y3...])</span></code>.</li>
<li><strong>figure</strong> – The figure object required for plotting. This has been made
externally to allow for full manipulation of the plotting
framework itself.</li>
<li><strong>kind</strong> (<a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><em>PlotKind</em></a>) – What needs to be plotted. See <a class="reference internal" href="#CBD.realtime.plotting.PlotKind" title="CBD.realtime.plotting.PlotKind"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotKind</span></code></a> for more
info.</li>
<li><strong>**kwargs</strong> – Additional arguments to pass to the <a class="reference internal" href="#CBD.realtime.plotting.PlotHandler" title="CBD.realtime.plotting.PlotHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotHandler</span></code></a>
constructor.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#CBD.realtime.plotting.PlotHandler" title="CBD.realtime.plotting.PlotHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotHandler</span></code></a></p>
</div>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotManager.unregister">
<code class="descname">unregister</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotManager.unregister"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotManager.unregister" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a single <a class="reference internal" href="#CBD.realtime.plotting.PlotHandler" title="CBD.realtime.plotting.PlotHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotHandler</span></code></a> from the manager.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>str</em>) – The identifying name for the handler.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotManager.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotManager.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotManager.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtains a single <a class="reference internal" href="#CBD.realtime.plotting.PlotHandler" title="CBD.realtime.plotting.PlotHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlotHandler</span></code></a>, given its name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>str</em>) – The identifying name for the handler to obtain.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="CBD.realtime.plotting.PlotManager.connect">
<code class="descname">connect</code><span class="sig-paren">(</span><em>handler_name</em>, <em>event_name</em>, <em>function</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#PlotManager.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.PlotManager.connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Connect an event to a specific handler.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>handler_name</strong> (<em>str</em>) – The identifying name for the handler.</li>
<li><strong>event_name</strong> (<em>str</em>) – The name for the event.</li>
<li><strong>function</strong> – A function to execute whenever the event is raised.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotHandler.connect" title="CBD.realtime.plotting.PlotHandler.connect"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotHandler.connect()</span></code></a></li>
<li><a class="reference internal" href="#CBD.realtime.plotting.PlotHandler.signal" title="CBD.realtime.plotting.PlotHandler.signal"><code class="xref py py-func docutils literal notranslate"><span class="pre">PlotHandler.signal()</span></code></a></li>
</ul>
</div>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="CBD.realtime.plotting.mpl">
<code class="descclassname">CBD.realtime.plotting.</code><code class="descname">mpl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#mpl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.mpl" title="Permalink to this definition">¶</a></dt>
<dd><p>Example usage for a matplotlib backend.</p>
</dd></dl>

<dl class="function">
<dt id="CBD.realtime.plotting.bkh">
<code class="descclassname">CBD.realtime.plotting.</code><code class="descname">bkh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/plotting.html#bkh"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.plotting.bkh" title="Permalink to this definition">¶</a></dt>
<dd><p>Example usage for a bokeh backend.</p>
</dd></dl>

</div>


             </article>
             
            </div>
            <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="CBD.realtime.threadingBackend.html" class="btn btn-neutral float-right" title="CBD.realtime.threadingBackend module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
      
      
        <a href="CBD.realtime.accurate_time.html" class="btn btn-neutral" title="CBD.realtime.accurate_time module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
      
    </div>
  

  <hr>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Randy Paredis.

    </p>
  </div>
    
      <div>
        Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
      </div>
     

</footer>

          </div>
        </div>

        <div class="catalyst-content-right" id="catalyst-content-right">
          <div class="catalyst-right-menu" id="catalyst-right-menu">
            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
              <ul>
<li><a class="reference internal" href="#">CBD.realtime.plotting module</a></li>
</ul>

            </div>
          </div>
        </div>
      </section>
    </div>

  
       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
         <script type="text/javascript" src="_static/jquery.js"></script>
         <script type="text/javascript" src="_static/underscore.js"></script>
         <script type="text/javascript" src="_static/doctools.js"></script>
         <script type="text/javascript" src="_static/language_data.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     

  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
  <script type="text/javascript" src="_static/js/theme.js"></script>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

  <!-- Begin Footer -->

  <footer class="site-footer" id="site-footer">
    <div class="container footer-container">
      <div class="footer-logo-wrapper">
        <a href="https://catalyst-team.com/" class="footer-logo"></a>
      </div>

      <div class="footer-links-wrapper">
        <div class="footer-links-col">
          <ul>
            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
          </ul>
        </div>

        <div class="footer-links-col">
          <ul>
            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
          </ul>
        </div>

        <div class="footer-links-col">
          <ul>
            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
          </ul>
        </div>

        <div class="footer-links-col follow-us-col">
          <div class="footer-social-icons">
            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
          </div>
        </div>
      </div>
    </div>
  </footer>


  <!-- End Footer -->

  <!-- Begin Mobile Menu -->

  <div class="mobile-main-menu">
    <div class="container-fluid">
      <div class="container">
        <div class="mobile-main-menu-header-container">
          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
        </div>
      </div>
    </div>

    <div class="mobile-main-menu-links-container">
      <div class="main-menu">
        <ul>
          <li>
            <a href="">Get Started</a>
          </li>

          <li>
            <a href="https://github.com/catalyst-team/catalyst">Github</a>
          </li>
        </ul>
      </div>
    </div>
  </div>

  <!-- End Mobile Menu -->

  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>

  <script type="text/javascript">
    $(document).ready(function() {
      mobileMenu.bind();
      mobileTOC.bind();
      catalystAnchors.bind();
      sideMenus.bind();
      scrollToAnchor.bind();
      highlightNavigation.bind();
      mainMenuDropdown.bind();

      // Add class to links that have code blocks, since we cannot create links in code blocks
      $("article.catalyst-article a span.pre").each(function(e) {
        $(this).closest("a").addClass("has-code");
      });
    })
  </script>
</body>
</html>