vampire.plot.plot_distribution_contour¶

vampire.plot.plot_distribution_contour(contours_df, output_path=None, build_name=None, apply_name=None, fig_size=(5, 5), height_ratio=(4, 1), contour_scale=3)[source]¶

Plots the distribution of mean contours in a bar graph with labeling 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.

fig_size(float, float), optional

Width, height in inches. Default (5, 5).

height_ratiolist[float], optional

Ratio between height of distribution plot, shape mode contours, and shape mode dendrogram. Default [4, 1, 1]. Recommended values:

[4, 1, 1] for 5 clusters (shape modes)

[4, 0.5, 1] for 10 clusters (shape modes)

[4, 0.35, 1] for 15 clusters (shape modes)

contour_scalefloat, optional

Scale of the contour shapes.