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

{
    "body": "<section id=\"module-cv_analysis.utils.annotate\">\n<span id=\"cv-analysis-utils-annotate-module\"></span><h1>cv_analysis.utils.annotate module<a class=\"headerlink\" href=\"#module-cv_analysis.utils.annotate\" title=\"Link to this heading\">#</a></h1>\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.annotate.annotate_page\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">cv_analysis.utils.annotate.</span></span><span class=\"sig-name descname\"><span class=\"pre\">annotate_page</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">page</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">Page</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">prediction</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.annotate.annotate_page\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.annotate.annotate_pdf\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">cv_analysis.utils.annotate.</span></span><span class=\"sig-name descname\"><span class=\"pre\">annotate_pdf</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">pdf</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">|</span></span><span class=\"w\"> </span><span class=\"pre\">bytes</span><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">|</span></span><span class=\"w\"> </span><span class=\"pre\">Path</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">annotations</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">output_path</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">|</span></span><span class=\"w\"> </span><span class=\"pre\">Path</span><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">|</span></span><span class=\"w\"> </span><span class=\"pre\">None</span></span><span class=\"w\"> </span><span class=\"o\"><span class=\"pre\">=</span></span><span class=\"w\"> </span><span class=\"default_value\"><span class=\"pre\">None</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.annotate.annotate_pdf\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.annotate.mirror_on_x_axis\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">cv_analysis.utils.annotate.</span></span><span class=\"sig-name descname\"><span class=\"pre\">mirror_on_x_axis</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">bbox</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">page_height</span></span></em><span class=\"sig-paren\">)</span><a class=\"headerlink\" href=\"#cv_analysis.utils.annotate.mirror_on_x_axis\" title=\"Link to this definition\">#</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"cv_analysis.utils.annotate.provide_byte_stream\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">cv_analysis.utils.annotate.</span></span><span class=\"sig-name descname\"><span class=\"pre\">provide_byte_stream</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">pdf</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">bytes</span><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">|</span></span><span class=\"w\"> </span><span class=\"pre\">Path</span><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">|</span></span><span class=\"w\"> </span><span class=\"pre\">str</span></span></em><span class=\"sig-paren\">)</span> <span class=\"sig-return\"><span class=\"sig-return-icon\">&#x2192;</span> <span class=\"sig-return-typehint\"><span class=\"pre\">None</span></span></span><a class=\"headerlink\" href=\"#cv_analysis.utils.annotate.provide_byte_stream\" title=\"Link to this definition\">#</a></dt>\n<dd><dl class=\"field-list simple\">\n<dt class=\"field-odd\">Return type<span class=\"colon\">:</span></dt>\n<dd class=\"field-odd\"><p><span class=\"sphinx_autodoc_typehints-type\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">None</span></code></span></p>\n</dd>\n</dl>\n</dd></dl>\n\n</section>\n",
    "title": "cv_analysis.utils.annotate module",
    "sourcename": "modules/cv_analysis.utils.annotate.rst.txt",
    "current_page_name": "modules/cv_analysis.utils.annotate",
    "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">cv_analysis.utils.annotate module</a><ul>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.annotate.annotate_page\"><code class=\"docutils literal notranslate\"><span class=\"pre\">annotate_page()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.annotate.annotate_pdf\"><code class=\"docutils literal notranslate\"><span class=\"pre\">annotate_pdf()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.annotate.mirror_on_x_axis\"><code class=\"docutils literal notranslate\"><span class=\"pre\">mirror_on_x_axis()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#cv_analysis.utils.annotate.provide_byte_stream\"><code class=\"docutils literal notranslate\"><span class=\"pre\">provide_byte_stream()</span></code></a></li>\n</ul>\n</li>\n</ul>\n",
    "page_source_suffix": ".rst"
}