DARTsort 0.3.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. dartsort/__init__.py +68 -0
  2. dartsort/cli.py +105 -0
  3. dartsort/clustering/__init__.py +3 -0
  4. dartsort/clustering/cluster_util.py +392 -0
  5. dartsort/clustering/clustering.py +765 -0
  6. dartsort/clustering/clustering_features.py +202 -0
  7. dartsort/clustering/density.py +1299 -0
  8. dartsort/clustering/forward_backward.py +219 -0
  9. dartsort/clustering/gmm/mixture.py +5790 -0
  10. dartsort/clustering/gmm/stable_features.py +993 -0
  11. dartsort/clustering/kmeans.py +448 -0
  12. dartsort/clustering/merge.py +501 -0
  13. dartsort/clustering/modes.py +214 -0
  14. dartsort/clustering/refine_util.py +191 -0
  15. dartsort/clustering/relocate.py +109 -0
  16. dartsort/clustering/split.py +1285 -0
  17. dartsort/config.py +288 -0
  18. dartsort/detect/__init__.py +2 -0
  19. dartsort/detect/detect.py +449 -0
  20. dartsort/detect/detect_filters.py +37 -0
  21. dartsort/evaluate/__init__.py +1 -0
  22. dartsort/evaluate/analysis.py +594 -0
  23. dartsort/evaluate/comparison.py +534 -0
  24. dartsort/evaluate/hybrid_util.py +599 -0
  25. dartsort/evaluate/noise_recording_tools.py +184 -0
  26. dartsort/evaluate/sim_template_tools.py +842 -0
  27. dartsort/evaluate/simkit.py +840 -0
  28. dartsort/evaluate/simlib.py +270 -0
  29. dartsort/localize/__init__.py +0 -0
  30. dartsort/localize/localize_torch.py +291 -0
  31. dartsort/localize/localize_util.py +313 -0
  32. dartsort/main.py +657 -0
  33. dartsort/peel/__init__.py +6 -0
  34. dartsort/peel/grab.py +208 -0
  35. dartsort/peel/matching.py +628 -0
  36. dartsort/peel/matching_util/__init__.py +3 -0
  37. dartsort/peel/matching_util/compressed_upsampled.py +718 -0
  38. dartsort/peel/matching_util/drifty.py +791 -0
  39. dartsort/peel/matching_util/matching_base.py +616 -0
  40. dartsort/peel/matching_util/pairwise.py +359 -0
  41. dartsort/peel/matching_util/pairwise_util.py +1317 -0
  42. dartsort/peel/peel_base.py +1000 -0
  43. dartsort/peel/running_template.py +1498 -0
  44. dartsort/peel/subtract.py +1123 -0
  45. dartsort/peel/threshold.py +471 -0
  46. dartsort/peel/universal.py +191 -0
  47. dartsort/pretrained/default_temporal_kernel.npy +0 -0
  48. dartsort/pretrained/detect_np1.pt +0 -0
  49. dartsort/pretrained/detect_np2.pt +0 -0
  50. dartsort/pretrained/glasbey1024.npz +0 -0
  51. dartsort/pretrained/offset_trained_denoiser.pt +0 -0
  52. dartsort/pretrained/offset_trained_denoiser_added_temp.pt +0 -0
  53. dartsort/pretrained/offset_trained_denoiser_added_temp_boost.pt +0 -0
  54. dartsort/pretrained/original_single_chan_denoiser.pt +0 -0
  55. dartsort/pretrained/single_chan_denoiser.pt +0 -0
  56. dartsort/templates/__init__.py +11 -0
  57. dartsort/templates/get_templates.py +771 -0
  58. dartsort/templates/postprocess_util.py +555 -0
  59. dartsort/templates/realignment.py +466 -0
  60. dartsort/templates/superres_util.py +204 -0
  61. dartsort/templates/template_util.py +518 -0
  62. dartsort/templates/templates.py +528 -0
  63. dartsort/transform/__init__.py +2 -0
  64. dartsort/transform/_multichan_denoiser_kit.py +650 -0
  65. dartsort/transform/all_transformers.py +58 -0
  66. dartsort/transform/amortized_localization.py +503 -0
  67. dartsort/transform/amplitudes.py +197 -0
  68. dartsort/transform/decollider.py +635 -0
  69. dartsort/transform/enforce_decrease.py +158 -0
  70. dartsort/transform/localize.py +86 -0
  71. dartsort/transform/matching_denoiser.py +44 -0
  72. dartsort/transform/pipeline.py +391 -0
  73. dartsort/transform/single_channel_denoiser.py +153 -0
  74. dartsort/transform/single_channel_templates.py +98 -0
  75. dartsort/transform/supervised_denoiser.py +486 -0
  76. dartsort/transform/temporal_pca.py +413 -0
  77. dartsort/transform/transform_base.py +255 -0
  78. dartsort/util/__init__.py +0 -0
  79. dartsort/util/cli_util.py +179 -0
  80. dartsort/util/data_util.py +1128 -0
  81. dartsort/util/drift_util.py +1054 -0
  82. dartsort/util/internal_config.py +1074 -0
  83. dartsort/util/interpolation_util.py +1012 -0
  84. dartsort/util/job_util.py +19 -0
  85. dartsort/util/logging_util.py +91 -0
  86. dartsort/util/main_util.py +235 -0
  87. dartsort/util/more_operators.py +269 -0
  88. dartsort/util/multiprocessing_util.py +211 -0
  89. dartsort/util/nn_util.py +461 -0
  90. dartsort/util/noise_util.py +1461 -0
  91. dartsort/util/peel_util.py +223 -0
  92. dartsort/util/py_util.py +213 -0
  93. dartsort/util/registration_util.py +128 -0
  94. dartsort/util/residual_util.py +30 -0
  95. dartsort/util/sparse_util.py +81 -0
  96. dartsort/util/spikeio.py +227 -0
  97. dartsort/util/spiketorch.py +1198 -0
  98. dartsort/util/testing_util/__init__.py +0 -0
  99. dartsort/util/testing_util/matching_debug_util.py +517 -0
  100. dartsort/util/testing_util/mixture_testing_util.py +291 -0
  101. dartsort/util/torch_optimization_util.py +156 -0
  102. dartsort/util/torch_util.py +75 -0
  103. dartsort/util/universal_util.py +269 -0
  104. dartsort/util/waveform_util.py +809 -0
  105. dartsort/vis/__init__.py +19 -0
  106. dartsort/vis/analysis_plots.py +392 -0
  107. dartsort/vis/colors.py +36 -0
  108. dartsort/vis/gt.py +392 -0
  109. dartsort/vis/layout.py +149 -0
  110. dartsort/vis/metrics_util.py +23 -0
  111. dartsort/vis/mixture.py +1489 -0
  112. dartsort/vis/over_time.py +514 -0
  113. dartsort/vis/recanim.py +429 -0
  114. dartsort/vis/scatterplots.py +779 -0
  115. dartsort/vis/sorting.py +163 -0
  116. dartsort/vis/unit.py +917 -0
  117. dartsort/vis/unit_comparison.py +1017 -0
  118. dartsort/vis/versus.py +300 -0
  119. dartsort/vis/vismain.py +537 -0
  120. dartsort/vis/waveforms.py +357 -0
  121. dartsort-0.3.5.dist-info/METADATA +93 -0
  122. dartsort-0.3.5.dist-info/RECORD +125 -0
  123. dartsort-0.3.5.dist-info/WHEEL +5 -0
  124. dartsort-0.3.5.dist-info/entry_points.txt +2 -0
  125. dartsort-0.3.5.dist-info/top_level.txt +1 -0
