scipy.cluster.hierarchy.

to_tree#

scipy.cluster.hierarchy.to_tree(Z, rd=False)[source]#

将连接矩阵转换为易于使用的树对象。

默认情况下,返回对根 ClusterNode 对象的引用。

每个 ClusterNode 对象都有 left, right, dist, idcount 属性。 left 和 right 属性指向组合以生成集群的 ClusterNode 对象。如果两者都为 None,则 ClusterNode 对象是叶节点,其计数必须为 1,并且其距离没有意义,但设置为 0。

注意:提供此函数是为了方便库用户。 ClusterNode 不用作此库中任何函数的输入。

参数:
Zndarray

适当形式的连接矩阵(参见 linkage 函数文档)。

rdbool, 可选

当为 False(默认)时,返回对根 ClusterNode 对象的引用。否则,返回一个元组 (r, d)r 是对根节点的引用,而 dClusterNode 对象的列表 - 每个对象对应于连接矩阵中的原始条目,以及所有聚类步骤的条目。如果集群 ID 小于连接矩阵描述的数据中的样本数 n,则它对应于单例集群(叶节点)。有关将集群 ID 分配给集群的更多信息,请参见 linkage

返回值:
treeClusterNode 或元组 (ClusterNode, ClusterNode 列表)

如果 rd 为 False,则返回 ClusterNode。如果 rd 为 True,则返回长度为 2*n - 1 的列表,其中 n 是样本数。 有关更多详细信息,请参见上面对 rd 的描述。

注释

to_tree 除了 NumPy 之外,还对 Python Array API Standard 兼容后端提供实验性支持。请考虑通过设置环境变量 SCIPY_ARRAY_API=1 并提供 CuPy、PyTorch、JAX 或 Dask 数组作为数组参数来测试这些功能。支持以下后端和设备(或其他功能)的组合。

CPU

GPU

NumPy

不适用

CuPy

不适用

PyTorch

JAX

⚠️ 无 JIT

⚠️ 无 JIT

Dask

⚠️ 计算图

不适用

有关更多信息,请参见 对数组 API 标准的支持

示例

>>> import numpy as np
>>> from scipy.cluster import hierarchy
>>> rng = np.random.default_rng()
>>> x = rng.random((5, 2))
>>> Z = hierarchy.linkage(x)
>>> hierarchy.to_tree(Z)
<scipy.cluster.hierarchy.ClusterNode object at ...
>>> rootnode, nodelist = hierarchy.to_tree(Z, rd=True)
>>> rootnode
<scipy.cluster.hierarchy.ClusterNode object at ...
>>> len(nodelist)
9