cv-analysis-service/docs/build/json/modules/cv_analysis.utils.structures.fjson

{
    "body": "<section id=\"module-cv_analysis.utils.structures\">\n<span id=\"cv-analysis-utils-structures-module\"></span><h1>cv_analysis.utils.structures module<a class=\"headerlink\" href=\"#module-cv_analysis.utils.structures\" title=\"Link to this heading\">#</a></h1>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Contour\">\n<em class=\"property\"><span class=\"pre\">class</span><span class=\"w\"> </span></em><span class=\"sig-prename descclassname\"><span class=\"pre\">cv_analysis.utils.structures.</span></span><span class=\"sig-name descname\"><span class=\"pre\">Contour</span></span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Contour\" title=\"Link to this definition\">#</a></dt>\n<dd><p>Bases: <code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">object</span></code></p>\n</dd></dl>\n\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle\">\n<em class=\"property\"><span class=\"pre\">class</span><span class=\"w\"> </span></em><span class=\"sig-prename descclassname\"><span class=\"pre\">cv_analysis.utils.structures.</span></span><span class=\"sig-name descname\"><span class=\"pre\">Rectangle</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">x1</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">None</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">y1</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">None</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">w</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">None</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">h</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">None</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">x2</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">None</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">y2</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">None</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">indent</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">4</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">format</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">'xywh'</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">discrete</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">True</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle\" title=\"Link to this definition\">#</a></dt>\n<dd><p>Bases: <code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">object</span></code></p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.adjacent\">\n<span class=\"sig-name descname\"><span class=\"pre\">adjacent</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">rect2</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle\" title=\"cv_analysis.utils.structures.Rectangle\"><span class=\"pre\">Rectangle</span></a></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">tolerance</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">7</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.adjacent\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.area\">\n<span class=\"sig-name descname\"><span class=\"pre\">area</span></span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.area\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.from_dict_xywh\">\n<em class=\"property\"><span class=\"pre\">classmethod</span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">from_dict_xywh</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">xywh_dict</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">discrete</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">True</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.from_dict_xywh\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.from_xywh\">\n<em class=\"property\"><span class=\"pre\">classmethod</span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">from_xywh</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">xywh_tuple</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">discrete</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">True</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.from_xywh\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.from_xyxy\">\n<em class=\"property\"><span class=\"pre\">classmethod</span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">from_xyxy</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">xyxy_tuple</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">discrete</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">True</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.from_xyxy\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.includes\">\n<span class=\"sig-name descname\"><span class=\"pre\">includes</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">other</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle\" title=\"cv_analysis.utils.structures.Rectangle\"><span class=\"pre\">Rectangle</span></a></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">tol</span></span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"default_value\"><span class=\"pre\">3</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.includes\" title=\"Link to this definition\">#</a></dt>\n<dd><p>does a include b?</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.intersection\">\n<span class=\"sig-name descname\"><span class=\"pre\">intersection</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">rect</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.intersection\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.iou\">\n<span class=\"sig-name descname\"><span class=\"pre\">iou</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">rect</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.iou\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.is_included\">\n<span class=\"sig-name descname\"><span class=\"pre\">is_included</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">rectangles</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">Iterable</span><span class=\"p\"><span class=\"pre\">[</span></span><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle\" title=\"cv_analysis.utils.structures.Rectangle\"><span class=\"pre\">Rectangle</span></a><span class=\"p\"><span class=\"pre\">]</span></span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.is_included\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.json\">\n<span class=\"sig-name descname\"><span class=\"pre\">json</span></span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.json\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.json_full\">\n<span class=\"sig-name descname\"><span class=\"pre\">json_full</span></span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.json_full\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.json_xywh\">\n<span class=\"sig-name descname\"><span class=\"pre\">json_xywh</span></span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.json_xywh\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.json_xyxy\">\n<span class=\"sig-name descname\"><span class=\"pre\">json_xyxy</span></span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.json_xyxy\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.xywh\">\n<span class=\"sig-name descname\"><span class=\"pre\">xywh</span></span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.xywh\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.structures.Rectangle.xyxy\">\n<span class=\"sig-name descname\"><span class=\"pre\">xyxy</span></span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.structures.Rectangle.xyxy\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n</dd></dl>\n\n</section>\n",
    "title": "cv_analysis.utils.structures module",
    "sourcename": "modules/cv_analysis.utils.structures.rst.txt",
    "current_page_name": "modules/cv_analysis.utils.structures",
    "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">cv_analysis.utils.structures module</a><ul>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Contour\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Contour</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle</span></code></a><ul>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.adjacent\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.adjacent()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.area\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.area()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.from_dict_xywh\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.from_dict_xywh()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.from_xywh\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.from_xywh()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.from_xyxy\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.from_xyxy()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.includes\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.includes()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.intersection\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.intersection()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.iou\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.iou()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.is_included\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.is_included()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.json\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.json()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.json_full\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.json_full()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.json_xywh\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.json_xywh()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.json_xyxy\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.json_xyxy()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.xywh\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.xywh()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.structures.Rectangle.xyxy\"><code class=\"docutils literal notranslate\"><span class=\"pre\">Rectangle.xyxy()</span></code></a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n",
    "page_source_suffix": ".rst"
}