documentation.html

<!DOCTYPE html>

<html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.0,user-scalable=no, shrink-to-fit=no">
    <meta http-equiv="x-ua-compatible" content="ie=edge">
	<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
	<link href="https://fonts.googleapis.com/css?family=Roboto:200,400,500,700" rel="stylesheet">

    
    <title>Documentation &#8212; itom</title>

    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/MDL_theme.css?v=e3b579a1" />
    <link rel="stylesheet" href="_static/MDL/material.itom.min.em.css" type="text/css" />
    <link rel="stylesheet" href="_static/AnimHeader.css" type="text/css" />
    <link rel="stylesheet" href="_static/modalPopup.css" type="text/css" />
    <script src="_static/jquery.js?v=5d32c60e"></script>
    <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
    <script src="_static/documentation_options.js?v=d0ae6d56"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/MDL/material.min.js"></script>
    <script src="_static/MDL_theme.js"></script>
    <script src="_static/AnimHeader.js"></script>
    <script src="_static/modalPopup.js"></script>
    <link rel="icon" href="_static/ITOMfavicon.ico"/>
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Plugins" href="plugins.html" />
    <link rel="prev" title="Downloads" href="download.html" /> 
  </head><body>
<!--
-->
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-header mdl-layout--fixed-drawer">
    <header class="mdl-layout__header mdl-layout__header--waterfall ">
    <div class="mdl-layout__header-row">
		
        <nav class="mdl-navigation breadcrumb">
            <a class="mdl-navigation__link is-active">Documentation</a>
        </nav>
        <div class="mdl-layout-spacer"></div>

		<a href="https://sourceforge.net/projects/itom/" target="_blank" alt="Download ITOM" class="mdl-button mdl-js-button mdl-button--raised mdl-button--accent hideSmall" style="margin-right: 20px;">
			<span class="mdl-color-text--white">Download</span>
			<i class="material-icons mdl-color-text--white">&#xe2c4</i>
		</a>

		
		<a href="plugins.html" alt="Next" class="mdl-button mdl-js-button mdl-button--icon mdl-button--raised mdl-button--accent" style="margin-right: 10px;">
			<i class="material-icons mdl-color-text--white" >&#xE5CC;</i>
		</a>
		

		<label class="mdl-button mdl-js-button mdl-button--icon mdl-button--colored">
			<a href="index.html" alt="Home">
				<i class="material-icons">home</i>
			</a>
		</label>

		<label class="mdl-button mdl-js-button mdl-button--icon mdl-button--colored">
			<a href="https://github.com/itom-project" alt="Github">
        <img src="_static/github-mark.svg" alt="GitHub" width="24" height="24" style="margin:0px 0px">
			</a>
		</label>

		
<form class="form-inline pull-sm-right" action="search.html" method="get">
      <div class="mdl-textfield mdl-js-textfield mdl-textfield--expandable mdl-textfield--floating-label mdl-textfield--align-right">
        <label class="mdl-button mdl-js-button mdl-button--icon"  for="waterfall-exp">
            <i class="material-icons">search</i>
        </label>
        <div class="mdl-textfield__expandable-holder">
          <input class="mdl-textfield__input" type="text" name="q"  id="waterfall-exp" placeholder="Search" />
          <input type="hidden" name="check_keywords" value="yes" />
          <input type="hidden" name="area" value="default" />
        </div>
      </div>
</form>

        <!-- Title -->
    </div>
	<!--
    <div class="mdl-layout__header-row header-links">
		<div class="mdl-layout-spacer"></div>
		<nav class="mdl-navigation">

	  </nav>
    </div>-->
</header>
    <header class="mdl-layout__drawer">
    
          <!-- Title -->
      <span class="mdl-layout-title">
          <a class="brand" href="index.html">
                      <img class="logo" src="_static/itomlogo.png" alt="itom"/>
          </a>
      </span>
    

        <nav class="mdl-navigation">
        <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="start.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="download.html">Downloads</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="collaboration.html">Collaboration</a></li>
</ul>

        </nav>
    

</header>

	<main class="mdl-layout__content">
	

        <div class="page-content">
            
  <section id="documentation">
