doc/sphinx/_build/html/_modules/nepi/util/plotter.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.util.plotter &mdash; NEPI 3.0 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../',
  17         VERSION:     '3.0',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
  27     <link rel="up" title="Module code" href="../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
  40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.util.plotter</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84
  85 <span class="kn">import</span> <span class="nn">logging</span>
  86 <span class="kn">import</span> <span class="nn">os</span>
  87
  88 <span class="k">try</span><span class="p">:</span>
  89     <span class="kn">import</span> <span class="nn">networkx</span>
  90 <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
  91     <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Networkx library is not installed, you will not be able to plot.&quot;</span>
  92     <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Logger</span><span class="p">(</span><span class="s">&quot;Plotter&quot;</span><span class="p">)</span>
  93     <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
  94
  95 <span class="k">try</span><span class="p">:</span>
  96     <span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="kn">as</span> <span class="nn">plt</span>
  97 <span class="k">except</span><span class="p">:</span>
  98     <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s">&quot;Matplotlib library is not installed or X11 is not enabled. &quot;</span>
  99         <span class="s">&quot;You will not be able generate PNG plots.&quot;</span><span class="p">)</span>
 100     <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Logger</span><span class="p">(</span><span class="s">&quot;Plotter&quot;</span><span class="p">)</span>
 101     <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 102
 103 <div class="viewcode-block" id="PFormats"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.plotter.PFormats">[docs]</a><span class="k">class</span> <span class="nc">PFormats</span><span class="p">:</span>
 104     <span class="n">DOT</span> <span class="o">=</span> <span class="s">&quot;dot&quot;</span>
 105     <span class="n">FIGURE</span> <span class="o">=</span> <span class="s">&quot;figure&quot;</span>
 106 </div>
 107 <div class="viewcode-block" id="ECPlotter"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.plotter.ECPlotter">[docs]</a><span class="k">class</span> <span class="nc">ECPlotter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 108 <div class="viewcode-block" id="ECPlotter.plot"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.plotter.ECPlotter.plot">[docs]</a>    <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">dirpath</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">format</span><span class="o">=</span> <span class="n">PFormats</span><span class="o">.</span><span class="n">FIGURE</span><span class="p">,</span>
 109             <span class="n">show</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
 110         <span class="n">graph</span><span class="p">,</span> <span class="n">labels</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ec2graph</span><span class="p">(</span><span class="n">ec</span><span class="p">)</span>
 111
 112         <span class="n">add_extension</span> <span class="o">=</span> <span class="bp">False</span>
 113
 114         <span class="k">if</span> <span class="ow">not</span> <span class="n">dirpath</span><span class="p">:</span>
 115             <span class="kn">import</span> <span class="nn">tempfile</span>
 116             <span class="n">dirpath</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">mkdtemp</span><span class="p">()</span>
 117
 118         <span class="n">fpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirpath</span><span class="p">,</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">_</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ec</span><span class="o">.</span><span class="n">exp_id</span><span class="p">,</span> <span class="n">ec</span><span class="o">.</span><span class="n">run_id</span><span class="p">))</span>
 119
 120         <span class="k">if</span> <span class="n">format</span> <span class="o">==</span> <span class="n">PFormats</span><span class="o">.</span><span class="n">FIGURE</span><span class="p">:</span>
 121             <span class="n">pos</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">graphviz_layout</span><span class="p">(</span><span class="n">graph</span><span class="p">,</span> <span class="n">prog</span><span class="o">=</span><span class="s">&quot;neato&quot;</span><span class="p">)</span>
 122             <span class="n">networkx</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="n">graph</span><span class="p">,</span> <span class="n">pos</span> <span class="o">=</span> <span class="n">pos</span><span class="p">,</span> <span class="n">node_color</span><span class="o">=</span><span class="s">&quot;white&quot;</span><span class="p">,</span>
 123                     <span class="n">node_size</span> <span class="o">=</span> <span class="mi">500</span><span class="p">,</span> <span class="n">with_labels</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
 124
 125             <span class="n">label</span> <span class="o">=</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">v</span><span class="p">:</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">v</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">v</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> <span class="n">labels</span><span class="o">.</span><span class="n">iteritems</span><span class="p">()))</span>
 126             <span class="n">plt</span><span class="o">.</span><span class="n">annotate</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">xy</span><span class="o">=</span><span class="p">(</span><span class="mf">0.05</span><span class="p">,</span> <span class="mf">0.95</span><span class="p">),</span> <span class="n">xycoords</span><span class="o">=</span><span class="s">&#39;axes fraction&#39;</span><span class="p">)</span>
 127
 128             <span class="n">fpath</span> <span class="o">+=</span> <span class="s">&quot;.png&quot;</span>
 129
 130             <span class="n">plt</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">fpath</span><span class="p">,</span> <span class="n">bbox_inches</span><span class="o">=</span><span class="s">&quot;tight&quot;</span><span class="p">)</span>
 131
 132             <span class="k">if</span> <span class="n">show</span><span class="p">:</span>
 133                 <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 134
 135         <span class="k">elif</span> <span class="n">format</span> <span class="o">==</span> <span class="n">PFormats</span><span class="o">.</span><span class="n">DOT</span><span class="p">:</span>
 136             <span class="n">fpath</span> <span class="o">+=</span> <span class="s">&quot;.dot&quot;</span>
 137
 138             <span class="n">networkx</span><span class="o">.</span><span class="n">write_dot</span><span class="p">(</span><span class="n">graph</span><span class="p">,</span> <span class="n">fpath</span><span class="p">)</span>
 139
 140             <span class="k">if</span> <span class="n">show</span><span class="p">:</span>
 141                 <span class="kn">import</span> <span class="nn">subprocess</span>
 142                 <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="s">&quot;dot&quot;</span><span class="p">,</span> <span class="s">&quot;-Tps&quot;</span><span class="p">,</span> <span class="n">fpath</span><span class="p">,</span> <span class="s">&quot;-o&quot;</span><span class="p">,</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">.ps&quot;</span> <span class="o">%</span> <span class="n">fpath</span><span class="p">])</span>
 143                 <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="s">&quot;evince&quot;</span><span class="p">,</span><span class="s">&quot;</span><span class="si">%s</span><span class="s">.ps&quot;</span> <span class="o">%</span> <span class="n">fpath</span><span class="p">])</span>
 144
 145         <span class="k">return</span> <span class="n">fpath</span>
 146 </div>
 147     <span class="k">def</span> <span class="nf">_ec2graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">):</span>
 148         <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">Graph</span><span class="p">(</span><span class="n">graph</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">overlap</span> <span class="o">=</span> <span class="s">&quot;false&quot;</span><span class="p">))</span>
 149
 150         <span class="n">labels</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 151         <span class="n">connections</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 152
 153         <span class="k">for</span> <span class="n">guid</span><span class="p">,</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">ec</span><span class="o">.</span><span class="n">_resources</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
 154             <span class="n">label</span> <span class="o">=</span> <span class="n">rm</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">()</span>
 155
 156             <span class="n">graph</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">guid</span><span class="p">,</span>
 157                 <span class="n">label</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%d</span><span class="s"> </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">guid</span><span class="p">,</span> <span class="n">label</span><span class="p">),</span>
 158                 <span class="n">width</span> <span class="o">=</span> <span class="mi">50</span><span class="o">/</span><span class="mf">72.0</span><span class="p">,</span> <span class="c"># 1 inch = 72 points</span>
 159                 <span class="n">height</span> <span class="o">=</span> <span class="mi">50</span><span class="o">/</span><span class="mf">72.0</span><span class="p">,</span>
 160                 <span class="n">shape</span> <span class="o">=</span> <span class="s">&quot;circle&quot;</span><span class="p">)</span>
 161
 162             <span class="n">labels</span><span class="p">[</span><span class="n">guid</span><span class="p">]</span> <span class="o">=</span> <span class="n">label</span>
 163
 164             <span class="k">for</span> <span class="n">guid2</span> <span class="ow">in</span> <span class="n">rm</span><span class="o">.</span><span class="n">connections</span><span class="p">:</span>
 165                 <span class="c"># Avoid adding a same connection twice</span>
 166                 <span class="k">if</span> <span class="p">(</span><span class="n">guid2</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">connections</span><span class="p">:</span>
 167                     <span class="n">connections</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">guid</span><span class="p">,</span> <span class="n">guid2</span><span class="p">))</span>
 168
 169         <span class="k">for</span> <span class="p">(</span><span class="n">guid1</span><span class="p">,</span> <span class="n">guid2</span><span class="p">)</span> <span class="ow">in</span> <span class="n">connections</span><span class="p">:</span>
 170             <span class="n">graph</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="n">guid1</span><span class="p">,</span> <span class="n">guid2</span><span class="p">)</span>
 171
 172         <span class="k">return</span> <span class="n">graph</span><span class="p">,</span> <span class="n">labels</span></div>
 173 </pre></div>
 174
 175           </div>
 176         </div>
 177       </div>
 178       <div class="clearer"></div>
 179     </div>
 180     <div class="related">
 181       <h3>Navigation</h3>
 182       <ul>
 183         <li class="right" style="margin-right: 10px">
 184           <a href="../../../genindex.html" title="General Index"
 185              >index</a></li>
 186         <li class="right" >
 187           <a href="../../../py-modindex.html" title="Python Module Index"
 188              >modules</a> |</li>
 189         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 190           <li><a href="../../index.html" >Module code</a> &raquo;</li>
 191       </ul>
 192     </div>
 193     <div class="footer">
 194         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 195       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 196     </div>
 197   </body>
 198 </html>