Merge pull request #21 from MunchLab/unit-scaling

Unit scaling Feature
MunchLab · Aug 8, 2024 · eaa5184 · eaa5184
2 parents 86c5f23 + 8a30c1b
commit eaa5184
Show file tree

Hide file tree

Showing 46 changed files with 480 additions and 119 deletions.
diff --git a/doc_source/notebooks/Tutorial-ECT_for_embedded_graphs.ipynb b/doc_source/notebooks/Tutorial-ECT_for_embedded_graphs.ipynb
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d4f2cc72fab25a78ab56ca3d50c9bc34
+config: 481b1adcaae2da08c508709d1bdad06e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_11_1.png b/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_11_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_12_1.png → ...Tutorial-ECT_for_embedded_graphs_14_1.png b/...Tutorial-ECT_for_embedded_graphs_12_1.png → ...Tutorial-ECT_for_embedded_graphs_14_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_13_1.png → ...Tutorial-ECT_for_embedded_graphs_15_1.png b/...Tutorial-ECT_for_embedded_graphs_13_1.png → ...Tutorial-ECT_for_embedded_graphs_15_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_21_0.png → ...Tutorial-ECT_for_embedded_graphs_23_0.png b/...Tutorial-ECT_for_embedded_graphs_21_0.png → ...Tutorial-ECT_for_embedded_graphs_23_0.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_23_1.png → ...Tutorial-ECT_for_embedded_graphs_25_1.png b/...Tutorial-ECT_for_embedded_graphs_23_1.png → ...Tutorial-ECT_for_embedded_graphs_25_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_29_0.png → ...Tutorial-ECT_for_embedded_graphs_31_0.png b/...Tutorial-ECT_for_embedded_graphs_29_0.png → ...Tutorial-ECT_for_embedded_graphs_31_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_3_1.png b/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_3_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_7_2.png b/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_7_2.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_9_2.png b/docs/_images/notebooks_Tutorial-ECT_for_embedded_graphs_9_2.png
diff --git a/docs/_modules/ect/embed_graph.html b/docs/_modules/ect/embed_graph.html
diff --git a/docs/_sources/notebooks/Tutorial-ECT_for_embedded_graphs.ipynb.txt b/docs/_sources/notebooks/Tutorial-ECT_for_embedded_graphs.ipynb.txt
diff --git a/docs/doctrees/citing.doctree b/docs/doctrees/citing.doctree
diff --git a/docs/doctrees/contributing.doctree b/docs/doctrees/contributing.doctree
diff --git a/docs/doctrees/ect_on_graphs.doctree b/docs/doctrees/ect_on_graphs.doctree
diff --git a/docs/doctrees/embed_cw.doctree b/docs/doctrees/embed_cw.doctree
diff --git a/docs/doctrees/embed_graph.doctree b/docs/doctrees/embed_graph.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
diff --git a/docs/doctrees/installation.doctree b/docs/doctrees/installation.doctree
diff --git a/docs/doctrees/license.doctree b/docs/doctrees/license.doctree
diff --git a/docs/doctrees/modules.doctree b/docs/doctrees/modules.doctree
diff --git a/docs/doctrees/nbsphinx/notebooks/Tutorial-ECT_for_embedded_graphs.ipynb b/docs/doctrees/nbsphinx/notebooks/Tutorial-ECT_for_embedded_graphs.ipynb
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_11_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_11_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_12_1.png → ...Tutorial-ECT_for_embedded_graphs_14_1.png b/...Tutorial-ECT_for_embedded_graphs_12_1.png → ...Tutorial-ECT_for_embedded_graphs_14_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_13_1.png → ...Tutorial-ECT_for_embedded_graphs_15_1.png b/...Tutorial-ECT_for_embedded_graphs_13_1.png → ...Tutorial-ECT_for_embedded_graphs_15_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_21_0.png → ...Tutorial-ECT_for_embedded_graphs_23_0.png b/...Tutorial-ECT_for_embedded_graphs_21_0.png → ...Tutorial-ECT_for_embedded_graphs_23_0.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_23_1.png → ...Tutorial-ECT_for_embedded_graphs_25_1.png b/...Tutorial-ECT_for_embedded_graphs_23_1.png → ...Tutorial-ECT_for_embedded_graphs_25_1.png
diff --git a/...Tutorial-ECT_for_embedded_graphs_29_0.png → ...Tutorial-ECT_for_embedded_graphs_31_0.png b/...Tutorial-ECT_for_embedded_graphs_29_0.png → ...Tutorial-ECT_for_embedded_graphs_31_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_3_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_3_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_7_2.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_7_2.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_9_2.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_embedded_graphs_9_2.png
diff --git a/docs/doctrees/notebooks/CodingFiguresFern.doctree b/docs/doctrees/notebooks/CodingFiguresFern.doctree
diff --git a/docs/doctrees/notebooks/Tutorial-ECT_for_CW_Complexes.doctree b/docs/doctrees/notebooks/Tutorial-ECT_for_CW_Complexes.doctree
diff --git a/docs/doctrees/notebooks/Tutorial-ECT_for_embedded_graphs.doctree b/docs/doctrees/notebooks/Tutorial-ECT_for_embedded_graphs.doctree
diff --git a/docs/doctrees/tutorials.doctree b/docs/doctrees/tutorials.doctree
diff --git a/docs/embed_graph.html b/docs/embed_graph.html
@@ -61,6 +61,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.get_coordinates"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.get_coordinates()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.set_coordinates"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.set_coordinates()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.get_bounding_box"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.get_bounding_box()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.get_center"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.get_center()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.get_bounding_radius"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.get_bounding_radius()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.get_mean_centered_coordinates"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.get_mean_centered_coordinates()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.set_mean_centered_coordinates"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.set_mean_centered_coordinates()</span></code></a></li>
@@ -70,6 +71,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.sort_edges"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.sort_edges()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.lower_edges"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.lower_edges()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.plot"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.plot()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#ect.embed_graph.EmbeddedGraph.rescale_to_unit_disk"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph.rescale_to_unit_disk()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="#ect.embed_graph.create_example_graph"><code class="docutils literal notranslate"><span class="pre">create_example_graph()</span></code></a></li>
@@ -223,6 +225,20 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="ect.embed_graph.EmbeddedGraph.get_center">
+<span class="sig-name descname"><span class="pre">get_center</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ect/embed_graph.html#EmbeddedGraph.get_center"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ect.embed_graph.EmbeddedGraph.get_center" title="Link to this definition"></a></dt>
+<dd><p>Calculate and return the center of the graph.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The (x, y) coordinates of the center.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>numpy.ndarray</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="ect.embed_graph.EmbeddedGraph.get_bounding_radius">
 <span class="sig-name descname"><span class="pre">get_bounding_radius</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ect/embed_graph.html#EmbeddedGraph.get_bounding_radius"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ect.embed_graph.EmbeddedGraph.get_bounding_radius" title="Link to this definition"></a></dt>
