Docs usage

DanielPollithy · Jun 23, 2019 · 56318e5 · 56318e5
1 parent f17a11b
commit 56318e5
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 1 deletion.
diff --git a/docs/.nojekyll → .nojekyll b/docs/.nojekyll → .nojekyll
diff --git a/doc/usage.rst b/doc/usage.rst
@@ -5,3 +5,14 @@ Usage
 To use pypcd in a project::
 
     import pypcd
+
+    # also can read from file handles.
+    pc = pypcd.PointCloud.from_path('foo.pcd')
+    # pc.pc_data has the data as a structured array
+    # pc.fields, pc.count, etc have the metadata
+
+    # center the x field
+    pc.pc_data['x'] -= pc.pc_data['x'].mean()
+
+    # save as binary compressed
+    pc.save_pcd('bar.pcd', compression='binary_compressed')
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/usage.doctree b/docs/doctrees/usage.doctree
diff --git a/docs/html/_sources/usage.rst.txt b/docs/html/_sources/usage.rst.txt
@@ -5,3 +5,14 @@ Usage
 To use pypcd in a project::
 
     import pypcd
+
+    # also can read from file handles.
+    pc = pypcd.PointCloud.from_path('foo.pcd')
+    # pc.pc_data has the data as a structured array
+    # pc.fields, pc.count, etc have the metadata
+
+    # center the x field
+    pc.pc_data['x'] -= pc.pc_data['x'].mean()
+
+    # save as binary compressed
+    pc.save_pcd('bar.pcd', compression='binary_compressed')
diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js
diff --git a/docs/html/usage.html b/docs/html/usage.html
@@ -37,6 +37,17 @@
 <h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
 <p>To use pypcd in a project:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pypcd</span>
+
+<span class="c1"># also can read from file handles.</span>
+<span class="n">pc</span> <span class="o">=</span> <span class="n">pypcd</span><span class="o">.</span><span class="n">PointCloud</span><span class="o">.</span><span class="n">from_path</span><span class="p">(</span><span class="s1">&#39;foo.pcd&#39;</span><span class="p">)</span>
+<span class="c1"># pc.pc_data has the data as a structured array</span>
+<span class="c1"># pc.fields, pc.count, etc have the metadata</span>
+
+<span class="c1"># center the x field</span>
+<span class="n">pc</span><span class="o">.</span><span class="n">pc_data</span><span class="p">[</span><span class="s1">&#39;x&#39;</span><span class="p">]</span> <span class="o">-=</span> <span class="n">pc</span><span class="o">.</span><span class="n">pc_data</span><span class="p">[</span><span class="s1">&#39;x&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span>
+
+<span class="c1"># save as binary compressed</span>
+<span class="n">pc</span><span class="o">.</span><span class="n">save_pcd</span><span class="p">(</span><span class="s1">&#39;bar.pcd&#39;</span><span class="p">,</span> <span class="n">compression</span><span class="o">=</span><span class="s1">&#39;binary_compressed&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
 </div>