Bwaha found the bug!

MunchLab · May 27, 2024 · 081b37e · 081b37e
1 parent 0e6f2ac
commit 081b37e
Show file tree

Hide file tree

Showing 32 changed files with 1,859 additions and 109 deletions.
diff --git a/doc_source/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb b/doc_source/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png
diff --git a/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png b/docs/_images/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png
diff --git a/docs/_modules/ect_graph.html b/docs/_modules/ect_graph.html
diff --git a/docs/_sources/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb.txt b/docs/_sources/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb.txt
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/nbsphinx/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb b/docs/doctrees/nbsphinx/notebooks/Tutorial-ECT_for_CW_Complexes.ipynb
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_10_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_12_1.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_13_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_14_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_18_2.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_19_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_20_2.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_5_0.png
diff --git a/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png b/docs/doctrees/nbsphinx/notebooks_Tutorial-ECT_for_CW_Complexes_7_0.png
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/ect_on_graphs.html b/docs/ect_on_graphs.html
@@ -188,14 +188,15 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="ect_graph.ECT.calculateECC">
-<span class="sig-name descname"><span class="pre">calculateECC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bound_radius</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="reference internal" href="_modules/ect_graph.html#ECT.calculateECC"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ect_graph.ECT.calculateECC" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">calculateECC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bound_radius</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">return_counts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ect_graph.html#ECT.calculateECC"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ect_graph.ECT.calculateECC" title="Link to this definition"></a></dt>
 <dd><p>Function to compute the Euler Characteristic of an <cite>EmbeddedGraph</cite>, that is, a graph with coordinates for each vertex.</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>G</strong> (<em>nx.Graph</em>) – The graph to compute the Euler Characteristic for.</p></li>
 <li><p><strong>theta</strong> (<em>float</em>) – The angle (in radians) to use for the direction function when computing the Euler Characteristic Curve.</p></li>
 <li><p><strong>bound_radius</strong> (<em>float</em>) – If None, uses the following in order: (i) the bounding radius stored in the class; or if not available (ii) the bounding radius of the given graph. Otherwise, should be a postive float <span class="math notranslate nohighlight">\(R\)</span> where the ECC will be computed at thresholds in <span class="math notranslate nohighlight">\([-R,R]\)</span>. Default is None.</p></li>
+<li><p><strong>return_counts</strong> (<em>bool</em>) – Whether to return the counts of vertices, edges, and faces below the threshold. Default is False.</p></li>
 </ul>
 </dd>
 </dl>
@@ -240,7 +241,7 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="ect_graph.ECT.plotECC">
-<span class="sig-name descname"><span class="pre">plotECC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bound_radius</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="reference internal" href="_modules/ect_graph.html#ECT.plotECC"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ect_graph.ECT.plotECC" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">plotECC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bound_radius</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">draw_counts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ect_graph.html#ECT.plotECC"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ect_graph.ECT.plotECC" title="Link to this definition"></a></dt>
 <dd><p>Function to plot the Euler Characteristic Curve (ECC) for a specific direction theta. Note that this calculates the ECC for the input graph and then plots it.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>