@@ -364,6 +380,27 @@
 <p>If <code class="docutils literal notranslate"><span class="pre">color_nodes_theta</span></code> is not None, it should be given as a theta in <span class="math notranslate nohighlight">\([0,2\pi]\)</span>. Then the nodes are colored according to the <span class="math notranslate nohighlight">\(g(v)\)</span> values in the direction of theta.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="ect.embed_graph.EmbeddedGraph.rescale_to_unit_disk">
+<span class="sig-name descname"><span class="pre">rescale_to_unit_disk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">preserve_center</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="reference internal" href="_modules/ect/embed_graph.html#EmbeddedGraph.rescale_to_unit_disk"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ect.embed_graph.EmbeddedGraph.rescale_to_unit_disk" title="Link to this definition"></a></dt>
+<dd><p>Rescales the graph coordinates to fit within a radius 1 disk.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>preserve_center</strong> (<em>bool</em>) – If True, maintains the current center point.
+If False, centers the graph at (0, 0).</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Returns the instance for method chaining.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>self</p>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>ValueError</strong> – If the graph has no coordinates or all coordinates are identical.</p>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py function">

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -88,6 +88,7 @@ <h1 id="index">Index</h1>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#P"><strong>P</strong></a>
+ | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
 
 </div>
@@ -191,6 +192,8 @@ <h2 id="G">G</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="embed_graph.html#ect.embed_graph.EmbeddedGraph.get_center">get_center() (ect.embed_graph.EmbeddedGraph method)</a>
+</li>
       <li><a href="embed_graph.html#ect.embed_graph.EmbeddedGraph.get_coordinates">get_coordinates() (ect.embed_graph.EmbeddedGraph method)</a>
 </li>
       <li><a href="ect_on_graphs.html#ect.ect_graph.ECT.get_ECT">get_ECT() (ect.ect_graph.ECT method)</a>
@@ -253,6 +256,14 @@ <h2 id="P">P</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="embed_graph.html#ect.embed_graph.EmbeddedGraph.rescale_to_unit_disk">rescale_to_unit_disk() (ect.embed_graph.EmbeddedGraph method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>