vampire.plot.plot_contour_dendrogram

vampire.plot.plot_contour_dendrogram(contours_df, output_path=None, build_name=None, apply_name=None, fig_size=(6, 2), contour_scale=3)[source]

Plots dendrogram with 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.

fig_size(float, float), optional

Width, height in inches. Default (6, 2).

contour_scalefloat, optional

Scale of the contour shapes.

Returns
object_indexndarray of str

The cluster that each branch represents.