onion_clustering.onion_uni.onion_inner

onion_clustering.onion_uni.onion_inner(matrix, bins, number_of_sigmas)

Returns the clustering object with the analysis.

Parameters:
  • matrix (ndarray of shape (n_particles * n_windows, tau_window)) – The values of the signal for each particle at each frame.

  • bins (Union[str, int] = "auto") – The number of bins used for the construction of the histograms. Can be an integer value, or “auto”. If “auto”, the default of numpy.histogram_bin_edges is used (see https://numpy.org/doc/stable/reference/generated/ numpy.histogram_bin_edges.html#numpy.histogram_bin_edges).

  • number_of_sigma (float = 2.0) – Sets the thresholds for classifing a signal window inside a state: the window is contained in the state if it is entirely contained inside number_of_sigma * state.sigms times from state.mean.

  • number_of_sigmas (float)

Returns:

clustering_object – The final clustering object.

Return type:

ClusteringObject1D