@@ -0,0 +1,163 @@
1
+ import numpy as np
2
+
3
+ from ..evaluate.analysis import DARTsortAnalysis
4
+ from . import analysis_plots
5
+ from .colors import glasbey1024
6
+ from .layout import BasePlot, flow_layout
7
+
8
+
9
+ class OverviewPlot(BasePlot):
10
+ def draw(
11
+ self,
12
+ panel,
13
+ sorting_analysis,
14
+ ):
15
+ raise NotImplementedError
16
+
17
+
18
+ class SortingTextInfo(OverviewPlot):
19
+ kind = "text"
20
+ height = 0.5
21
+
22
+ def draw(self, panel, sorting_analysis: DARTsortAnalysis):
23
+ axis = panel.subplots()
24
+ axis.axis("off")
25
+ msg = ""
26
+
27
+ if sorting_analysis.name:
28
+ msg += f"Sorting: {sorting_analysis.name}\n"
29
+
30
+ h5_path = sorting_analysis.sorting.parent_h5_path
31
+ if h5_path is not None:
32
+ msg += f"feature source: {h5_path.name}\n"
33
+
34
+ nspikes = sorting_analysis.sorting.times_samples.size
35
+ if sorting_analysis.sorting.labels is None:
36
+ triaged = 0
37
+ else:
38
+ triaged = np.sum(sorting_analysis.sorting.labels < 0)
39
+ msg += f"{nspikes} total spikes\n"
40
+ if triaged:
41
+ tpct = 100 * triaged / nspikes
42
+ msg += f"{triaged} ({tpct:0.1f}%) of these are triaged"
43
+ else:
44
+ msg += f"no triaged spikes"
45
+
46
+ n_units = sorting_analysis.sorting.n_units
47
+ msg += f"{n_units} units"
48
+
49
+ axis.text(0, 0, msg, fontsize=6.5)
50
+
51
+
52
+ class CoarseTemplateMaxChannelsPlot(OverviewPlot):
53
+ kind = "scatter"
54
+ height = 3.5
55
+
56
+ def draw(self, panel, sorting_analysis: DARTsortAnalysis):
57
+ axis = panel.subplots()
58
+ analysis_plots.scatter_max_channel_waveforms(
59
+ axis,
60
+ sorting_analysis.coarse_template_data,
61
+ geom=sorting_analysis.recording.get_channel_locations(),
62
+ waveform_height=0.05,
63
+ waveform_width=0.75,
64
+ show_geom=True,
65
+ )
66
+
67
+
68
+ class SpikeCountHistogram(OverviewPlot):
69
+ kind = "histogram"
70
+ width = 2
71
+
72
+ def __init__(self, n_bins=128, log=True):
73
+ self.n_bins = n_bins
74
+ self.log = log
75
+
76
+ def draw(self, panel, sorting_analysis: DARTsortAnalysis):
77
+ assert sorting_analysis.coarse_template_data is not None
78
+ axis = panel.subplots()
79
+ axis.hist(
80
+ sorting_analysis.coarse_template_data.spike_counts,
81
+ bins=self.n_bins,
82
+ log=self.log,
83
+ histtype="stepfilled",
84
+ color="k",
85
+ )
86
+ axis.set_xlabel("per-unit spike count")
87
+
88
+
89
+ class MergeDistanceMatrix(OverviewPlot):
90
+ kind = "heatmap"
91
+ width = 2
92
+ height = 2
93
+
94
+ def __init__(
95
+ self, dendrogram_linkage=None, show_unit_labels=False, dendrogram_threshold=0.25
96
+ ):
97
+ self.dendrogram_linkage = dendrogram_linkage
98
+ self.show_unit_labels = show_unit_labels
99
+ self.dendrogram_threshold = dendrogram_threshold
100
+
101
+ def draw(self, panel, sorting_analysis: DARTsortAnalysis):
102
+ assert sorting_analysis.coarse_template_data is not None
103
+ analysis_plots.distance_matrix_dendro(
104
+ panel,
105
+ sorting_analysis.merge_distances,
106
+ unit_ids=sorting_analysis.coarse_template_data.unit_ids,
107
+ dendrogram_linkage=self.dendrogram_linkage,
108
+ dendrogram_threshold=self.dendrogram_threshold,
109
+ show_unit_labels=self.show_unit_labels,
110
+ )
111
+
112
+
113
+ class RasterPlot(OverviewPlot):
114
+ kind = "scatter"
115
+ width = 2
116
+
117
+ def __init__(self, colors=glasbey1024, **scatter_kwargs):
118
+ self.colors = colors
119
+ self.scatter_kwargs = dict(s=3, lw=0) | scatter_kwargs
120
+
121
+ def draw(self, panel, sorting_analysis: DARTsortAnalysis):
122
+ assert sorting_analysis.sorting.labels is not None
123
+ axis = panel.subplots()
124
+ axis.scatter(
125
+ sorting_analysis.times_seconds,
126
+ sorting_analysis.sorting.labels,
127
+ c=self.colors[sorting_analysis.sorting.labels % len(self.colors)],
128
+ **self.scatter_kwargs,
129
+ )
130
+ axis.set_xlabel("time (s)")
131
+ axis.set_ylabel("unit")
132
+
133
+
134
+ sorting_plots = (
135
+ SortingTextInfo(),
136
+ CoarseTemplateMaxChannelsPlot(),
137
+ SpikeCountHistogram(),
138
+ MergeDistanceMatrix(),
139
+ RasterPlot(),
140
+ )
141
+
142
+
143
+ def make_sorting_summary(
144
+ sorting_analysis,
145
+ plots=sorting_plots,
146
+ max_height=4,
147
+ figsize=(11, 8.5),
148
+ figure=None,
149
+ ):
150
+ figure = flow_layout(
151
+ plots,
152
+ max_height=max_height,
153
+ figsize=figsize,
154
+ figure=figure,
155
+ sorting_analysis=sorting_analysis,
156
+ )
157
+
158
+ return figure
159
+
160
+
161
+ # def sorting_animation(
162
+ # sorting_analysis,
163
+ # )