|
6 | 6 | <meta charset="utf-8" /> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
8 | 8 |
|
9 | | - <title>bdendro.dendrogram_renderer function — BDendro 1.0.0 documentation</title> |
| 9 | + <title>bdendro.dendrogram_renderer function — BDendro 1.1.1 documentation</title> |
10 | 10 | <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" /> |
12 | 12 | <link rel="stylesheet" type="text/css" href="../_static/custom.css?v=3d8ab858" /> |
13 | 13 |
|
14 | | - <script src="../_static/documentation_options.js?v=a12e3537"></script> |
| 14 | + <script src="../_static/documentation_options.js?v=d727d969"></script> |
15 | 15 | <script src="../_static/doctools.js?v=fd6eb6e6"></script> |
16 | 16 | <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> |
17 | 17 | <script src="../_static/bizstyle.js"></script> |
@@ -54,12 +54,12 @@ <h3>Navigation</h3> |
54 | 54 | <h1>bdendro.dendrogram_renderer function<a class="headerlink" href="#bdendro-dendrogram-renderer-function" title="Link to this heading">¶</a></h1> |
55 | 55 | <dl class="py function"> |
56 | 56 | <dt class="sig sig-object py" id="bdendro.dendrogram_renderer"> |
57 | | -<span class="sig-prename descclassname"><span class="pre">bdendro.</span></span><span class="sig-name descname"><span class="pre">dendrogram_renderer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</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">vertical</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 external" href="https://github.com/naubuan/bdendro/blob/v1.0.0/src/bdendro/_renderers.py#L19-L104"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#bdendro.dendrogram_renderer" title="Link to this definition">¶</a></dt> |
| 57 | +<span class="sig-prename descclassname"><span class="pre">bdendro.</span></span><span class="sig-name descname"><span class="pre">dendrogram_renderer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</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">vertical</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 external" href="https://github.com/naubuan/bdendro/blob/v1.1.1/src/bdendro/_renderers.py#L19-L104"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#bdendro.dendrogram_renderer" title="Link to this definition">¶</a></dt> |
58 | 58 | <dd><p>Make a renderer of a dendrogram.</p> |
59 | 59 | <dl class="field-list simple"> |
60 | 60 | <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
61 | 61 | <dd class="field-odd"><ul class="simple"> |
62 | | -<li><p><strong>Z</strong> (<em>(</em><em>N - 1</em><em>, </em><em>4</em><em>) </em><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.4)"><em>numpy.ndarray</em></a>) – Linkage matrix returned by <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/reference/generated/scipy.cluster.hierarchy.linkage.html#scipy.cluster.hierarchy.linkage" title="(in SciPy v1.17.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.cluster.hierarchy.linkage</span></code></a> function. |
| 62 | +<li><p><strong>Z</strong> (<em>(</em><em>N - 1</em><em>, </em><em>4</em><em>) </em><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.4)"><em>numpy.ndarray</em></a>) – Linkage matrix returned by <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.cluster.hierarchy.linkage.html#scipy.cluster.hierarchy.linkage" title="(in SciPy v1.17.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.cluster.hierarchy.linkage</span></code></a> function. |
63 | 63 | <code class="docutils literal notranslate"><span class="pre">N</span></code> is the number of leaves.</p></li> |
64 | 64 | <li><p><strong>threshold</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em> or </em><em>None</em><em>, </em><em>optional</em>) – Height for cutting a dendrogram in subtrees. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, a dendrogram |
65 | 65 | is not cut.</p></li> |
|
0 commit comments