API Reference

This is the reference for classes (CamelCase names) and functions (underscore_case names) of pycrostates.

• Most-used classes
  • pycrostates.cluster.ModKMeans
  • pycrostates.segmentation.RawSegmentation
  • pycrostates.segmentation.EpochsSegmentation
  • pycrostates.io.ChInfo
• Datasets
  • pycrostates.datasets.lemon.data_path
  • pycrostates.datasets.lemon.standardize
• File I/O
  • pycrostates.io.ChInfo
  • pycrostates.io.ChData
  • pycrostates.io.read_cluster
• Preprocessing
  • pycrostates.preprocessing.apply_spatial_filter
  • pycrostates.preprocessing.extract_gfp_peaks
  • pycrostates.preprocessing.resample
• Cluster
  • pycrostates.cluster.ModKMeans
  • pycrostates.cluster.AAHCluster
  • Utils
• Metrics
  • pycrostates.metrics.silhouette_score
  • pycrostates.metrics.calinski_harabasz_score
  • pycrostates.metrics.davies_bouldin_score
  • pycrostates.metrics.dunn_score
• Segmentation
  • pycrostates.segmentation.RawSegmentation
  • pycrostates.segmentation.EpochsSegmentation
  • pycrostates.segmentation.compute_transition_matrix
  • pycrostates.segmentation.compute_expected_transition_matrix
  • pycrostates.segmentation.entropy
  • pycrostates.segmentation.excess_entropy_rate
  • pycrostates.segmentation.auto_information_function
  • pycrostates.segmentation.partial_auto_information_function
• Visualisation
  • pycrostates.viz.plot_cluster_centers
  • pycrostates.viz.plot_raw_segmentation
  • pycrostates.viz.plot_epoch_segmentation