<span id="sec-documentation"></span><h1>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h1>
<div class="mdl-grid">
    <div class="mdl-cell mdl-cell--4-col-desktop mdl-cell--4-col-tablet mdl-cell--12-col-phone mdl-card mdl-shadow--4dp">
         <div class="mdl-card__title mdl-card--expand mdl-color--primary"><span class="mdl-card__title-text">Get Started</span></div>
        <div class="mdl-card__supporting-text">Intro: How to setup itom</div>
        <div class="mdl-card__actions  mdl-card--border"><a href=".\start.html" class="mdl-button mdl-js-button mdl-button--fab mdl-button--mini-fab mdl-button--accent mdl-js-ripple-effect"><i class="material-icons">add</i></a></div>
    </div>
    <div class="mdl-cell mdl-cell--4-col-desktop mdl-cell--4-col-tablet mdl-cell--12-col-phone mdl-card mdl-shadow--4dp">
         <div class="mdl-card__title mdl-card--expand mdl-color--primary"><span class="mdl-card__title-text">User Docs</span></div>
        <div class="mdl-card__supporting-text">How to use itom</div>
        <div class="mdl-card__actions  mdl-card--border"><a href=".\latest\docs\index.html" target="_blank" class="mdl-button mdl-js-button mdl-button--fab mdl-button--mini-fab mdl-button--accent mdl-js-ripple-effect"><i class="material-icons">add</i></a></div>
     </div>
    <div class="mdl-cell mdl-cell--4-col-desktop mdl-cell--4-col-tablet mdl-cell--12-col-phone mdl-card mdl-shadow--4dp">
         <div class="mdl-card__title mdl-card--expand mdl-color--primary"><span class="mdl-card__title-text">Plugin Docs</span></div>
        <div class="mdl-card__supporting-text">Documentation of Plugins</div>
        <div class="mdl-card__actions  mdl-card--border"><a href=".\plugindoc\index.html" target="_blank" class="mdl-button mdl-js-button mdl-button--fab mdl-button--mini-fab mdl-button--accent mdl-js-ripple-effect"><i class="material-icons">add</i></a></div>
     </div>
    <div class="mdl-cell mdl-cell--4-col-desktop mdl-cell--4-col-tablet mdl-cell--12-col-phone mdl-card mdl-shadow--4dp">
         <div class="mdl-card__title mdl-card--expand mdl-color--primary"><span class="mdl-card__title-text">Examples</span></div>
        <div class="mdl-card__supporting-text">Exemplary application cases</div>
        <div class="mdl-card__actions  mdl-card--border"><a href=".\examples.html" class="mdl-button mdl-js-button mdl-button--fab mdl-button--mini-fab mdl-button--accent mdl-js-ripple-effect"><i class="material-icons">add</i></a></div>
     </div>
    <div class="mdl-cell mdl-cell--4-col-desktop mdl-cell--4-col-tablet mdl-cell--12-col-phone mdl-card mdl-shadow--4dp">
         <div class="mdl-card__title mdl-card--expand mdl-color--primary"><span class="mdl-card__title-text">Devs</span></div>
        <div class="mdl-card__supporting-text">Documentation of itom <b>CORE</b></div>
        <div class="mdl-card__actions  mdl-card--border"><a href=".\latest\doxygen\index.html" target="_blank" class="mdl-button mdl-js-button mdl-button--fab mdl-button--mini-fab mdl-button--accent mdl-js-ripple-effect"><i class="material-icons">add</i></a></div>
     </div>
    <div class="mdl-cell mdl-cell--4-col-desktop mdl-cell--4-col-tablet mdl-cell--12-col-phone mdl-card mdl-shadow--4dp">
         <div class="mdl-card__title mdl-card--expand mdl-color--primary"><span class="mdl-card__title-text">News</span></div>
        <div class="mdl-card__supporting-text">Changelog & Releases</div>
        <div class="mdl-card__actions  mdl-card--border"><a href="http://itom.bitbucket.io/latest/docs/00_releaseNotes/whats-new.html" target="_blank" class="mdl-button mdl-js-button mdl-button--fab mdl-button--mini-fab mdl-button--accent mdl-js-ripple-effect"><i class="material-icons">add</i></a></div>
     </div>
