bundles / scipy latest / scipy / cluster / hierarchy / cophenet
function
scipy.cluster.hierarchy:cophenet
Signature
def cophenet ( Z , Y = None ) Summary
Calculate the cophenetic distances between each observation in the hierarchical clustering defined by the linkage Z.
Extended Summary
Suppose p and q are original observations in disjoint clusters s and t, respectively and s and t are joined by a direct parent cluster u. The cophenetic distance between observations i and j is simply the distance between clusters s and t.
Parameters
Z: ndarrayThe hierarchical clustering encoded as an array (see
linkagefunction).Y: ndarray (optional)Calculates the cophenetic correlation coefficient
cof a hierarchical clustering defined by the linkage matrixZof a set of observations in dimensions.Yis the condensed distance matrix from whichZwas generated.
Returns
c: ndarrayThe cophentic correlation distance (if
Yis passed).d: ndarrayThe cophenetic distance matrix in condensed form. The th entry is the cophenetic distance between original observations and .
Notes
Array API Standard Support
cophenet has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable SCIPY_ARRAY_API=1 and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.
==================== ==================== ==================== Library CPU GPU ==================== ==================== ==================== NumPy ✅ n/a CuPy n/a ⛔ PyTorch ✅ ⛔ JAX ✅ ⛔ Dask ⚠️ merges chunks n/a ==================== ==================== ====================
See
dev-arrayapifor more information.
Examples
from scipy.cluster.hierarchy import single, cophenet from scipy.spatial.distance import pdist, squareform✓
X = [[0, 0], [0, 1], [1, 0], [0, 4], [0, 3], [1, 4], [4, 0], [3, 0], [4, 1], [4, 4], [3, 4], [4, 3]]✓
Z = single(pdist(X)) Z cophenet(Z)✓
squareform(cophenet(Z))
✓See also
- linkage
for a description of what a linkage matrix is.
- scipy.spatial.distance.squareform
transforming condensed matrices into square ones.
Aliases
-
scipy.cluster.hierarchy.cophenet