Update documentation
This commit is contained in:
Joel Klimont
parent
64ff14b9b1
commit
75185f19b6
36 changed files with 14537 additions and 3800 deletions
172
lib/classes/Opencv.html
Normal file
172
lib/classes/Opencv.html
Normal file
|
|
@ -0,0 +1,172 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="de" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Camera und OpenCV — CompLib 0.2.3 Dokumentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script 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 src="../../_static/translations.js"></script>
|
||||
<script src="../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Stichwortverzeichnis" href="../../genindex.html" />
|
||||
<link rel="search" title="Suche" href="../../search.html" />
|
||||
<link rel="next" title="Hardware" href="../../other/hardware.html" />
|
||||
<link rel="prev" title="Double Elimination" href="DoubleElimination.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"><img src="../../_static/compair-logo-white.svg" class="logo" alt="Logo"/>
|
||||
</a>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Dokumentation durchsuchen" />
|
||||
<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="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/index.html">Erste Schritte</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../software/installation.html">Installationsanweisungen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../other/usage.html">Beispiele</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">compLib</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="Motor.html">Motoren</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Encoder.html">Encoder</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="IRSensor.html">Infrarot Sensoren</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Seeding.html">Seeding</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="DoubleElimination.html">Double Elimination</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Camera und OpenCV</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#dokumentation-des-camera-moduls">Dokumentation des Camera Moduls</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../index.html">CompLib</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="../index.html">compLib</a> »</li>
|
||||
<li>Camera und OpenCV</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../../_sources/lib/classes/Opencv.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="camera-und-opencv">
|
||||
<span id="lib-camera"></span><h1>Camera und OpenCV<a class="headerlink" href="#camera-und-opencv" title="Link zu dieser Überschrift"></a></h1>
|
||||
<div class="section" id="dokumentation-des-camera-moduls">
|
||||
<h2>Dokumentation des Camera Moduls<a class="headerlink" href="#dokumentation-des-camera-moduls" title="Link zu dieser Überschrift"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="compLib.Camera.Marker">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">compLib.Camera.</code><code class="sig-name descname">Marker</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Camera.Marker" title="Link zu dieser Definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="compLib.Camera.Camera">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">compLib.Camera.</code><code class="sig-name descname">Camera</code><a class="headerlink" href="#compLib.Camera.Camera" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="compLib.Camera.Camera.detect_markers">
|
||||
<code class="sig-name descname">detect_markers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">image</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Camera.Camera.detect_markers" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Funktion um die ArUco Marker in einem Bild zu erkennen.
|
||||
:param image: Bild, welches die Kamera aufgenommen hat.
|
||||
:return: Gibt drei Variablen zurueck. Erstens eine Liste an Postionen der „Ecken“ der erkannten Markern. Zweitens eine Liste an IDs der erkannten Markern und dritten noch Debug Informationen (diese können ignoriert werden).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="compLib.Camera.Camera.detect_markers_midpoint">
|
||||
<code class="sig-name descname">detect_markers_midpoint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">image</span></em><span class="sig-paren">)</span> → tuple<a class="headerlink" href="#compLib.Camera.Camera.detect_markers_midpoint" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Funktion um die ArUco Marker in einem Bild zu erkennen, einzuzeichnen und den Mittelpunkt der Marker auszurechnen.
|
||||
:param image: Bild, welches die Kamera aufgenommen hat.
|
||||
:return: Gibt zwei Variablen zurueck. Erstens eine Liste an „Markern“ und zweitens das Bild mit den eigezeichneten Marken.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="compLib.Camera.Camera.draw_markers">
|
||||
<code class="sig-name descname">draw_markers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">image</span></em>, <em class="sig-param"><span class="n">corners</span></em>, <em class="sig-param"><span class="n">ids</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Camera.Camera.draw_markers" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Zeichnet die erkannten Markern mit ihren IDs in das Bild.
|
||||
:param image: Original Bild, in dem die Marker erkannt wurden.
|
||||
:param corners: List der Positionen der Ecken der erkannten Marker.
|
||||
:param ids: IDs der erkannten Markern.
|
||||
:return: Neues Bild mit den eigezeichneten Markern.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="compLib.Camera.Camera.get_frame">
|
||||
<code class="sig-name descname">get_frame</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Camera.Camera.get_frame" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Die Funktion das neuste Bild, welches die Kamera aufgenommen hat zurück.
|
||||
:return: Ein „opencv image frame“</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="compLib.Camera.Camera.publish_frame">
|
||||
<code class="sig-name descname">publish_frame</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">image</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Camera.Camera.publish_frame" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Sendet das Bild, welches der Funktion übergeben wird, an den Webserver, damit es der Nutzer in seinem Browser ansehen kann.
|
||||
:param image: Opencv Bild, welches dem Nutzer angezeigt werden soll.
|
||||
:return: None</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="DoubleElimination.html" class="btn btn-neutral float-left" title="Double Elimination" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
|
||||
<a href="../../other/hardware.html" class="btn btn-neutral float-right" title="Hardware" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS).</p>
|
||||
</div>
|
||||
|
||||
Erstellt mit <a href="https://www.sphinx-doc.org/">Sphinx</a> mit einem
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in a new issue