vampire.model.build_model¶

vampire.model.build_model(img_set_path, output_path, model_name, num_points, num_clusters, filter_info, random_state=None)[source]¶

Builds VAMPIRE model to one image set.

Parameters

img_set_pathstr: Path to the directory containing the image set(s) used to build model.
output_pathstr: Path of the directory used to output model and figures. Defaults to img_set_path.
model_namestr: Name of the model. Defaults to time of function call.
num_pointsint: Number of sample points of object contour. Defaults to 50.
num_clustersint: Number of clusters of K-means clustering. Defaults to 5. Recommended range [2, 10].
filter_infoDataFrame: Optional columns beyond the required columns in input DataFrame img_info_df.
random_stateint, optional: Random state of random processes.