Files
displayarray/docs/displayarray_bash/index.html

158 lines
5.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>displayarray cli &#8212; DisplayArray documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex/" />
<link rel="search" title="Search" href="../search/" />
<link rel="prev" title="displayarray.input" href="../input/" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-displayarray.__main__">
<span id="displayarray-cli"></span><h1>displayarray cli<a class="headerlink" href="#module-displayarray.__main__" title="Permalink to this headline"></a></h1>
<p>DisplayArray.</p>
<p>Display NumPy arrays.</p>
<dl>
<dt>Usage:</dt><dd><p>displayarray (-w &lt;webcam-number&gt; | -v &lt;video-filename&gt; | -t &lt;topic-name&gt;[,dtype])… [-m &lt;msg-backend&gt;]
displayarray -h
displayarray version</p>
</dd>
<dt>Options:</dt><dd><dl class="option-list">
<dt><kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></dt>
<dd><p>Show this help text.</p>
</dd>
<dt><kbd><span class="option">--version</span></kbd></dt>
<dd><p>Show version number.</p>
</dd>
<dt><kbd><span class="option">-w <var>&lt;webcam-number&gt;</var></span>, <span class="option">--webcam=<var>&lt;webcam-number&gt;</var></span></kbd></dt>
<dd><p>Display video from a webcam.</p>
</dd>
<dt><kbd><span class="option">-v <var>&lt;video-filename&gt;</var></span>, <span class="option">--video=<var>&lt;video-filename&gt;</var></span></kbd></dt>
<dd><p>Display frames from a video file.</p>
</dd>
<dt><kbd><span class="option">-t <var>&lt;topic-name&gt;</var></span>, <span class="option">--topic=<var>&lt;topic-name&gt;</var></span></kbd></dt>
<dd><p>Display frames from a topic using the chosen message broker.</p>
</dd>
<dt><kbd><span class="option">-m <var>&lt;msg-backend&gt;</var></span>, <span class="option">--message-backend <var>&lt;msg-backend&gt;</var></span></kbd></dt>
<dd><p>Choose message broker backend. [Default: ROS]
Currently supported: ROS, ZeroMQ</p>
</dd>
<dt><kbd><span class="option">--ros</span></kbd></dt>
<dd><p>Use ROS as the backend message broker.</p>
</dd>
<dt><kbd><span class="option">--zeromq</span></kbd></dt>
<dd><p>Use ZeroMQ as the backend message broker.</p>
</dd>
</dl>
</dd>
</dl>
<dl class="function">
<dt id="displayarray.__main__.main">
<code class="sig-name descname">main</code><span class="sig-paren">(</span><em class="sig-param">argv=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/displayarray/__main__/#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#displayarray.__main__.main" title="Permalink to this definition"></a></dt>
<dd><p>Process command line arguments.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../">DisplayArray</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Python API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../displayarray/">displayarray</a></li>
<li class="toctree-l1"><a class="reference internal" href="../crop/">displayarray.effects.crop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lens/">displayarray.effects.lens</a></li>
<li class="toctree-l1"><a class="reference internal" href="../select_channels/">displayarray.effects.select_channels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../frame/">displayarray.frame</a></li>
<li class="toctree-l1"><a class="reference internal" href="../window/">displayarray.window</a></li>
<li class="toctree-l1"><a class="reference internal" href="../input/">displayarray.input</a></li>
</ul>
<p class="caption"><span class="caption-text">Bash API</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">displayarray</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../">Documentation overview</a><ul>
<li>Previous: <a href="../input/" title="previous chapter">displayarray.input</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search/" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, Simulator Leek.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/displayarray_bash.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>