vampire.plot.plot_representatives

vampire.plot.plot_representatives(contours_df, object_index, output_path=None, build_name=None, apply_name=None, num_sample=10, random_state=None, ax=None, fig_size=(17, 2), color=None, alpha=None, linewidth=None)[source]

Plots representative object contours.

Parameters
contours_dfDataFrame

DataFrame containing contour coordinates of objects and a column named ‘cluster_id’ that indicates the cluster that an object belongs.

object_indexndarray of str

A list of labels corresponding to the leaf nodes.

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.

num_sampleint, optional

Number of sample drawn from each cluster. Default 10. If num_sample > number of total available samples in the smallest cluster, it is set to the that number.

random_stateint, optional

Random state of sampling representative contours.

axAxes, optional

Figure axis to be plotted on. Cannot be not None with output_path at the same time.

fig_size(float, float), optional

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

colorstr, optional

Color of representative contours.

alphafloat, optional

Alpha of representative contours.

linewidthfloat, optional

Line width of representative contours.