{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "It is expected that the distances in " }, { "__type": "InlineCode", "__tag": 4051, "value": "Z[:,2]" }, { "__type": "Text", "__tag": 4046, "value": " be monotonic, otherwise crossings appear in the dendrogram." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "dendrogram", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.cluster.hierarchy:dendrogram" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ⛔ \nPyTorch ✅ ⛔ \nJAX ⚠️ no JIT ⛔ \nDask ⚠️ computes graph n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "R", "annotation": "dict", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A dictionary of data structures computed to render the dendrogram. Its has the following keys:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'color_list'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A list of color names. The k'th element represents the color of the k'th link." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'icoord'" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "'dcoord'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Each of them is a list of lists. Let " }, { "__type": "InlineCode", "__tag": 4051, "value": "icoord = [I1, I2, ..., Ip]" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineCode", "__tag": 4051, "value": "Ik = [xk1, xk2, xk3, xk4]" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "dcoord = [D1, D2, ..., Dp]" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineCode", "__tag": 4051, "value": "Dk = [yk1, yk2, yk3, yk4]" }, { "__type": "Text", "__tag": 4046, "value": ", then the k'th link painted is " }, { "__type": "InlineCode", "__tag": 4051, "value": "(xk1, yk1)" }, { "__type": "Text", "__tag": 4046, "value": " - " }, { "__type": "InlineCode", "__tag": 4051, "value": "(xk2, yk2)" }, { "__type": "Text", "__tag": 4046, "value": " - " }, { "__type": "InlineCode", "__tag": 4051, "value": "(xk3, yk3)" }, { "__type": "Text", "__tag": 4046, "value": " - " }, { "__type": "InlineCode", "__tag": 4051, "value": "(xk4, yk4)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'ivl'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A list of labels corresponding to the leaf nodes." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'leaves'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For each i, " }, { "__type": "InlineCode", "__tag": 4051, "value": "H[i] == j" }, { "__type": "Text", "__tag": 4046, "value": ", cluster node " }, { "__type": "InlineCode", "__tag": 4051, "value": "j" }, { "__type": "Text", "__tag": 4046, "value": " appears in position " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " in the left-to-right traversal of the leaves, where " }, { "__type": "InlineMath", "__tag": 4057, "value": "j < 2n-1" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineMath", "__tag": 4057, "value": "i < n" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "InlineCode", "__tag": 4051, "value": "j" }, { "__type": "Text", "__tag": 4046, "value": " is less than " }, { "__type": "InlineCode", "__tag": 4051, "value": "n" }, { "__type": "Text", "__tag": 4046, "value": ", the " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": "-th leaf node corresponds to an original observation. Otherwise, it corresponds to a non-singleton cluster." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'leaves_color_list'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A list of color names. The k'th element represents the color of the k'th leaf." } ] } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Plot the hierarchical clustering as a dendrogram." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "Z", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The linkage matrix encoding the hierarchical clustering to render as a dendrogram. See the " }, { "__type": "InlineCode", "__tag": 4051, "value": "linkage" }, { "__type": "Text", "__tag": 4046, "value": " function for more information on the format of " }, { "__type": "InlineCode", "__tag": 4051, "value": "Z" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "p", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " parameter for " }, { "__type": "InlineCode", "__tag": 4051, "value": "truncate_mode" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "truncate_mode", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The dendrogram can be hard to read when the original observation matrix from which the linkage is derived is large. Truncation is used to condense the dendrogram. There are several modes:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "None" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "No truncation is performed (default). Note: " }, { "__type": "InlineCode", "__tag": 4051, "value": "'none'" }, { "__type": "Text", "__tag": 4046, "value": " is an alias for " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": " that's kept for backward compatibility." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'lastp'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The last " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " non-singleton clusters formed in the linkage are the only non-leaf nodes in the linkage; they correspond to rows " }, { "__type": "InlineCode", "__tag": 4051, "value": "Z[n-p-2:end]" }, { "__type": "Text", "__tag": 4046, "value": " in " }, { "__type": "InlineCode", "__tag": 4051, "value": "Z" }, { "__type": "Text", "__tag": 4046, "value": ". All other non-singleton clusters are contracted into leaf nodes." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'level'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "No more than " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " levels of the dendrogram tree are displayed. A \"level\" includes all nodes with " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " merges from the final merge." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note: " }, { "__type": "InlineCode", "__tag": 4051, "value": "'mtica'" }, { "__type": "Text", "__tag": 4046, "value": " is an alias for " }, { "__type": "InlineCode", "__tag": 4051, "value": "'level'" }, { "__type": "Text", "__tag": 4046, "value": " that's kept for backward compatibility." } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "color_threshold", "annotation": "double, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For brevity, let " }, { "__type": "InlineMath", "__tag": 4057, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": " be the " }, { "__type": "InlineCode", "__tag": 4051, "value": "color_threshold" }, { "__type": "Text", "__tag": 4046, "value": ". Colors all the descendent links below a cluster node " }, { "__type": "InlineMath", "__tag": 4057, "value": "k" }, { "__type": "Text", "__tag": 4046, "value": " the same color if " }, { "__type": "InlineMath", "__tag": 4057, "value": "k" }, { "__type": "Text", "__tag": 4046, "value": " is the first node below the cut threshold " }, { "__type": "InlineMath", "__tag": 4057, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": ". All links connecting nodes with distances greater than or equal to the threshold are colored with de default matplotlib color " }, { "__type": "InlineCode", "__tag": 4051, "value": "'C0'" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "InlineMath", "__tag": 4057, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": " is less than or equal to zero, all nodes are colored " }, { "__type": "InlineCode", "__tag": 4051, "value": "'C0'" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "InlineCode", "__tag": 4051, "value": "color_threshold" }, { "__type": "Text", "__tag": 4046, "value": " is None or 'default', corresponding with MATLAB(TM) behavior, the threshold is set to " }, { "__type": "InlineCode", "__tag": 4051, "value": "0.7*max(Z[:,2])" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "get_leaves", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Includes a list " }, { "__type": "InlineCode", "__tag": 4051, "value": "R['leaves']=H" }, { "__type": "Text", "__tag": 4046, "value": " in the result dictionary. For each " }, { "__type": "InlineMath", "__tag": 4057, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "H[i] == j" }, { "__type": "Text", "__tag": 4046, "value": ", cluster node " }, { "__type": "InlineCode", "__tag": 4051, "value": "j" }, { "__type": "Text", "__tag": 4046, "value": " appears in position " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " in the left-to-right traversal of the leaves, where " }, { "__type": "InlineMath", "__tag": 4057, "value": "j < 2n-1" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineMath", "__tag": 4057, "value": "i < n" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "orientation", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The direction to plot the dendrogram, which can be any of the following strings:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'top'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Plots the root at the top, and plot descendent links going downwards. (default)." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'bottom'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Plots the root at the bottom, and plot descendent links going upwards." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'left'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Plots the root at the left, and plot descendent links going right." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'right'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Plots the root at the right, and plot descendent links going left." } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "labels", "annotation": "ndarray, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "By default, " }, { "__type": "InlineCode", "__tag": 4051, "value": "labels" }, { "__type": "Text", "__tag": 4046, "value": " is None so the index of the original observation is used to label the leaf nodes. Otherwise, this is an " }, { "__type": "InlineMath", "__tag": 4057, "value": "n" }, { "__type": "Text", "__tag": 4046, "value": "-sized sequence, with " }, { "__type": "InlineCode", "__tag": 4051, "value": "n == Z.shape[0] + 1" }, { "__type": "Text", "__tag": 4046, "value": ". The " }, { "__type": "InlineCode", "__tag": 4051, "value": "labels[i]" }, { "__type": "Text", "__tag": 4046, "value": " value is the text to put under the " }, { "__type": "InlineMath", "__tag": 4057, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " th leaf node only if it corresponds to an original observation and not a non-singleton cluster." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "count_sort", "annotation": "str or bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For each node n, the order (visually, from left-to-right) n's two descendent links are plotted is determined by this parameter, which can be any of the following values:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "False" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Nothing is done." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'ascending'" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The child with the minimum number of original objects in its cluster is plotted first." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'descending'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The child with the maximum number of original objects in its cluster is plotted first." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note, " }, { "__type": "InlineCode", "__tag": 4051, "value": "distance_sort" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "count_sort" }, { "__type": "Text", "__tag": 4046, "value": " cannot both be True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "distance_sort", "annotation": "str or bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For each node n, the order (visually, from left-to-right) n's two descendent links are plotted is determined by this parameter, which can be any of the following values:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "False" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Nothing is done." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'ascending'" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The child with the minimum distance between its direct descendents is plotted first." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'descending'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The child with the maximum distance between its direct descendents is plotted first." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note " }, { "__type": "InlineCode", "__tag": 4051, "value": "distance_sort" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "count_sort" }, { "__type": "Text", "__tag": 4046, "value": " cannot both be True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "show_leaf_counts", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When True, leaf nodes representing " }, { "__type": "InlineMath", "__tag": 4057, "value": "k>1" }, { "__type": "Text", "__tag": 4046, "value": " original observation are labeled with the number of observations they contain in parentheses." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "no_plot", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When True, the final rendering is not performed. This is useful if only the data structures computed for the rendering are needed or if matplotlib is not available." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "no_labels", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When True, no labels appear next to the leaf nodes in the rendering of the dendrogram." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "leaf_rotation", "annotation": "double, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies the angle (in degrees) to rotate the leaf labels. When unspecified, the rotation is based on the number of nodes in the dendrogram (default is 0)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "leaf_font_size", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies the font size (in points) of the leaf labels. When unspecified, the size based on the number of nodes in the dendrogram." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "leaf_label_func", "annotation": "lambda or function, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When " }, { "__type": "InlineCode", "__tag": 4051, "value": "leaf_label_func" }, { "__type": "Text", "__tag": 4046, "value": " is a callable function, for each leaf with cluster index " }, { "__type": "InlineMath", "__tag": 4057, "value": "k < 2n-1" }, { "__type": "Text", "__tag": 4046, "value": ". The function is expected to return a string with the label for the leaf." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Indices " }, { "__type": "InlineMath", "__tag": 4057, "value": "k < n" }, { "__type": "Text", "__tag": 4046, "value": " correspond to original observations while indices " }, { "__type": "InlineMath", "__tag": 4057, "value": "k \\geq n" }, { "__type": "Text", "__tag": 4046, "value": " correspond to non-singleton clusters." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For example, to label singletons with their node id and non-singletons with their id, count, and inconsistency coefficient, simply do " } ] }, { "__type": "Code", "__tag": 4050, "value": "# First define the leaf label function.\ndef llf(id):\n if id < n:\n return str(id)\n else:\n return '[%d %d %1.2f]' % (id, count, R[n-id,3])\n\n# The text for the leaf nodes is going to be big so force\n# a rotation of 90 degrees.\ndendrogram(Z, leaf_label_func=llf, leaf_rotation=90)\n\n# leaf_label_func can also be used together with ``truncate_mode``,\n# in which case you will get your leaves labeled after truncation:\ndendrogram(Z, leaf_label_func=llf, leaf_rotation=90,\n truncate_mode='level', p=2)", "execution_status": null } ] }, { "__type": "DocParam", "__tag": 4016, "name": "show_contracted", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When True the heights of non-singleton nodes contracted into a leaf node are plotted as crosses along the link connecting that leaf node. This really is only useful when truncation is used (see " }, { "__type": "InlineCode", "__tag": 4051, "value": "truncate_mode" }, { "__type": "Text", "__tag": 4046, "value": " parameter)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "link_color_func", "annotation": "callable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If given, " }, { "__type": "InlineRole", "__tag": 4003, "value": "link_color_function", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is called with each non-singleton id corresponding to each U-shaped link it will paint. The function is expected to return the color to paint the link, encoded as a matplotlib color string code. For example " } ] }, { "__type": "Code", "__tag": 4050, "value": "dendrogram(Z, link_color_func=lambda k: colors[k])", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "colors the direct links below each untruncated non-singleton node " }, { "__type": "InlineCode", "__tag": 4051, "value": "k" }, { "__type": "Text", "__tag": 4046, "value": " using " }, { "__type": "InlineCode", "__tag": 4051, "value": "colors[k]" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ax", "annotation": "matplotlib Axes instance, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If None and " }, { "__type": "ParamRef", "__tag": 4071, "name": "no_plot" }, { "__type": "Text", "__tag": 4046, "value": " is not True, the dendrogram will be plotted on the current axes. Otherwise if " }, { "__type": "ParamRef", "__tag": 4071, "name": "no_plot" }, { "__type": "Text", "__tag": 4046, "value": " is not True the dendrogram will be plotted on the given " }, { "__type": "InlineCode", "__tag": 4051, "value": "Axes" }, { "__type": "Text", "__tag": 4046, "value": " instance. This can be useful if the dendrogram is part of a more complex figure." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "above_threshold_color", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This matplotlib color string sets the color of the links above the color_threshold. The default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "'C0'" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The dendrogram illustrates how each cluster is composed by drawing a U-shaped link between a non-singleton cluster and its children. The top of the U-link indicates a cluster merge. The two legs of the U-link indicate which clusters were merged. The length of the two legs of the U-link represents the distance between the child clusters. It is also the cophenetic distance between original observations in the two children clusters." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/cluster/hierarchy.py", "item_line": 3129, "item_type": "function", "aliases": [ "scipy.cluster.hierarchy.dendrogram" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.cluster import hierarchy\nimport matplotlib.pyplot as plt\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nA very basic example:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "ytdist = np.array([662., 877., 255., 412., 996., 295., 468., 268.,\n 400., 754., 564., 138., 219., 869., 669.])\nZ = hierarchy.linkage(ytdist, 'single')\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "plt.figure()\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "dn = hierarchy.dendrogram(Z)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nNow, plot in given axes, improve the color scheme and use both vertical and\nhorizontal orientations:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "hierarchy.set_link_color_palette(['m', 'c', 'y', 'k'])\nfig, axes = plt.subplots(1, 2, figsize=(8, 3))\ndn1 = hierarchy.dendrogram(Z, ax=axes[0], above_threshold_color='y',\n orientation='top')\ndn2 = hierarchy.dendrogram(Z, ax=axes[1],\n above_threshold_color='#bcbddc',\n orientation='right')\nhierarchy.set_link_color_palette(None) # reset to default after use\nplt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-820bc970d99151dc.png" } }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-aa4ad76853a98b3b.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "linkage", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "linkage" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "set_link_color_palette", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.cluster.hierarchy:set_link_color_palette" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "Z", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "p", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "30" }, { "__type": "SigParam", "__tag": 4030, "name": "truncate_mode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "color_threshold", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "get_leaves", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "orientation", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "top" }, { "__type": "SigParam", "__tag": 4030, "name": "labels", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "count_sort", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "distance_sort", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "show_leaf_counts", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "no_plot", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "no_labels", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "leaf_font_size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "leaf_rotation", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "leaf_label_func", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "show_contracted", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "link_color_func", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "ax", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "above_threshold_color", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "C0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "dendrogram" }, "references": null, "qa": "scipy.cluster.hierarchy:dendrogram", "arbitrary": [], "local_refs": [ "R", "Z", "above_threshold_color", "ax", "color_threshold", "count_sort", "distance_sort", "get_leaves", "labels", "leaf_font_size", "leaf_label_func", "leaf_rotation", "link_color_func", "no_labels", "no_plot", "orientation", "p", "show_contracted", "show_leaf_counts", "truncate_mode" ] }