vampire.plot.plot_dendrogram¶
- vampire.plot.plot_dendrogram(contours_df, output_path=None, build_name=None, apply_name=None, ax=None, fig_size=(6, 2))[source]¶
Plots dendrogram of mean contours.
- Parameters
- contours_dfDataFrame
DataFrame containing contour coordinates of objects and a column named ‘cluster_id’ that indicates the cluster that an object belongs.
- output_pathstr, optional
Path to the output directory. Default None, does not save figure. Cannot be not None at the same time with
ax.- build_namestr, optional
Name of the built model.
- apply_namestr, optional
Name of the image set being applied to.
- axAxes, optional
Figure axis to be plotted on. Cannot be not None with
output_pathat the same time.- fig_size(float, float), optional
Width, height in inches. Default (6, 2).
- Returns
- object_indexndarray of str
The cluster that each branch represents.