New docs

Open-Science-Tools · Mar 16, 2017 · 6e17cad · 6e17cad
1 parent 1972b01
commit 6e17cad
Show file tree

Hide file tree

Showing 15 changed files with 917 additions and 66 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -47,9 +47,11 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="nd2reader/common.html">nd2reader.common</a></li>
+<ul><li><a href="nd2reader/artificial.html">nd2reader.artificial</a></li>
+<li><a href="nd2reader/common.html">nd2reader.common</a></li>
 <li><a href="nd2reader/exceptions.html">nd2reader.exceptions</a></li>
 <li><a href="nd2reader/label_map.html">nd2reader.label_map</a></li>
+<li><a href="nd2reader/legacy.html">nd2reader.legacy</a></li>
 <li><a href="nd2reader/parser.html">nd2reader.parser</a></li>
 <li><a href="nd2reader/raw_metadata.html">nd2reader.raw_metadata</a></li>
 <li><a href="nd2reader/reader.html">nd2reader.reader</a></li>

diff --git a/_modules/nd2reader/artificial.html b/_modules/nd2reader/artificial.html
@@ -0,0 +1,183 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title>nd2reader.artificial &#8212; nd2reader  documentation</title>
+
+    <link rel="stylesheet" href="../../_static/classic.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </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>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head>
+  <body role="document">
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">nd2reader  documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <h1>Source code for nd2reader.artificial</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;Functions to create artificial nd2 data for testing purposes</span>
+<span class="sd">&quot;&quot;&quot;</span>
+<span class="kn">import</span> <span class="nn">six</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="kn">import</span> <span class="nn">struct</span>
+
+
+<div class="viewcode-block" id="ArtificialND2"><a class="viewcode-back" href="../../nd2reader.html#nd2reader.artificial.ArtificialND2">[docs]</a><span class="k">class</span> <span class="nc">ArtificialND2</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Artificial ND2 class (for testing purposes)</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <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">file</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_fh</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="s1">&#39;wb&#39;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">write_version</span><span class="p">()</span>
+
+    <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span>
+
+    <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">traceback</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">file_handle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;The file handle to the binary file</span>
+
+<span class="sd">        Returns:</span>
+<span class="sd">            file: the file handle</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fh</span>
+
+<div class="viewcode-block" id="ArtificialND2.close"><a class="viewcode-back" href="../../nd2reader.html#nd2reader.artificial.ArtificialND2.close">[docs]</a>    <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Correctly close the file handle</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fh</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div>
+
+<div class="viewcode-block" id="ArtificialND2.write_version"><a class="viewcode-back" href="../../nd2reader.html#nd2reader.artificial.ArtificialND2.write_version">[docs]</a>    <span class="k">def</span> <span class="nf">write_version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Write file header</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="c1"># write 16 empty bytes</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_fh</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">bytearray</span><span class="p">(</span><span class="mi">16</span><span class="p">))</span>
+
+        <span class="c1"># write version info</span>
+        <span class="n">version_info</span> <span class="o">=</span> <span class="n">six</span><span class="o">.</span><span class="n">b</span><span class="p">(</span><span class="s1">&#39;ND2 FILE SIGNATURE CHUNK NAME01!Ver3.0&#39;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_fh</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">version_info</span><span class="p">)</span></div>
+
+    <span class="nd">@staticmethod</span>
+<div class="viewcode-block" id="ArtificialND2.create_label_map_bytes"><a class="viewcode-back" href="../../nd2reader.html#nd2reader.artificial.ArtificialND2.create_label_map_bytes">[docs]</a>    <span class="k">def</span> <span class="nf">create_label_map_bytes</span><span class="p">():</span>
+        <span class="sd">&quot;&quot;&quot;Construct a binary label map</span>
+
+<span class="sd">        Returns:</span>
+<span class="sd">            tuple: (binary data, dictionary data)</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">raw_text</span> <span class="o">=</span> <span class="n">six</span><span class="o">.</span><span class="n">b</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
+        <span class="n">labels</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="s1">&#39;image_attributes&#39;</span><span class="p">:</span> <span class="s2">&quot;ImageAttributesLV!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;image_text_info&#39;</span><span class="p">:</span> <span class="s2">&quot;ImageTextInfoLV!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;image_metadata&#39;</span><span class="p">:</span> <span class="s2">&quot;ImageMetadataLV!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;image_metadata_sequence&#39;</span><span class="p">:</span> <span class="s2">&quot;ImageMetadataSeqLV|0!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;image_calibration&#39;</span><span class="p">:</span> <span class="s2">&quot;ImageCalibrationLV|0!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;x_data&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|X!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;y_data&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|Y!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;z_data&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|Z!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;roi_metadata&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|RoiMetadata_v1!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;pfs_status&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|PFS_STATUS!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;pfs_offset&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|PFS_OFFSET!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;guid&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|GUIDStore!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;description&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|CustomDescriptionV1_0!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;camera_exposure_time&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|Camera_ExposureTime1!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;camera_temp&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|CameraTemp1!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;acquisition_times&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|AcqTimesCache!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;acquisition_times_2&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|AcqTimes2Cache!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;acquisition_frames&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomData|AcqFramesCache!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;lut_data&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomDataVar|LUTDataV1_0!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;grabber_settings&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomDataVar|GrabberCameraSettingsV1_0!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;custom_data&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomDataVar|CustomDataV2_0!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;app_info&#39;</span><span class="p">:</span> <span class="s2">&quot;CustomDataVar|AppInfo_V1_0!&quot;</span><span class="p">,</span>
+            <span class="s1">&#39;image_frame_0&#39;</span><span class="p">:</span> <span class="s2">&quot;ImageDataSeq|0!&quot;</span>
+        <span class="p">}</span>
+        <span class="n">data</span> <span class="o">=</span> <span class="p">{}</span>
+
+        <span class="c1"># generate random positions and lengths</span>
+        <span class="n">lengths</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">random_integers</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">999</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">labels</span><span class="p">))</span>
+        <span class="n">positions</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">subtract</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">cumsum</span><span class="p">(</span><span class="n">lengths</span><span class="p">),</span> <span class="n">lengths</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
+
+        <span class="k">for</span> <span class="n">length</span><span class="p">,</span> <span class="n">pos</span><span class="p">,</span> <span class="n">label</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">lengths</span><span class="p">,</span> <span class="n">positions</span><span class="p">,</span> <span class="n">labels</span><span class="p">):</span>
+            <span class="n">raw_text</span> <span class="o">+=</span> <span class="n">six</span><span class="o">.</span><span class="n">b</span><span class="p">(</span><span class="n">labels</span><span class="p">[</span><span class="n">label</span><span class="p">])</span>
+            <span class="n">raw_text</span> <span class="o">+=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">&#39;QQ&#39;</span><span class="p">,</span> <span class="n">pos</span><span class="p">,</span> <span class="n">length</span><span class="p">)</span>
+            <span class="n">data</span><span class="p">[</span><span class="n">label</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">pos</span><span class="p">,</span> <span class="n">length</span><span class="p">)</span>
+
+        <span class="k">return</span> <span class="n">raw_text</span><span class="p">,</span> <span class="n">data</span></div></div>
+</pre></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="../../search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">nd2reader  documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2017, Ruben Verweij.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.
+    </div>
+  </body>
+</html>