msmbuilder.clustering.KCenters.__init__

KCenters.__init__(metric, trajectories=None, prep_trajectories=None, k=None, distance_cutoff=None, seed=0)[source]

Run kcenters clustering algorithm.

Terminates either when k clusters have been identified, or when every data is clustered better than distance_cutoff.

Parameters:

metric : msmbuilder.metrics.AbstractDistanceMetric

A metric capable of handling ptraj

trajectory : Trajectory or list of msmbuilder.Trajectory

data to cluster

k : {int, None}

number of desired clusters, or None

distance_cutoff : {float, None}

Stop identifying new clusters once the distance of every data to its cluster center falls below this value. Supply either this or k

seed : int, optional

index of the frame to use as the first cluster center

See also

_kcenters
implementation

References

[R7]Beauchamp, MSMBuilder2