<!DOCTYPE html> | |
<html class="writer-html5" lang="en" > | |
<head> | |
<meta charset="utf-8" /> | |
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
<title>Statistics — OpenPASS 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/tabs.css" type="text/css" /> | |
<link rel="stylesheet" href="../../../_static/css/custom.css" type="text/css" /> | |
<link rel="shortcut icon" href="../../../_static/openPASS.ico"/> | |
<!--[if lt IE 9]> | |
<script src="../../../_static/js/html5shiv.min.js"></script> | |
<![endif]--> | |
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> | |
<script src="../../../_static/jquery.js"></script> | |
<script src="../../../_static/underscore.js"></script> | |
<script src="../../../_static/doctools.js"></script> | |
<script type="text/javascript" src="../../../_static/js/theme.js"></script> | |
<link rel="index" title="Index" href="../../../genindex.html" /> | |
<link rel="search" title="Search" href="../../../search.html" /> | |
<link rel="next" title="TimePlot" href="20_timePlot.html" /> | |
<link rel="prev" title="Result Visualization" href="../50_result_visualization.html" /> | |
</head> | |
<body class="wy-body-for-nav"> | |
<div class="wy-grid-for-nav"> | |
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> | |
<div class="wy-side-scroll"> | |
<div class="wy-side-nav-search" > | |
<a href="../../../index.html" class="icon icon-home"> openPASS | |
<img src="../../../_static/openPASS.png" class="logo" alt="Logo"/> | |
</a> | |
<div class="version"> | |
0.8.0 | |
</div> | |
<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> | |
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | |
<p class="caption"><span class="caption-text">Installation Guide</span></p> | |
<ul> | |
<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/10_getting_started.html">Getting Started</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/50_further_guidance.html">Further Guidance</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/60_conan.html">Building with Conan</a></li> | |
</ul> | |
<p class="caption"><span class="caption-text">User Guides</span></p> | |
<ul class="current"> | |
<li class="toctree-l1"><a class="reference internal" href="../../10_overview.html">Overview</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../20_tutorials.html">Tutorials</a></li> | |
<li class="toctree-l1 current"><a class="reference internal" href="../../30_gui_plugins.html">GUI Plugins</a><ul class="current"> | |
<li class="toctree-l2"><a class="reference internal" href="../10_projects.html">Project</a></li> | |
<li class="toctree-l2"><a class="reference internal" href="../20_system_editor.html">System Editor</a></li> | |
<li class="toctree-l2"><a class="reference internal" href="../30_pcm_sim.html">PCM Simulation</a></li> | |
<li class="toctree-l2"><a class="reference internal" href="../40_pcm_eval.html">PCM Evaluation</a></li> | |
<li class="toctree-l2 current"><a class="reference internal" href="../50_result_visualization.html">Result Visualization</a><ul class="current"> | |
<li class="toctree-l3 current"><a class="current reference internal" href="#">Statistics</a><ul> | |
<li class="toctree-l4"><a class="reference internal" href="#loading-results">Loading Results</a></li> | |
<li class="toctree-l4"><a class="reference internal" href="#evaluating-results">Evaluating Results</a></li> | |
</ul> | |
</li> | |
<li class="toctree-l3"><a class="reference internal" href="20_timePlot.html">TimePlot</a></li> | |
</ul> | |
</li> | |
</ul> | |
</li> | |
<li class="toctree-l1"><a class="reference internal" href="../../40_configs_in_depth.html">Configs in Depth</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../50_outputs_in_depth.html">Outputs in Depth</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../60_scenario_simulation.html">Simulator</a></li> | |
</ul> | |
<p class="caption"><span class="caption-text">Advanced topics</span></p> | |
<ul> | |
<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> | |
</ul> | |
<p class="caption"><span class="caption-text">Developer Information</span></p> | |
<ul> | |
<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> | |
</ul> | |
<p class="caption"><span class="caption-text">Other Information</span></p> | |
<ul> | |
<li class="toctree-l1"><a class="reference internal" href="../../../other_information/10_external_dependencies.html">External Dependencies</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../other_information/20_glossary.html">Glossary</a></li> | |
<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_license.html">License</a></li> | |
</ul> | |
</div> | |
</div> | |
</nav> | |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | |
<nav class="wy-nav-top" aria-label="top navigation"> | |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> | |
<a href="../../../index.html">openPASS</a> | |
</nav> | |
<div class="wy-nav-content"> | |
<div class="rst-content"> | |
<div role="navigation" aria-label="breadcrumbs navigation"> | |
<ul class="wy-breadcrumbs"> | |
<li><a href="../../../index.html" class="icon icon-home"></a> »</li> | |
<li><a href="../../30_gui_plugins.html">GUI Plugins</a> »</li> | |
<li><a href="../50_result_visualization.html">Result Visualization</a> »</li> | |
<li>Statistics</li> | |
<li class="wy-breadcrumbs-aside"> | |
<a href="../../../_sources/user_guide/gui_user_guide/result_visualization/10_statistics.rst.txt" rel="nofollow"> View page source</a> | |
</li> | |
</ul> | |
<hr/> | |
</div> | |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | |
<div itemprop="articleBody"> | |
<div class="section" id="statistics"> | |
<span id="id1"></span><h1>Statistics<a class="headerlink" href="#statistics" title="Permalink to this headline">¶</a></h1> | |
<p>This plugin is used to calculate and show statistics and histograms from a result folder.</p> | |
<div class="section" id="loading-results"> | |
<h2>Loading Results<a class="headerlink" href="#loading-results" title="Permalink to this headline">¶</a></h2> | |
<ul class="simple"> | |
<li><p>Click <code class="docutils literal notranslate"><span class="pre">Add</span> <span class="pre">result</span> <span class="pre">folder</span></code> to choose a result folder of which the statistics shall be calculated.</p></li> | |
</ul> | |
<div class="admonition note"> | |
<p class="admonition-title">Note</p> | |
<p>It is possible to add multiple result folders.</p> | |
<blockquote> | |
<div><ul class="simple"> | |
<li><p>Subsequently selected folders are added to the list in the TreeView</p></li> | |
<li><p>Histograms will be calculated for each folder including subfolders and will be shown in a new row</p></li> | |
</ul> | |
</div></blockquote> | |
</div> | |
<img alt="../../../_images/overview3.png" src="../../../_images/overview3.png" /> | |
</div> | |
<div class="section" id="evaluating-results"> | |
<h2>Evaluating Results<a class="headerlink" href="#evaluating-results" title="Permalink to this headline">¶</a></h2> | |
<ul class="simple"> | |
<li><p>Select a result folder for showing their statistics and histograms</p></li> | |
<li><p>Histograms over a folder are shown in one (scrollable) row of images</p></li> | |
<li><p>Selecting the white background of the folder list clears the histogram preview panel</p></li> | |
<li><p>Each row of histograms contains the contents of the corresponding folder in the folder list</p></li> | |
<li><p>Adding a new folder re-calculates all histograms for each column using a common x-range</p></li> | |
</ul> | |
<div class="admonition note"> | |
<p class="admonition-title">Note</p> | |
<p>Select an input folder that contains files in the following format</p> | |
<blockquote> | |
<div><ul class="simple"> | |
<li><p>Relevant files need ending <code class="docutils literal notranslate"><span class="pre">.csv`</span></code></p></li> | |
<li><p>Columns can be separated by comma, semicolon or space</p></li> | |
<li><p>First two columns need <em>frame</em> and <em>id*</em> in header</p></li> | |
</ul> | |
</div></blockquote> | |
</div> | |
<div class="admonition warning"> | |
<p class="admonition-title">Warning</p> | |
<p>For all files in a selected folder and subfolders the headers are read in</p> | |
<blockquote> | |
<div><ul class="simple"> | |
<li><p>All of these files consistent with the first read header are used to calculate histograms for all columns</p></li> | |
<li><p>Files with non-consistent headers are ignored</p></li> | |
</ul> | |
</div></blockquote> | |
</div> | |
<img alt="../../../_images/select3.png" src="../../../_images/select3.png" /> | |
</div> | |
</div> | |
</div> | |
</div> | |
<footer> | |
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | |
<a href="20_timePlot.html" class="btn btn-neutral float-right" title="TimePlot" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | |
<a href="../50_result_visualization.html" class="btn btn-neutral float-left" title="Result Visualization" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | |
</div> | |
<hr/> | |
<div role="contentinfo"> | |
<p> | |
© Copyright 2021 OpenPASS Working Group. | |
</p> | |
</div> | |
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a | |
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> | |
provided by <a href="https://readthedocs.org">Read the Docs</a>. | |
</footer> | |
</div> | |
</div> | |
</section> | |
</div> | |
<script type="text/javascript"> | |
jQuery(function () { | |
SphinxRtdTheme.Navigation.enable(true); | |
}); | |
</script> | |
</body> | |
</html> |