AnalyseMorphologique/BuildedDocs/html/generated/utils.files.input.html
2023-05-17 10:21:41 +02:00

139 lines
6.4 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>utils.files.input &mdash; Analyse Morphologique 1.2.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.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" class="icon icon-home">
Analyse Morphologique
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<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>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html">API</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">Analyse Morphologique</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" aria-label="Home"></a></li>
<li class="breadcrumb-item active">utils.files.input</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/generated/utils.files.input.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-utils.files.input">
<span id="utils-files-input"></span><h1>utils.files.input<a class="headerlink" href="#module-utils.files.input" title="Permalink to this heading"></a></h1>
<p>Created on Thu Apr 20 2023
&#64;name: input.py
&#64;desc: This module contains the functions to parse the input files, and create a ScannedObject.
&#64;auth: Djalim Simaila
&#64;e-mail: <a class="reference external" href="mailto:djalim&#46;simaila&#37;&#52;&#48;inrae&#46;fr">djalim<span>&#46;</span>simaila<span>&#64;</span>inrae<span>&#46;</span>fr</a></p>
<p class="rubric">Functions</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../_autosummary/utils.files.input.parse_result_file.html#utils.files.input.parse_result_file" title="utils.files.input.parse_result_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parse_result_file</span></code></a>(file_path[, separator])</p></td>
<td><p>This functions parses the discretised output file to retreive the first three colunms.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Classes</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../_autosummary/utils.files.input.ScannedObject.html#utils.files.input.ScannedObject" title="utils.files.input.ScannedObject"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScannedObject</span></code></a>(vertices[, faces])</p></td>
<td><p>This class is used to manage the data of the 3D object.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Exceptions</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../_autosummary/utils.files.input.FacesNotGiven.html#utils.files.input.FacesNotGiven" title="utils.files.input.FacesNotGiven"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FacesNotGiven</span></code></a></p></td>
<td><p>Exception raised when no faces was given.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../_autosummary/utils.files.input.InvalidFileFormat.html#utils.files.input.InvalidFileFormat" title="utils.files.input.InvalidFileFormat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InvalidFileFormat</span></code></a></p></td>
<td><p>Exception raised when the file format is not supported.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../_autosummary/utils.files.input.ResultFileNotGiven.html#utils.files.input.ResultFileNotGiven" title="utils.files.input.ResultFileNotGiven"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResultFileNotGiven</span></code></a></p></td>
<td><p>Exception raised when no faces was given.</p></td>
</tr>
</tbody>
</table>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Djalim SIMAILA, Alexis DOGHMANE.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>