</div>
<hr>
<button class="accordion">Previous documentations:</button>
<div class="panel"><p>Version 4.2.0:
* <a class="reference external" href="https://itom.bitbucket.io/v4-3-0/docs">User documentation</a>
* <a class="reference external" href="https://itom.bitbucket.io/v4-3-0/doxygen">Doxygen source code documentation</a></p>
<p>Version 4.2.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v4-2-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v4-2-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 4.1.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v4-1-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v4-1-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 4.0.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v4-0-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v4-0-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 3.2.1:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-2-1/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-2-1/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 3.2.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-2-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-2-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 3.1.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-1-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-1-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 3.0.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-0-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v3-0-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 2.2.1:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-2-1/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-2-1/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 2.2.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-2-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-2-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 2.1.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-1-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-1-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 2.0.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-0-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v2-0-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 1.4.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-4-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-4-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 1.3.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-3-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-3-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 1.2.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-2-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-2-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 1.1.0:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-1-0/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-1-0/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 1.0.14:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-0-14/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-0-14/doxygen">Doxygen source code documentation</a></p></li>
</ul>
<p>Version 1.0.13:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-0-13/docs">User documentation</a></p></li>
<li><p><a class="reference external" href="https://itom.bitbucket.io/v1-0-13/doxygen">Doxygen source code documentation</a></p></li>
</ul>
</div>
<hr><section id="publications-and-presentations">
<h2>Publications and Presentations<a class="headerlink" href="#publications-and-presentations" title="Link to this heading">¶</a></h2>
<p>Here you will find presentations and posters about <strong>itom</strong>:</p>
<ul class="simple">
<li><p><a class="reference external" href="documents/itomPresentationSept2013_Fringe.pdf">Introduction to itom</a>, presented at the <a class="reference external" href="http://www.fringe13.de">Fringe 2013 conference</a>.</p></li>
<li><p><a class="reference external" href="documents/itomPosterSept2013_Fringe.pdf">Poster about itom</a>, also presented at the <a class="reference external" href="http://www.fringe13.de">Fringe 2013 conference</a>.</p></li>
<li><p><a class="reference external" href="documents/itom_cheatsheet.pdf">Cheatsheet for Python with itom</a>.</p></li>
<li><p><a class="reference external" href="documents/itomPluginProgramming2015.pdf">Presentation about the programming of plugins</a>.</p></li>
</ul>
<p>The following publications are available and can also be used as references:</p>
<ul>
<li><p>Applied Optics Journal Paper (<a class="reference external" href="http://www.opticsinfobase.org/ao/abstract.cfm?uri=ao-53-14-2974">http://www.opticsinfobase.org/ao/abstract.cfm?uri=ao-53-14-2974</a>):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">M</span><span class="o">.</span> <span class="n">Gronle</span><span class="p">,</span> <span class="n">W</span><span class="o">.</span> <span class="n">Lyda</span><span class="p">,</span> <span class="n">M</span><span class="o">.</span> <span class="n">Wilke</span><span class="p">,</span> <span class="n">C</span><span class="o">.</span> <span class="n">Kohler</span><span class="p">,</span> <span class="ow">and</span> <span class="n">W</span><span class="o">.</span> <span class="n">Osten</span><span class="p">,</span> <span class="s2">&quot;itom: an open source metrology, automation, and data evaluation software,&quot;</span> <span class="n">Appl</span><span class="o">.</span> <span class="n">Opt</span><span class="o">.</span> <span class="mi">53</span><span class="p">,</span> <span class="mi">2974</span><span class="o">-</span><span class="mi">2982</span> <span class="p">(</span><span class="mi">2014</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p>Conference Paper, Fringe 2013 (<a class="reference external" href="http://link.springer.com/chapter/10.1007/978-3-642-36359-7_181">http://link.springer.com/chapter/10.1007/978-3-642-36359-7_181</a>):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Gronle</span><span class="p">,</span> <span class="n">M</span><span class="o">.</span><span class="p">,</span> <span class="n">Kohler</span><span class="p">,</span> <span class="n">C</span><span class="o">.</span><span class="p">,</span> <span class="n">Wilke</span><span class="p">,</span> <span class="n">M</span><span class="o">.</span><span class="p">,</span> <span class="n">Lyda</span><span class="p">,</span> <span class="n">W</span><span class="o">.</span><span class="p">,</span> <span class="n">Bieger</span><span class="p">,</span> <span class="n">H</span><span class="o">.</span><span class="p">,</span> <span class="n">Osten</span><span class="p">,</span> <span class="n">W</span><span class="o">.</span><span class="p">,</span> <span class="s2">&quot;itom - An Open Source Measurement, Automation and Evaluation Software Suite&quot;</span><span class="p">,</span> <span class="ow">in</span><span class="p">:</span><span class="n">Fringe</span> <span class="mi">2013</span><span class="p">,</span> <span class="mi">957</span><span class="o">-</span><span class="mi">964</span>  <span class="p">(</span><span class="mi">2013</span><span class="p">)</span>
</pre></div>
</div>
</li>
</ul>
</section>
</section>


            <div class="pagenation">
               <a id="button-prev" href="download.html" class="mdl-button mdl-js-button mdl-button--raised mdl-js-ripple-effect mdl-button--accent" role="botton" accesskey="P">
                   <i class="material-icons">arrow_back</i>PREVIOUS
               </a>
            <div class="mdl-tooltip" data-mdl-for="button-prev">
            Downloads
            </div>
               <a id="button-next" href="plugins.html" class="mdl-button mdl-js-button mdl-button--raised mdl-js-ripple-effect mdl-button--accent" role="botton" accesskey="N">
                    NEXT <i class="material-icons">arrow_forward</i>
               </a>
            <div class="mdl-tooltip" data-mdl-for="button-next">
            Plugins
            </div>
            </div>
        </div>
        <footer class="mdl-mini-footer">
    <div class="mdl-mini-footer__right-section">
        <div>&copy; Copyright 2011-2024, Institut für Technische Optik, Universität Stuttgart.</div>
      <div>Generated by <a href="http://sphinx.pocoo.org/">Sphinx</a> 8.1.3 using <a href="https://www.getmdl.io">MDL</a></div>
	<div>This page uses <a href="http://analytics.google.com/">Google Analytics</a>.
	<script>
		(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-51395951-1', 'auto');ga('send', 'pageview');
	</script>
	</div>
    </div>
</footer>
    </main>
</div>
  </body>
</html>