vampire.plot.plot_representatives#

vampire.plot.plot_representatives(model, apply_properties_df, n_samples=10, random_state=None, ax=None, fig_size=(17, 2), colors=None, alpha=None, lw=None)[source]#

Plots representative object contours.

Parameters:
modelvampire.model.Vampire

Built VAMPIRE model.

apply_properties_dfDataFrame, optional

Properties output of VAMPIRE model applied to data.

n_samplesint, optional

Number of sample drawn from each cluster. Default 10. If n_samples > 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).

colorsstr or list, optional

Colors of representative contours of clusters.

alphafloat, optional

Alpha of representative contours.

lwfloat, optional

Line width of representative contours.

Returns:
axmatplotlib.axes.Axes