cratepy.ioput.readprocedures.check_clustering_scheme

check_clustering_scheme(mat_phase, clustering_scheme, valid_algorithms, valid_features)[source]

Check material phase’s prescribed clustering scheme.

Parameters:

  • mat_phase (str) – Material phase label.

  • clustering_scheme (numpy.ndarray of shape (n_clusterings, 3)) – Clustering scheme stored as a numpy.ndarray of shape (n_clusterings, 3). Each row is associated with a unique clustering characterized by a clustering algorithm (col 1, int), a list of clustering features (col 2, list[int]), and a list of the clustering features data matrix’ indexes (col 3, list[int]).

  • valid_algorithms (list[str]) – Valid clustering algorithms identifiers (str).

  • valid_features (list[str]) – Valid clustering features identifiers (str).