Home Explore Help
Sign In
rparedis
/
PythonDEVS-BBL
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 1b455b4ccd
Branches Tags
PythonDEVS-BBL
/
docs
/
_build
/
html
/
_modules
/
pypdevsbbl
/
tracers
/
PlotTracer.html

PlotTracer.html 18 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9. 

  9.     <title>pypdevsbbl.tracers.PlotTracer &#8212; Python(P)DEVS-BBL  documentation</title>
    10. 

  10.     <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
    13. 

  13.     <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
    14. 

  14.     <script type="text/javascript" src="../../../_static/jquery.js"></script>
    15. 

  15.     <script type="text/javascript" src="../../../_static/underscore.js"></script>
    16. 

  16.     <script type="text/javascript" src="../../../_static/doctools.js"></script>
    17. 

  17.     <script type="text/javascript" src="../../../_static/language_data.js"></script>
    18. 

  18.     <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>
    19. 

  19.     <link rel="index" title="Index" href="../../../genindex.html" />
    20. 

  20.     <link rel="search" title="Search" href="../../../search.html" /> 
    21. 

  21.   </head><body>
    22. 

  22.     <div class="related" role="navigation" aria-label="related navigation">
    23. 

  23.       <h3>Navigation</h3>
    24. 

  24.       <ul>
    25. 

  25.         <li class="right" style="margin-right: 10px">
    26. 

  26.           <a href="../../../genindex.html" title="General Index"
    27. 

  27.              accesskey="I">index</a></li>
    28. 

  28.         <li class="right" >
    29. 

  29.           <a href="../../../py-modindex.html" title="Python Module Index"
    30. 

  30.              >modules</a> |</li>
    31. 

  31.         <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
    32. 

  32.           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
    33. 

  33.           <li class="nav-item nav-item-2"><a href="../tracers.html" accesskey="U">pypdevsbbl.tracers</a> &#187;</li> 
    34. 

  34.       </ul>
    35. 

  35.     </div>  
    36. 

  36. 

  37.     <div class="document">
    38. 

  38.       <div class="documentwrapper">
    39. 

  39.         <div class="bodywrapper">
    40. 

  40.           <div class="body" role="main">
    41. 

  41.             
    42. 

  42.   <h1>Source code for pypdevsbbl.tracers.PlotTracer</h1><div class="highlight"><pre>
    43. 

  43. <span></span><span class="c1">#  Copyright 2020 Modelling, Simulation and Design Lab (MSDL) at</span>
    44. 

  44. <span class="c1">#  McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)</span>
    45. 

  45. <span class="c1">#</span>
    46. 

  46. <span class="c1">#  Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
    47. 

  47. <span class="c1">#  you may not use this file except in compliance with the License.</span>
    48. 

  48. <span class="c1">#  You may obtain a copy of the License at</span>
    49. 

  49. <span class="c1">#</span>
    50. 

  50. <span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
    51. 

  51. <span class="c1">#</span>
    52. 

  52. <span class="c1">#  Unless required by applicable law or agreed to in writing, software</span>
    53. 

  53. <span class="c1">#  distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
    54. 

  54. <span class="c1">#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
    55. 

  55. <span class="c1">#  See the License for the specific language governing permissions and</span>
    56. 

  56. <span class="c1">#  limitations under the License.</span>
    57. 

  57. 

  58. <span class="sd">&quot;&quot;&quot;This file contains the tracer that can provide plots of the :mod:`pypdevsbbl.generic.collectors`.&quot;&quot;&quot;</span>
    59. 

  59. 

  60. <span class="kn">from</span> <span class="nn">pypdevsbbl.generic.collectors</span> <span class="k">import</span> <span class="n">BaseCollector</span>
    61. 

  61. <span class="kn">from</span> <span class="nn">pypdevsbbl.tracers</span> <span class="k">import</span> <span class="n">BaseTracer</span>
    62. 

  62. 

  63. <span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
    64. 

  64. <span class="kn">import</span> <span class="nn">inspect</span>
    65. 

  65. 

  66. 

  67. <div class="viewcode-block" id="PlotTracer"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.PlotTracer.html#pypdevsbbl.tracers.PlotTracer.PlotTracer">[docs]</a><span class="k">class</span> <span class="nc">PlotTracer</span><span class="p">(</span><span class="n">BaseTracer</span><span class="p">):</span>
    68. 

  68.     <span class="sd">&quot;&quot;&quot;Plots data from the provided collectors.</span>
    69. 

  69. 

  70. <span class="sd">    Note:</span>
    71. 

  71. <span class="sd">        Because of how :mod:`matplotlib` and :mod:`pypdevs` work, this</span>
    72. 

  72. <span class="sd">        tracer only seems to be working within a `Jupyter` notebook.</span>
    73. 

  73. 

  74. <span class="sd">        See :file:`src/notebook/PlotTracer.ipynb` for an example on how</span>
    75. 

  75. <span class="sd">        to do this.</span>
    76. 

  76. 

  77. <span class="sd">    Args:</span>
    78. 

  78. <span class="sd">        uid:                A unique identifier for distributed simulation.</span>
    79. 

  79. <span class="sd">                            Will be set automatically.</span>
    80. 

  80. <span class="sd">        server:             The server that runs the distributed simulation.</span>
    81. 

  81. <span class="sd">                            Will be set automatically.</span>
    82. 

  82. <span class="sd">        *collectors:        The collectors to plot. This is a pair in the</span>
    83. 

  83. <span class="sd">                            form of ``(BaseCollector, Axis)`` or a triple in</span>
    84. 

  84. <span class="sd">                            the form of ``(BaseDEVS, Axis, func)``, where</span>
    85. 

  85. <span class="sd">                            ``BaseCollector`` or ``BaseDEVS`` are instances</span>
    86. 

  86. <span class="sd">                            of those classes, ``Axis`` a :class:`matplotlib.Axes`</span>
    87. 

  87. <span class="sd">                            and ``func`` a callable that takes the first two</span>
    88. 

  88. <span class="sd">                            members and plots the data on the axis.</span>
    89. 

  89. 

  90. <span class="sd">                            Additionally, the tuples/lists may be extended</span>
    91. 

  91. <span class="sd">                            with a thrird/fourth member, which is an additional</span>
    92. 

  92. <span class="sd">                            argument to pass to the plot function. What this is</span>
    93. 

  93. <span class="sd">                            for each collector is described in their docs.</span>
    94. 

  94. <span class="sd">    &quot;&quot;&quot;</span>
    95. 

  95.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uid</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="o">*</span><span class="n">collectors</span><span class="p">):</span>
    96. 

  96.         <span class="nb">super</span><span class="p">(</span><span class="n">PlotTracer</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">uid</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    97. 

  97. 

  98.         <span class="bp">self</span><span class="o">.</span><span class="n">blocks</span> <span class="o">=</span> <span class="p">{}</span>
    99. 

  99. 

  100.         <span class="k">for</span> <span class="n">ix</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">collectors</span><span class="p">)):</span>
    101. 

  101.             <span class="bp">cls</span> <span class="o">=</span> <span class="n">collectors</span><span class="p">[</span><span class="n">ix</span><span class="p">]</span>
    102. 

  102.             <span class="k">if</span> <span class="mi">2</span> <span class="o">&lt;=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="mi">4</span><span class="p">:</span>
    103. 

  103.                 <span class="n">col</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    104. 

  104.                 <span class="n">ax</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
    105. 

  105.                 <span class="n">func</span> <span class="o">=</span> <span class="n">PlotTracer</span><span class="o">.</span><span class="n">defPlot</span>
    106. 

  106.                 <span class="n">arg</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">Parameter</span><span class="o">.</span><span class="n">empty</span>
    107. 

  107.                 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
    108. 

  108.                     <span class="k">if</span> <span class="n">callable</span><span class="p">(</span><span class="bp">cls</span><span class="p">[</span><span class="mi">2</span><span class="p">]):</span>
    109. 

  109.                         <span class="n">func</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
    110. 

  110.                     <span class="k">else</span><span class="p">:</span>
    111. 

  111.                         <span class="n">arg</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
    112. 

  112.                 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
    113. 

  113.                     <span class="n">func</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
    114. 

  114.                     <span class="k">if</span> <span class="ow">not</span> <span class="n">callable</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
    115. 

  115.                         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Third argument must be callable.&quot;</span><span class="p">)</span>
    116. 

  116.                     <span class="n">arg</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
    117. 

  117. 

  118.                 <span class="bp">self</span><span class="o">.</span><span class="n">blocks</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">ax</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="n">arg</span><span class="p">))</span>
    119. 

  119.             <span class="k">else</span><span class="p">:</span>
    120. 

  120.                 <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Cannot unpack collector info. Invalid number of arguments.&quot;</span><span class="p">)</span>
    121. 

  121. 

  122. <div class="viewcode-block" id="PlotTracer.defPlot"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.PlotTracer.html#pypdevsbbl.tracers.PlotTracer.PlotTracer.defPlot">[docs]</a>    <span class="nd">@staticmethod</span>
    123. 

  123.     <span class="k">def</span> <span class="nf">defPlot</span><span class="p">(</span><span class="n">collector</span><span class="p">,</span> <span class="n">axis</span><span class="p">,</span> <span class="n">extra</span><span class="o">=</span><span class="n">inspect</span><span class="o">.</span><span class="n">Parameter</span><span class="o">.</span><span class="n">empty</span><span class="p">):</span>
    124. 

  124.         <span class="sd">&quot;&quot;&quot;Default plotting function of the collectors.&quot;&quot;&quot;</span>
    125. 

  125.         <span class="k">if</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">collector</span><span class="p">),</span> <span class="n">BaseCollector</span><span class="p">):</span>
    126. 

  126.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;No collector to plot found. Please specify a plotting function.&quot;</span><span class="p">)</span>
    127. 

  127.         <span class="n">sig</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="n">collector</span><span class="o">.</span><span class="n">plot</span><span class="p">)</span>
    128. 

  128.         <span class="n">dft</span> <span class="o">=</span> <span class="kc">None</span>
    129. 

  129.         <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">sig</span><span class="o">.</span><span class="n">parameters</span><span class="p">:</span>
    130. 

  130.             <span class="k">if</span> <span class="n">p</span> <span class="o">!=</span> <span class="s1">&#39;axis&#39;</span><span class="p">:</span>
    131. 

  131.                 <span class="n">dft</span> <span class="o">=</span> <span class="n">sig</span><span class="o">.</span><span class="n">parameters</span><span class="p">[</span><span class="n">p</span><span class="p">]</span><span class="o">.</span><span class="n">default</span>
    132. 

  132.                 <span class="k">break</span>
    133. 

  133.         <span class="k">if</span> <span class="n">extra</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">inspect</span><span class="o">.</span><span class="n">Parameter</span><span class="o">.</span><span class="n">empty</span><span class="p">:</span>
    134. 

  134.             <span class="n">dft</span> <span class="o">=</span> <span class="n">extra</span>
    135. 

  135.         <span class="n">collector</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">axis</span><span class="p">,</span> <span class="n">dft</span><span class="p">)</span></div>
    136. 

  136. 

  137. 

  138. <div class="viewcode-block" id="PlotTracer.traceExternal"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.PlotTracer.html#pypdevsbbl.tracers.PlotTracer.PlotTracer.traceExternal">[docs]</a>    <span class="k">def</span> <span class="nf">traceExternal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aDEVS</span><span class="p">):</span>
    139. 

  139.         <span class="n">dvs</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">model</span>
    140. 

  140.         <span class="k">if</span> <span class="n">dvs</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">blocks</span><span class="p">:</span>
    141. 

  141.             <span class="n">ll</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">blocks</span><span class="p">[</span><span class="n">dvs</span><span class="p">]</span>
    142. 

  142.             <span class="k">for</span> <span class="n">ax</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">ll</span><span class="p">:</span>
    143. 

  143.                 <span class="k">if</span> <span class="n">arg</span> <span class="ow">is</span> <span class="n">inspect</span><span class="o">.</span><span class="n">Parameter</span><span class="o">.</span><span class="n">empty</span><span class="p">:</span>
    144. 

  144.                     <span class="n">func</span><span class="p">(</span><span class="n">dvs</span><span class="p">,</span> <span class="n">ax</span><span class="p">)</span>
    145. 

  145.                 <span class="k">else</span><span class="p">:</span>
    146. 

  146.                     <span class="n">func</span><span class="p">(</span><span class="n">dvs</span><span class="p">,</span> <span class="n">ax</span><span class="p">,</span> <span class="n">arg</span><span class="p">)</span>
    147. 

  147.             <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span></div></div>
    148. 

  148. </pre></div>
    149. 

  149. 

  150.           </div>
    151. 

  151.         </div>
    152. 

  152.       </div>
    153. 

  153.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    154. 

  154.         <div class="sphinxsidebarwrapper">
    155. 

  155. <div id="searchbox" style="display: none" role="search">
    156. 

  156.   <h3>Quick search</h3>
    157. 

  157.     <div class="searchformwrapper">
    158. 

  158.     <form class="search" action="../../../search.html" method="get">
    159. 

  159.       <input type="text" name="q" />
    160. 

  160.       <input type="submit" value="Go" />
    161. 

  161.       <input type="hidden" name="check_keywords" value="yes" />
    162. 

  162.       <input type="hidden" name="area" value="default" />
    163. 

  163.     </form>
    164. 

  164.     </div>
    165. 

  165. </div>
    166. 

  166. <script type="text/javascript">$('#searchbox').show(0);</script>
    167. 

  167.         </div>
    168. 

  168.       </div>
    169. 

  169.       <div class="clearer"></div>
    170. 

  170.     </div>
    171. 

  171.     <div class="related" role="navigation" aria-label="related navigation">
    172. 

  172.       <h3>Navigation</h3>
    173. 

  173.       <ul>
    174. 

  174.         <li class="right" style="margin-right: 10px">
    175. 

  175.           <a href="../../../genindex.html" title="General Index"
    176. 

  176.              >index</a></li>
    177. 

  177.         <li class="right" >
    178. 

  178.           <a href="../../../py-modindex.html" title="Python Module Index"
    179. 

  179.              >modules</a> |</li>
    180. 

  180.         <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
    181. 

  181.           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
    182. 

  182.           <li class="nav-item nav-item-2"><a href="../tracers.html" >pypdevsbbl.tracers</a> &#187;</li> 
    183. 

  183.       </ul>
    184. 

  184.     </div>
    185. 

  185.     <div class="footer" role="contentinfo">
    186. 

  186.         &#169; Copyright 2020, Randy Paredis.
    187. 

  187.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    188. 

  188.     </div>
    189. 

  189.   </body>
    190. 

  190. </html>
    191.