538 lines
44 KiB
HTML
538 lines
44 KiB
HTML
<!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.ScannedObject — 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" />
|
||
<link rel="next" title="utils.files.input.FacesNotGiven" href="utils.files.input.FacesNotGiven.html" />
|
||
<link rel="prev" title="utils.files.input.parse_result_file" href="utils.files.input.parse_result_file.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 class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="utils.html">utils</a><ul class="current">
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.create_xyz.html">utils.create_xyz</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.data_processing.html">utils.data_processing</a></li>
|
||
<li class="toctree-l3 current"><a class="reference internal" href="utils.files.html">utils.files</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="utils.files.input.html">utils.files.input</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="utils.files.norm.html">utils.files.norm</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="utils.files.output.html">utils.files.output</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.graph2D.html">utils.graph2D</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.graph3D.html">utils.graph3D</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.gui.html">utils.gui</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.math.html">utils.math</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.settings.html">utils.settings</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</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"><a href="../api.html">API</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.html">utils</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.files.html">utils.files</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.files.input.html">utils.files.input</a></li>
|
||
<li class="breadcrumb-item active">utils.files.input.ScannedObject</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/_autosummary/utils.files.input.ScannedObject.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="utils-files-input-scannedobject">
|
||
<h1>utils.files.input.ScannedObject<a class="headerlink" href="#utils-files-input-scannedobject" title="Permalink to this heading"></a></h1>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">utils.files.input.</span></span><span class="sig-name descname"><span class="pre">ScannedObject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vertices</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">faces</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.files.input.ScannedObject" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This class is used to manage the data of the 3D object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vertices</strong> – List of verticesm Ndarray of shape (n,2)</p></li>
|
||
<li><p><strong>faces</strong> – List of faces, Ndarray of shape (n,2)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Variables<span class="colon">:</span></dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><strong>vertices</strong> – List of vertices, Ndarray of shape (n,2)</p></li>
|
||
<li><p><strong>faces</strong> – List of faces, Ndarray of shape (n,2)</p></li>
|
||
<li><p><strong>x</strong> – List of x values of the vertices</p></li>
|
||
<li><p><strong>y</strong> – List of y values of the vertices</p></li>
|
||
<li><p><strong>z</strong> – List of z values of the vertices</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Static method from_xyz_file()<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Creates a ScannedObject from a .xyz file</p>
|
||
</dd>
|
||
<dt class="field-even">Static method from_obj_file()<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Creates a ScannedObject from a .obj file</p>
|
||
</dd>
|
||
<dt class="field-odd">Method get_x()<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Returns the x values of the vertices</p>
|
||
</dd>
|
||
<dt class="field-even">Method get_y()<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Returns the y values of the vertices</p>
|
||
</dd>
|
||
<dt class="field-odd">Method get_z()<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Returns the z values of the vertices</p>
|
||
</dd>
|
||
<dt class="field-even">Method get_vertices()<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Returns the vertices</p>
|
||
</dd>
|
||
<dt class="field-odd">Method get_faces()<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Returns the faces</p>
|
||
</dd>
|
||
<dt class="field-even">Method get_discrete_vertices()<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Returns the discrete vertices</p>
|
||
</dd>
|
||
<dt class="field-odd">Method get_data()<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Returns the data</p>
|
||
</dd>
|
||
<dt class="field-even">Method export<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Exports the data to a file</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference internal" href="utils.files.input.FacesNotGiven.html#utils.files.input.FacesNotGiven" title="utils.files.input.FacesNotGiven"><strong>FacesNotGiven</strong></a> – If no faces was given</p></li>
|
||
<li><p><a class="reference internal" href="utils.files.input.ResultFileNotGiven.html#utils.files.input.ResultFileNotGiven" title="utils.files.input.ResultFileNotGiven"><strong>ResultFileNotGiven</strong></a> – If no result file was given</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Methods</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.export_obj" title="utils.files.input.ScannedObject.export_obj"><code class="xref py py-obj docutils literal notranslate"><span class="pre">export_obj</span></code></a></p></td>
|
||
<td><p>Export the object in a file.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.export_xyz" title="utils.files.input.ScannedObject.export_xyz"><code class="xref py py-obj docutils literal notranslate"><span class="pre">export_xyz</span></code></a></p></td>
|
||
<td><p>Export the object in a file.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.from_ascii_stl_file" title="utils.files.input.ScannedObject.from_ascii_stl_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_ascii_stl_file</span></code></a></p></td>
|
||
<td><p>Create an Object from an STL file.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.from_binary_stl_file" title="utils.files.input.ScannedObject.from_binary_stl_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_binary_stl_file</span></code></a></p></td>
|
||
<td><p>Create an Object from a binary STL file.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.from_file" title="utils.files.input.ScannedObject.from_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_file</span></code></a></p></td>
|
||
<td><p>Create an Object from a file.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.from_obj_file" title="utils.files.input.ScannedObject.from_obj_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_obj_file</span></code></a></p></td>
|
||
<td><p>Create an Object from an OBJ file.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.from_triangles" title="utils.files.input.ScannedObject.from_triangles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_triangles</span></code></a></p></td>
|
||
<td><p>Create an Object from a list of triangles.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.from_xyz_file" title="utils.files.input.ScannedObject.from_xyz_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_xyz_file</span></code></a></p></td>
|
||
<td><p>Create an Object from an XYZ file.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_data" title="utils.files.input.ScannedObject.get_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_data</span></code></a></p></td>
|
||
<td><p>Get the data of the object.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_discrete_vertices" title="utils.files.input.ScannedObject.get_discrete_vertices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_discrete_vertices</span></code></a></p></td>
|
||
<td><p>Discretize the vertices using the method specified in the settings.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_discrete_vertices_1" title="utils.files.input.ScannedObject.get_discrete_vertices_1"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_discrete_vertices_1</span></code></a></p></td>
|
||
<td><p>Discretize the vertices of the object using a split method.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_discrete_vertices_2" title="utils.files.input.ScannedObject.get_discrete_vertices_2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_discrete_vertices_2</span></code></a></p></td>
|
||
<td><p>Discretize the vertices of the object using a length method.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_faces" title="utils.files.input.ScannedObject.get_faces"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_faces</span></code></a></p></td>
|
||
<td><p>Get the faces of the object.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_vertices" title="utils.files.input.ScannedObject.get_vertices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_vertices</span></code></a></p></td>
|
||
<td><p>Get the vertices of the object.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_x" title="utils.files.input.ScannedObject.get_x"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_x</span></code></a></p></td>
|
||
<td><p>Get the x coordinates of the object.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_y" title="utils.files.input.ScannedObject.get_y"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_y</span></code></a></p></td>
|
||
<td><p>Get the y coordinates of the object.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.get_z" title="utils.files.input.ScannedObject.get_z"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_z</span></code></a></p></td>
|
||
<td><p>Get the z coordinates of the object.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.has_faces" title="utils.files.input.ScannedObject.has_faces"><code class="xref py py-obj docutils literal notranslate"><span class="pre">has_faces</span></code></a></p></td>
|
||
<td><p>Check if the object has faces.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.normalise" title="utils.files.input.ScannedObject.normalise"><code class="xref py py-obj docutils literal notranslate"><span class="pre">normalise</span></code></a></p></td>
|
||
<td><p>Normalise the object.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.files.input.ScannedObject.update_from_faces" title="utils.files.input.ScannedObject.update_from_faces"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_from_faces</span></code></a></p></td>
|
||
<td><p>Update the object from the faces.</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p class="rubric">Attributes</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">authorised_extensions</span></code></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.export_obj">
|
||
<span class="sig-name descname"><span class="pre">export_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.files.input.ScannedObject.export_obj" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Export the object in a file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>file_path</strong> – Path of the file</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.export_xyz">
|
||
<span class="sig-name descname"><span class="pre">export_xyz</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'\t'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.files.input.ScannedObject.export_xyz" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Export the object in a file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>file_path</strong> – Path of the file</p></li>
|
||
<li><p><strong>separator</strong> – chars used to separate the values</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.from_ascii_stl_file">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_ascii_stl_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalised</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#utils.files.input.ScannedObject" title="utils.files.input.ScannedObject"><span class="pre">ScannedObject</span></a></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.from_ascii_stl_file" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Create an Object from an STL file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>file_path</strong> – Path to the STL file</p></li>
|
||
<li><p><strong>ratio</strong> – Ratio to apply to the vertices</p></li>
|
||
<li><p><strong>normalised</strong> – the axis to normalise</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A ScannedObject</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.from_binary_stl_file">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_binary_stl_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalised</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#utils.files.input.ScannedObject" title="utils.files.input.ScannedObject"><span class="pre">ScannedObject</span></a></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.from_binary_stl_file" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Create an Object from a binary STL file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>file_path</strong> – Path to the STL file</p></li>
|
||
<li><p><strong>ratio</strong> – Ratio to apply to the vertices</p></li>
|
||
<li><p><strong>normalised</strong> – the axis to normalise</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A ScannedObject</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.from_file">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalised</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#utils.files.input.ScannedObject" title="utils.files.input.ScannedObject"><span class="pre">ScannedObject</span></a></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.from_file" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Create an Object from a file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>file_path</strong> – Path to the file</p></li>
|
||
<li><p><strong>ratio</strong> – Ratio to apply to the vertices</p></li>
|
||
<li><p><strong>normalised</strong> – the axis to normalise</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A ScannedObject</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.from_obj_file">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_obj_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalised</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#utils.files.input.ScannedObject" title="utils.files.input.ScannedObject"><span class="pre">ScannedObject</span></a></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.from_obj_file" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Create an Object from an OBJ file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>file_path</strong> – Path to the OBJ file</p></li>
|
||
<li><p><strong>ratio</strong> – Ratio to apply to the vertices</p></li>
|
||
<li><p><strong>normalised</strong> – the axis to normalise</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A ScannedObject</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.from_triangles">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_triangles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">triangles</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalised</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#utils.files.input.ScannedObject" title="utils.files.input.ScannedObject"><span class="pre">ScannedObject</span></a></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.from_triangles" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Create an Object from a list of triangles.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>triangles</strong> – List of triangles</p></li>
|
||
<li><p><strong>vertices</strong> – List of vertices</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A ScannedObject</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.from_xyz_file">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_xyz_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delimiter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalised</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#utils.files.input.ScannedObject" title="utils.files.input.ScannedObject"><span class="pre">ScannedObject</span></a></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.from_xyz_file" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Create an Object from an XYZ file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>file_path</strong> – Path to the XYZ file</p></li>
|
||
<li><p><strong>delimiter</strong> – The delimiter used in the xyz file.</p></li>
|
||
<li><p><strong>normalised</strong> – the axis to normalise</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A ScannedObject</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_data">
|
||
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_data" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the data of the object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Data of the object</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_discrete_vertices">
|
||
<span class="sig-name descname"><span class="pre">get_discrete_vertices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_discrete_vertices" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Discretize the vertices using the method specified in the settings.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>step</strong> – Step of the discretization</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Discretized vertices</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_discrete_vertices_1">
|
||
<span class="sig-name descname"><span class="pre">get_discrete_vertices_1</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_discrete_vertices_1" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Discretize the vertices of the object using a split method.
|
||
This implementation will split the object at every step interval.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>step</strong> – Step of the discretization</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Discretized vertices</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_discrete_vertices_2">
|
||
<span class="sig-name descname"><span class="pre">get_discrete_vertices_2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_discrete_vertices_2" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Discretize the vertices of the object using a length method.
|
||
This implementation will split the object when difference between the
|
||
first and last point of a slice is greater or equal then the step interval.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>step</strong> – Step of the discretization</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Discretized vertices</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_faces">
|
||
<span class="sig-name descname"><span class="pre">get_faces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resolved</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_faces" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the faces of the object.
|
||
If the faces are not resolved, the faces will be returned as a list of
|
||
indices of the vertices. else, the faces will be returned as a list of
|
||
vertices.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>resolved</strong> – If the faces should be resolved</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>faces</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_vertices">
|
||
<span class="sig-name descname"><span class="pre">get_vertices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sort</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_vertices" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the vertices of the object.
|
||
:param sort: Sort the vertices by z coordinate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>vertices</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_x">
|
||
<span class="sig-name descname"><span class="pre">get_x</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_x" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the x coordinates of the object.
|
||
return: x coordinates</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_y">
|
||
<span class="sig-name descname"><span class="pre">get_y</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_y" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the y coordinates of the object.
|
||
return: y coordinates</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.get_z">
|
||
<span class="sig-name descname"><span class="pre">get_z</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.get_z" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the z coordinates of the object.
|
||
return: z coordinates</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.has_faces">
|
||
<span class="sig-name descname"><span class="pre">has_faces</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#utils.files.input.ScannedObject.has_faces" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Check if the object has faces.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the object has faces, False otherwise</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.normalise">
|
||
<span class="sig-name descname"><span class="pre">normalise</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">axis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'z'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.files.input.ScannedObject.normalise" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Normalise the object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>axis</strong> – Axis to normalise</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.files.input.ScannedObject.update_from_faces">
|
||
<span class="sig-name descname"><span class="pre">update_from_faces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">faces</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.files.input.ScannedObject.update_from_faces" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Update the object from the faces. This will reconstruct the vertices
|
||
from the faces, it is assumed that the faces are given as a list of
|
||
vertices.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>faces</strong> – Faces to update the object from</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="utils.files.input.parse_result_file.html" class="btn btn-neutral float-left" title="utils.files.input.parse_result_file" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="utils.files.input.FacesNotGiven.html" class="btn btn-neutral float-right" title="utils.files.input.FacesNotGiven" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© 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> |