sortingview 0.14.1__tar.gz → 0.15.0__tar.gz

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 (131) hide show
  1. sortingview-0.15.0/PKG-INFO +25 -0
  2. sortingview-0.15.0/README.md +61 -0
  3. sortingview-0.15.0/examples/example_autocorrelograms.py +33 -0
  4. sortingview-0.15.0/examples/example_average_waveforms.py +82 -0
  5. sortingview-0.15.0/examples/example_box_layout.py +70 -0
  6. sortingview-0.15.0/examples/example_confusion_matrix.py +97 -0
  7. sortingview-0.15.0/examples/example_cross_correlograms.py +36 -0
  8. sortingview-0.15.0/examples/example_image.py +19 -0
  9. sortingview-0.15.0/examples/example_markdown.py +41 -0
  10. sortingview-0.15.0/examples/example_mountain_layout.py +54 -0
  11. sortingview-0.15.0/examples/example_plotly.py +21 -0
  12. sortingview-0.15.0/examples/example_position_plot.py +29 -0
  13. sortingview-0.15.0/examples/example_raster_plot.py +34 -0
  14. sortingview-0.15.0/examples/example_sorting_curation.py +33 -0
  15. sortingview-0.15.0/examples/example_spike_amplitudes.py +47 -0
  16. sortingview-0.15.0/examples/example_spike_locations.py +77 -0
  17. sortingview-0.15.0/examples/example_splitter_layout.py +64 -0
  18. sortingview-0.15.0/examples/example_tab_layout.py +44 -0
  19. sortingview-0.15.0/examples/example_tiled_image.py +70 -0
  20. sortingview-0.15.0/examples/example_timeseries_graph.py +49 -0
  21. sortingview-0.15.0/examples/example_track_position_animation.py +76 -0
  22. sortingview-0.15.0/examples/example_unit_locations.py +53 -0
  23. sortingview-0.15.0/examples/example_unit_metrics_graph.py +44 -0
  24. sortingview-0.15.0/examples/example_unit_similarity_matrix.py +35 -0
  25. sortingview-0.15.0/examples/example_units_table.py +49 -0
  26. sortingview-0.15.0/examples/helpers/compute_correlogram_data.py +66 -0
  27. sortingview-0.15.0/examples/helpers/create_units_table.py +12 -0
  28. sortingview-0.15.0/pyproject.toml +44 -0
  29. {sortingview-0.14.1 → sortingview-0.15.0}/setup.cfg +1 -1
  30. sortingview-0.15.0/setup.py +3 -0
  31. sortingview-0.15.0/sortingview/SpikeSortingView/Figure.py +46 -0
  32. sortingview-0.15.0/sortingview/figpack_backend.py +730 -0
  33. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/sortingview_view_url.py +0 -1
  34. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/version.py +1 -1
  35. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/SortingCuration2.py +0 -1
  36. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/SortingSelection.py +0 -1
  37. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/View.py +7 -0
  38. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/franklab/DecodedLinearPositionV1.py +1 -2
  39. sortingview-0.15.0/sortingview.egg-info/PKG-INFO +25 -0
  40. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview.egg-info/SOURCES.txt +29 -1
  41. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview.egg-info/requires.txt +5 -1
  42. sortingview-0.15.0/sortingview.egg-info/top_level.txt +8 -0
  43. sortingview-0.15.0/tests/helpers/compute_correlogram_data.py +66 -0
  44. sortingview-0.14.1/PKG-INFO +0 -12
  45. sortingview-0.14.1/README.md +0 -81
  46. sortingview-0.14.1/setup.py +0 -18
  47. sortingview-0.14.1/sortingview/SpikeSortingView/Figure.py +0 -25
  48. sortingview-0.14.1/sortingview.egg-info/PKG-INFO +0 -12
  49. sortingview-0.14.1/sortingview.egg-info/top_level.txt +0 -1
  50. {sortingview-0.14.1 → sortingview-0.15.0}/LICENSE +0 -0
  51. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/MultiTimeseries.py +0 -0
  52. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/SpikeSortingView.py +0 -0
  53. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/__init__.py +0 -0
  54. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_autocorrelograms_view.py +0 -0
  55. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_average_waveforms_view.py +0 -0
  56. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_autocorrelograms.py +0 -0
  57. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_average_waveforms.py +0 -0
  58. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_electrode_geometry.py +0 -0
  59. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_live_cross_correlograms.py +0 -0
  60. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_mountain_layout.py +0 -0
  61. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_raster_plot.py +0 -0
  62. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_spike_amplitudes.py +0 -0
  63. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_summary.py +0 -0
  64. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_units_table.py +0 -0
  65. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_cross_correlograms_view.py +0 -0
  66. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_electrode_geometry_view.py +0 -0
  67. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_raster_plot_view.py +0 -0
  68. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_sorting_summary_view.py +0 -0
  69. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_spike_amplitudes_view.py +0 -0
  70. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/_units_table_view.py +0 -0
  71. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_console_view.py +0 -0
  72. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_epochs.py +0 -0
  73. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_position_pdf_plot.py +0 -0
  74. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_position_plot.py +0 -0
  75. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_raw_traces_plot.py +0 -0
  76. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_spike_raster_plot.py +0 -0
  77. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/helpers/__init__.py +0 -0
  78. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/helpers/compute_correlogram_data.py +0 -0
  79. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/SpikeSortingView/prepare_spikesortingview_data.py +0 -0
  80. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/__init__.py +0 -0
  81. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/Autocorrelograms.py +0 -0
  82. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/AverageWaveforms.py +0 -0
  83. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/Box.py +0 -0
  84. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/ConfusionMatrix.py +0 -0
  85. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/CrossCorrelograms.py +0 -0
  86. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/ElectrodeGeometry.py +0 -0
  87. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/EphysTraces.py +0 -0
  88. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/Image.py +0 -0
  89. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/LayoutItem.py +0 -0
  90. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/Markdown.py +0 -0
  91. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/MountainLayout.py +0 -0
  92. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/PlotlyFigure.py +0 -0
  93. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/PositionPlot.py +0 -0
  94. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/RasterPlot.py +0 -0
  95. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/SortingCuration.py +0 -0
  96. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/SortingSummary.py +0 -0
  97. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/SpikeAmplitudes.py +0 -0
  98. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/SpikeLocations.py +0 -0
  99. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/Splitter.py +0 -0
  100. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/TabLayout.py +0 -0
  101. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/TiledImage.py +0 -0
  102. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/TimeseriesGraph.py +0 -0
  103. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/UnitImages.py +0 -0
  104. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/UnitLocations.py +0 -0
  105. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/UnitMetricsGraph.py +0 -0
  106. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/UnitSimilarityMatrix.py +0 -0
  107. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/UnitsTable.py +0 -0
  108. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/__init__.py +0 -0
  109. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/franklab/TrackPositionAnimationV1.py +0 -0
  110. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview/views/franklab/__init__.py +0 -0
  111. {sortingview-0.14.1 → sortingview-0.15.0}/sortingview.egg-info/dependency_links.txt +0 -0
  112. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_autocorrelograms.py +0 -0
  113. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_average_waveforms.py +0 -0
  114. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_confusion_matrix.py +0 -0
  115. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_cross_correlograms.py +0 -0
  116. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_large_timeseries_graph.py +0 -0
  117. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_layout.py +0 -0
  118. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_markdown.py +0 -0
  119. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_position_plot.py +0 -0
  120. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_raster_plot.py +0 -0
  121. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_sorting_curation_2.py +0 -0
  122. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_sorting_selection.py +0 -0
  123. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_spike_amplitudes.py +0 -0
  124. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_spike_locations.py +0 -0
  125. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_tab_layout.py +0 -0
  126. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_tiled_image.py +0 -0
  127. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_track_position_animation.py +0 -0
  128. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_unit_locations.py +0 -0
  129. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_unit_metrics_graph.py +0 -0
  130. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_unit_similarity_matrix.py +0 -0
  131. {sortingview-0.14.1 → sortingview-0.15.0}/tests/test_units_table.py +0 -0
@@ -0,0 +1,25 @@
1
+ Metadata-Version: 2.4
2
+ Name: sortingview
3
+ Version: 0.15.0
4
+ Summary: Web app for viewing results of ephys spike sorting
5
+ Home-page: https://github.com/magland/sortingview
6
+ Author: Jeff Soules
7
+ Author-email: Jeremy Magland <jmagland@flatironinstitute.org>
8
+ Project-URL: Homepage, https://github.com/magland/sortingview
9
+ Project-URL: Issues, https://github.com/magland/sortingview/issues
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Operating System :: OS Independent
13
+ License-File: LICENSE
14
+ Requires-Dist: spikeinterface>=0.97.0
15
+ Requires-Dist: kachery<3,>=2.0.2
16
+ Requires-Dist: figurl>=0.3.1
17
+ Requires-Dist: matplotlib
18
+ Requires-Dist: click
19
+ Requires-Dist: pynwb
20
+ Requires-Dist: pyyaml
21
+ Requires-Dist: h5py
22
+ Provides-Extra: figpack
23
+ Requires-Dist: figpack<0.5,>=0.4.6; extra == "figpack"
24
+ Requires-Dist: figpack_spike_sorting>=0.1.18; extra == "figpack"
25
+ Dynamic: license-file
@@ -0,0 +1,61 @@
1
+ # SortingView
2
+
3
+ View, curate, and share results of electrophysiological spike sorting in the browser, on the desktop, and in the notebook.
4
+
5
+ [List of examples](./doc/examples.md)
6
+
7
+ [Using layouts](./doc/layouts.md)
8
+
9
+ ## Installation and setup
10
+
11
+ ```bash
12
+ pip install --upgrade sortingview
13
+ ```
14
+
15
+ ## Kachery Setup
16
+
17
+ In order to use sortingview, you must configure kachery in order to share files on the kachery network.
18
+
19
+ Visit this site to register and obtain an API key:
20
+
21
+ https://kachery.vercel.app
22
+
23
+ Then set the following environment variables
24
+
25
+ ```bash
26
+ export KACHERY_API_KEY = "the-api-key"
27
+ export KACHERY_ZONE = "default"
28
+ ```
29
+
30
+ For information about kachery storage and zones, see:
31
+
32
+ https://github.com/magland/kachery?tab=readme-ov-file#zones-and-storage
33
+
34
+ ## Getting started
35
+
36
+ See the [examples folder](./examples).
37
+
38
+ For example:
39
+
40
+ ```bash
41
+ python examples/example_autocorrelograms.py
42
+ ```
43
+
44
+ ## Publishing to figpack instead of figurl (experimental)
45
+
46
+ Existing code that calls `view.url(...)` (for example spyglass) can publish to [figpack](https://github.com/flatironinstitute/figpack) without code changes:
47
+
48
+ ```bash
49
+ pip install "sortingview[figpack]"
50
+ export SORTINGVIEW_BACKEND=figpack
51
+ export FIGPACK_API_KEY=... # your figpack API key
52
+ export FIGPACK_BUCKET=... # optional: a bucket whose figures do not expire
53
+ ```
54
+
55
+ For the Frank Lab track animation and the 1D decoded position views, also install the figpack extensions:
56
+
57
+ ```bash
58
+ figpack extensions install figpack_franklab figpack_experimental
59
+ ```
60
+
61
+ `view.url(...)` then returns a figpack figure URL. If the view tree contains a view with no figpack equivalent, sortingview warns and falls back to figurl (set `SORTINGVIEW_FIGPACK_STRICT=1` to raise instead). A starting curation passed as `state={"sortingCuration": uri}` is loaded into the figpack figure, and `sortingview.figpack_backend.load_curation(figure_url)` reads the saved curation back. Set `SORTINGVIEW_FIGPACK_MODE=local` to write the figure to a local folder instead of uploading, or `ephemeral` for a temporary upload that needs no API key.
@@ -0,0 +1,33 @@
1
+ # 8/31/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://5cb75552ad2f7316bf1a06af8cd6564c0fd9d497&label=Autocorrelograms%20example
3
+
4
+ from typing import List
5
+ import sortingview.views as vv
6
+ import spikeinterface as si
7
+ import spikeinterface.extractors as se
8
+ import kachery as ka
9
+ from helpers.compute_correlogram_data import compute_correlogram_data
10
+
11
+
12
+ def main():
13
+ ka.use_sandbox()
14
+ _, sorting = se.toy_example(num_units=18, duration=300, seed=0, num_segments=1)
15
+
16
+ view = example_autocorrelograms(sorting=sorting)
17
+ url = view.url(label="Autocorrelograms example")
18
+ print(url)
19
+
20
+
21
+ def example_autocorrelograms(*, sorting: si.BaseSorting, height=400):
22
+ autocorrelogram_items: List[vv.AutocorrelogramItem] = []
23
+ for unit_id in sorting.get_unit_ids():
24
+ a = compute_correlogram_data(sorting=sorting, unit_id1=unit_id, unit_id2=None, window_size_msec=50, bin_size_msec=1)
25
+ bin_edges_sec = a["bin_edges_sec"]
26
+ bin_counts = a["bin_counts"]
27
+ autocorrelogram_items.append(vv.AutocorrelogramItem(unit_id=unit_id, bin_edges_sec=bin_edges_sec, bin_counts=bin_counts))
28
+ view = vv.Autocorrelograms(autocorrelograms=autocorrelogram_items, height=height)
29
+ return view
30
+
31
+
32
+ if __name__ == "__main__":
33
+ main()
@@ -0,0 +1,82 @@
1
+ # 11/8/23
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-11dev&d=sha1://675d1a91d833f4ba26019be5c48aa91f1f35c903&label=Average%20waveforms%20example
3
+
4
+ # 8/31/22
5
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://ad6178659260bf36733a8038acbc82d2020fa4ae&label=Average%20waveforms%20example
6
+
7
+ from typing import List, Tuple
8
+ import numpy as np
9
+ import sortingview.views as vv
10
+ import spikeinterface as si
11
+ import spikeinterface.extractors as se
12
+ import kachery as ka
13
+
14
+
15
+ def main():
16
+ ka.use_sandbox()
17
+ recording, sorting = se.toy_example(num_units=12, duration=300, seed=0, num_segments=1, average_peak_amplitude=-20)
18
+ assert isinstance(recording, si.BaseRecording)
19
+
20
+ view = example_average_waveforms(recording=recording, sorting=sorting)
21
+
22
+ url = view.url(label="Average waveforms example")
23
+ print(url)
24
+
25
+
26
+ def example_average_waveforms(*, recording: si.BaseRecording, sorting: si.BaseSorting, height=500):
27
+ # noise_level = estimate_noise_level(recording)
28
+ average_waveform_items: List[vv.AverageWaveformItem] = []
29
+ for unit_id in sorting.get_unit_ids():
30
+ a = compute_average_waveform(recording=recording, sorting=sorting, unit_id=unit_id)
31
+ channel_ids = a["channel_ids"]
32
+ waveform = a["waveform"]
33
+ average_waveform_items.append(
34
+ vv.AverageWaveformItem(
35
+ unit_id=unit_id,
36
+ waveform=waveform,
37
+ channel_ids=channel_ids,
38
+ # waveform_std_dev=a['waveform_std_dev'],
39
+ waveform_percentiles=a["waveform_percentiles"],
40
+ )
41
+ )
42
+ channel_locations = {}
43
+ for ii, channel_id in enumerate(recording.channel_ids):
44
+ channel_locations[str(channel_id)] = recording.get_channel_locations()[ii, :].astype(np.float32)
45
+ view = vv.AverageWaveforms(average_waveforms=average_waveform_items, channel_locations=channel_locations, show_reference_probe=True, height=height)
46
+ return view
47
+
48
+
49
+ def extract_snippets(*, traces: np.ndarray, times: np.ndarray, snippet_len: Tuple[int, int]):
50
+ N = traces.shape[0]
51
+ M = traces.shape[1]
52
+ T = snippet_len[0] + snippet_len[1]
53
+ ret = np.zeros((len(times), T, M), dtype=traces.dtype)
54
+ if len(times) == 0:
55
+ return ret
56
+ for t in range(T):
57
+ times2 = times + t - snippet_len[0]
58
+ valid = np.where((0 <= times2) & (times2 < N))
59
+ if len(valid) > 0:
60
+ ret[valid, t, :] = traces[times2[valid], :]
61
+ return ret
62
+
63
+
64
+ def compute_average_waveform(*, recording: si.BaseRecording, sorting: si.BaseSorting, unit_id: int):
65
+ if hasattr(recording, "has_scaleable_traces") and callable(getattr(recording, "has_scaleable_traces")):
66
+ scalable = recording.has_scaleable_traces()
67
+ elif hasattr(recording, "has_scaled") and callable(getattr(recording, "has_scaled")):
68
+ scalable = recording.has_scaled()
69
+ else:
70
+ scalable = False
71
+ traces = recording.get_traces(segment_index=0, return_scaled=scalable)
72
+ times = sorting.get_unit_spike_train(segment_index=0, unit_id=unit_id)
73
+ snippets = extract_snippets(traces=traces, times=times, snippet_len=(20, 20))
74
+ waveform = np.mean(snippets, axis=0).T.astype(np.float32)
75
+ stdev = np.std(snippets, axis=0).T.astype(np.float32)
76
+ waveform_percentiles = np.percentile(snippets, [5, 25, 75, 95], axis=0) # type: ignore
77
+ waveform_percentiles = [waveform_percentiles[i].T.astype(np.float32) for i in range(4)]
78
+ return {"channel_ids": recording.get_channel_ids().astype(np.int32), "waveform": waveform, "waveform_std_dev": stdev, "waveform_percentiles": waveform_percentiles}
79
+
80
+
81
+ if __name__ == "__main__":
82
+ main()
@@ -0,0 +1,70 @@
1
+ # 3/8/23
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-10&d=sha1://2e01e18ff73f7510f4b294e917a1ee1efee80acf&label=Box%20layout%20example
3
+
4
+ import sortingview.views as vv
5
+ import spikeinterface.extractors as se
6
+ import kachery as ka
7
+ import spikeinterface as si
8
+ from example_autocorrelograms import example_autocorrelograms
9
+ from example_cross_correlograms import example_cross_correlograms
10
+ from example_raster_plot import example_raster_plot
11
+ from example_average_waveforms import example_average_waveforms
12
+ from example_units_table import example_units_table
13
+ from example_unit_similarity_matrix import example_unit_unit_similarity_matrix
14
+
15
+
16
+ def main():
17
+ ka.use_sandbox()
18
+ R, S = se.toy_example(num_units=12, duration=300, seed=1, num_segments=1)
19
+ assert isinstance(R, si.BaseRecording)
20
+
21
+ view = example_box_layout(recording=R, sorting=S)
22
+
23
+ url = view.url(label="Box layout example")
24
+ print(url)
25
+
26
+
27
+ def example_box_layout(recording: si.BaseRecording, sorting: si.BaseSorting, height=800):
28
+ R = recording
29
+ S = sorting
30
+ v_units_table = example_units_table(recording=R, sorting=S)
31
+ v_raster_plot = example_raster_plot(recording=R, sorting=S)
32
+ v_autocorrelograms = example_autocorrelograms(sorting=S)
33
+ v_average_waveforms = example_average_waveforms(recording=R, sorting=S)
34
+ v_cross_correlograms = example_cross_correlograms(sorting=S, hide_unit_selector=True)
35
+ v_unit_similarity_matrix = example_unit_unit_similarity_matrix(recording=R, sorting=S)
36
+
37
+ view = vv.Box(
38
+ height=height,
39
+ direction="vertical",
40
+ show_titles=True,
41
+ items=[
42
+ vv.LayoutItem(
43
+ vv.Box(
44
+ direction="horizontal",
45
+ show_titles=True,
46
+ items=[
47
+ vv.LayoutItem(v_units_table, stretch=1, title="Units"),
48
+ vv.LayoutItem(v_raster_plot, stretch=2, title="Raster"),
49
+ vv.LayoutItem(v_unit_similarity_matrix, min_size=100, max_size=200, title="Similarity"),
50
+ ],
51
+ ),
52
+ title="top",
53
+ collapsible=True,
54
+ ),
55
+ vv.LayoutItem(
56
+ vv.Box(
57
+ direction="horizontal",
58
+ items=[vv.LayoutItem(v_autocorrelograms, min_size=300, max_size=350), vv.LayoutItem(v_average_waveforms), vv.LayoutItem(v_cross_correlograms)],
59
+ ),
60
+ title="bottom",
61
+ collapsible=True,
62
+ ),
63
+ ],
64
+ )
65
+
66
+ return view
67
+
68
+
69
+ if __name__ == "__main__":
70
+ main()
@@ -0,0 +1,97 @@
1
+ # 8/31/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://70a5430935ca06ee23246a37c247cc759d449bde&label=test_confusion_matrix
3
+
4
+ from typing import List
5
+ from tempfile import TemporaryDirectory
6
+ import spikeinterface as si
7
+ import spikeinterface.sorters as ss
8
+ import spikeinterface.comparison as sc
9
+ import spikeinterface.extractors as se
10
+ import kachery as ka
11
+ import sortingview.views as vv
12
+
13
+
14
+ def main():
15
+ ka.use_sandbox()
16
+ recording, _ = se.toy_example(num_units=12, num_channels=4, duration=200, seed=0, num_segments=1)
17
+ with TemporaryDirectory() as tmpdir:
18
+ sorter_params1 = {
19
+ "detect_sign": -1,
20
+ "adjacency_radius": -1,
21
+ "freq_min": 300,
22
+ "freq_max": 6000,
23
+ "filter": True,
24
+ "whiten": True,
25
+ "num_workers": 4,
26
+ "clip_size": 50,
27
+ "detect_threshold": 3,
28
+ "detect_interval": 10,
29
+ }
30
+ sorter_params2 = {**sorter_params1}
31
+ sorter_params2["whiten"] = False
32
+ R: si.BaseRecording = recording.save_to_folder(folder=tmpdir + "/recording")
33
+ sortings = [
34
+ ss.run_mountainsort4(
35
+ recording=R,
36
+ output_folder=f"{tmpdir}/output{i + 1}",
37
+ remove_existing_folder=False,
38
+ delete_output_folder=False,
39
+ verbose=True,
40
+ raise_error=True,
41
+ docker_image=False,
42
+ singularity_image=False,
43
+ with_output=True,
44
+ **sorter_params,
45
+ )
46
+ for i, sorter_params in enumerate([sorter_params1, sorter_params2])
47
+ ]
48
+ sorting1: si.BaseSorting = sortings[0] # type: ignore
49
+ sorting2: si.BaseSorting = sortings[1] # type: ignore
50
+ view = example_confusion_matrix(sorting1=sorting1, sorting2=sorting2)
51
+
52
+ view_units_table = _create_units_table(sorting1=sorting1, sorting2=sorting2)
53
+
54
+ view_composite = vv.Box(direction="horizontal", items=[vv.LayoutItem(view_units_table, max_size=200), vv.LayoutItem(view)])
55
+
56
+ url = view_composite.url(label="Confusion matrix")
57
+ print(url)
58
+
59
+
60
+ def _create_units_table(*, sorting1: si.BaseSorting, sorting2: si.BaseSorting):
61
+ columns: List[vv.UnitsTableColumn] = []
62
+ rows: List[vv.UnitsTableRow] = []
63
+ for unit_id in sorting1.get_unit_ids():
64
+ rows.append(vv.UnitsTableRow(unit_id=f"A{unit_id}", values={}))
65
+ for unit_id in sorting2.get_unit_ids():
66
+ rows.append(vv.UnitsTableRow(unit_id=f"B{unit_id}", values={}))
67
+ return vv.UnitsTable(columns=columns, rows=rows)
68
+
69
+
70
+ def example_confusion_matrix(*, sorting1: si.BaseSorting, sorting2: si.BaseSorting, height=400):
71
+ SC: sc.SymmetricSortingComparison = sc.compare_two_sorters(sorting1=sorting1, sorting2=sorting2)
72
+
73
+ unit_event_counts: List[vv.UnitEventCount] = []
74
+ for unit_id in sorting1.unit_ids:
75
+ unit_event_counts.append(vv.UnitEventCount(unit_id=f"A{unit_id}", count=len(sorting1.get_unit_spike_train(unit_id))))
76
+ for unit_id in sorting2.unit_ids:
77
+ unit_event_counts.append(vv.UnitEventCount(unit_id=f"B{unit_id}", count=len(sorting2.get_unit_spike_train(unit_id))))
78
+
79
+ matching_unit_event_counts: List[vv.MatchingUnitEventCount] = []
80
+ for id1 in sorting1.unit_ids:
81
+ ids2 = SC.get_matching_unit_list1(id1)
82
+ for id2 in ids2:
83
+ count = SC.get_matching_event_count(id1, id2)
84
+ matching_unit_event_counts.append(vv.MatchingUnitEventCount(unit_id1=f"A{id1}", unit_id2=f"B{id2}", count=count))
85
+
86
+ view = vv.ConfusionMatrix(
87
+ sorting1_unit_ids=[f"A{id}" for id in sorting1.unit_ids],
88
+ sorting2_unit_ids=[f"B{id}" for id in sorting2.unit_ids],
89
+ unit_event_counts=unit_event_counts,
90
+ matching_unit_event_counts=matching_unit_event_counts,
91
+ height=height,
92
+ )
93
+ return view
94
+
95
+
96
+ if __name__ == "__main__":
97
+ main()
@@ -0,0 +1,36 @@
1
+ # 8/31/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://a72e243cf44f94ecfd2fd9d828157e9ad05adce1&label=Cross%20correlograms%20example
3
+
4
+ from typing import List
5
+ import sortingview.views as vv
6
+ import spikeinterface as si
7
+ import spikeinterface.extractors as se
8
+ import kachery as ka
9
+ from helpers.compute_correlogram_data import compute_correlogram_data
10
+
11
+
12
+ def main():
13
+ ka.use_sandbox()
14
+ _, sorting = se.toy_example(num_units=12, duration=300, seed=0, num_segments=1)
15
+
16
+ view = example_cross_correlograms(sorting=sorting)
17
+ url = view.url(label="Cross correlograms example")
18
+ print(url)
19
+
20
+
21
+ def example_cross_correlograms(*, sorting: si.BaseSorting, hide_unit_selector: bool = False, height=500):
22
+ cross_correlogram_items: List[vv.CrossCorrelogramItem] = []
23
+ for unit_id1 in sorting.get_unit_ids():
24
+ for unit_id2 in sorting.get_unit_ids():
25
+ if unit_id1 != unit_id2 + 1:
26
+ a = compute_correlogram_data(sorting=sorting, unit_id1=unit_id1, unit_id2=unit_id2, window_size_msec=50, bin_size_msec=1)
27
+ bin_edges_sec = a["bin_edges_sec"]
28
+ bin_counts = a["bin_counts"]
29
+ cross_correlogram_items.append(vv.CrossCorrelogramItem(unit_id1=unit_id1, unit_id2=unit_id2, bin_edges_sec=bin_edges_sec, bin_counts=bin_counts))
30
+
31
+ view = vv.CrossCorrelograms(cross_correlograms=cross_correlogram_items, hide_unit_selector=hide_unit_selector, height=height)
32
+ return view
33
+
34
+
35
+ if __name__ == "__main__":
36
+ main()
@@ -0,0 +1,19 @@
1
+ import sortingview.views as vv
2
+ import kachery as ka
3
+
4
+
5
+ def main():
6
+ ka.use_sandbox()
7
+ view = example_image()
8
+
9
+ url = view.url(label="Image example")
10
+ print(url)
11
+
12
+
13
+ def example_image():
14
+ view = vv.Image(image_path="./figurl192.png")
15
+ return view
16
+
17
+
18
+ if __name__ == "__main__":
19
+ main()
@@ -0,0 +1,41 @@
1
+ # 8/31/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://1c894158e5518d6ff05fa36373ba8a543f1ee28f&label=Markdown%20example
3
+
4
+ import sortingview.views as vv
5
+ import kachery as ka
6
+
7
+
8
+ def main():
9
+ ka.use_sandbox()
10
+ view = example_markdown()
11
+
12
+ url = view.url(label="Markdown example")
13
+ print(url)
14
+
15
+
16
+ def example_markdown(*, height: int = 500):
17
+ view = vv.Markdown(
18
+ """
19
+ # Test markdown
20
+
21
+ Example markdown source
22
+
23
+ * list item 1
24
+ * list item 2
25
+ * list item 3
26
+
27
+ Code snippet:
28
+
29
+ ```python
30
+ import spikeinterface as si
31
+
32
+ print(si.__version__)
33
+ ```
34
+ """,
35
+ height=height,
36
+ )
37
+ return view
38
+
39
+
40
+ if __name__ == "__main__":
41
+ main()
@@ -0,0 +1,54 @@
1
+ # 8/31/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://428301bc920d206a927143a924165a0a91dc8a63&label=Mountain%20layout%20example
3
+
4
+ import sortingview.views as vv
5
+ import spikeinterface.extractors as se
6
+ import spikeinterface as si
7
+ import kachery as ka
8
+ from example_autocorrelograms import example_autocorrelograms
9
+ from example_cross_correlograms import example_cross_correlograms
10
+ from example_raster_plot import example_raster_plot
11
+ from example_average_waveforms import example_average_waveforms
12
+ from example_units_table import example_units_table
13
+ from example_unit_similarity_matrix import example_unit_unit_similarity_matrix
14
+
15
+
16
+ def main():
17
+ ka.use_sandbox()
18
+ R, S = se.toy_example(num_units=12, duration=300, seed=0, num_segments=1)
19
+ assert isinstance(R, si.BaseRecording)
20
+
21
+ view = example_mountain_layout(recording=R, sorting=S)
22
+
23
+ url = view.url(label="Mountain layout example")
24
+ print(url)
25
+
26
+
27
+ def example_mountain_layout(recording: si.BaseRecording, sorting: si.BaseSorting, height=800):
28
+ R = recording
29
+ S = sorting
30
+
31
+ v_units_table = example_units_table(recording=R, sorting=S)
32
+ v_raster_plot = example_raster_plot(recording=R, sorting=S)
33
+ v_autocorrelograms = example_autocorrelograms(sorting=S)
34
+ v_average_waveforms = example_average_waveforms(recording=R, sorting=S)
35
+ v_cross_correlograms = example_cross_correlograms(sorting=S, hide_unit_selector=True)
36
+ v_unit_similarity_matrix = example_unit_unit_similarity_matrix(recording=R, sorting=S)
37
+
38
+ view = vv.MountainLayout(
39
+ height=height,
40
+ items=[
41
+ vv.MountainLayoutItem(label="Units", view=v_units_table),
42
+ vv.MountainLayoutItem(label="Raster plot", view=v_raster_plot),
43
+ vv.MountainLayoutItem(label="Autocorrelograms", view=v_autocorrelograms),
44
+ vv.MountainLayoutItem(label="Avg. waveforms", view=v_average_waveforms),
45
+ vv.MountainLayoutItem(label="Cross correlograms", view=v_cross_correlograms),
46
+ vv.MountainLayoutItem(label="Unit similarity matrix", view=v_unit_similarity_matrix, is_control=True, control_height=300),
47
+ ],
48
+ )
49
+
50
+ return view
51
+
52
+
53
+ if __name__ == "__main__":
54
+ main()
@@ -0,0 +1,21 @@
1
+ import sortingview.views as vv
2
+ import kachery as ka
3
+ import plotly.graph_objects as go
4
+
5
+
6
+ def main():
7
+ ka.use_sandbox()
8
+ view = example_plotly()
9
+
10
+ url = view.url(label="Plotly example")
11
+ print(url)
12
+
13
+
14
+ def example_plotly():
15
+ fig = go.Figure(data=[go.Scatter(x=[1, 2, 3, 4], y=[10, 11, 12, 13], mode="markers")])
16
+ view = vv.PlotlyFigure(fig=fig)
17
+ return view
18
+
19
+
20
+ if __name__ == "__main__":
21
+ main()
@@ -0,0 +1,29 @@
1
+ # 8/31/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://056c59aae3f29f48426be38516a6e84496985edf&label=Position%20plot%20example
3
+
4
+ import numpy as np
5
+ import sortingview.views as vv
6
+ import kachery as ka
7
+
8
+
9
+ def main():
10
+ ka.use_sandbox()
11
+ view = example_position_plot()
12
+
13
+ url = view.url(label="Position plot example")
14
+ print(url)
15
+
16
+
17
+ def example_position_plot(*, height=600):
18
+ timestamps = np.arange(1000, 2000, dtype=np.float64)
19
+ n = len(timestamps)
20
+ positions = np.zeros((n, 2))
21
+ for i in range(n):
22
+ positions[i, 0] = i + 3
23
+ positions[i, 1] = timestamps[i] * np.cos(timestamps[i] * 2 * np.pi / 30)
24
+ view = vv.PositionPlot(timestamps=timestamps, positions=positions.astype(np.float32), dimension_labels=["x", "y"], height=height)
25
+ return view
26
+
27
+
28
+ if __name__ == "__main__":
29
+ main()
@@ -0,0 +1,34 @@
1
+ # 8/31/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://f2d35eb108e7c1a5f6ae0ba196d61bb9b7a889df&label=Raster%20plot%20example
3
+
4
+ from typing import List
5
+ import numpy as np
6
+ import sortingview.views as vv
7
+ import spikeinterface as si
8
+ import spikeinterface.extractors as se
9
+ import kachery as ka
10
+
11
+
12
+ def main():
13
+ ka.use_sandbox()
14
+ recording, sorting = se.toy_example(num_units=12, duration=300, seed=0, num_segments=1)
15
+ assert isinstance(recording, si.BaseRecording)
16
+
17
+ view = example_raster_plot(recording=recording, sorting=sorting)
18
+
19
+ url = view.url(label="Raster plot example")
20
+ print(url)
21
+
22
+
23
+ def example_raster_plot(*, recording: si.BaseRecording, sorting: si.BaseSorting, height=500):
24
+ plot_items: List[vv.RasterPlotItem] = []
25
+ for unit_id in sorting.get_unit_ids():
26
+ spike_times_sec = np.array(sorting.get_unit_spike_train(segment_index=0, unit_id=unit_id)) / sorting.get_sampling_frequency()
27
+ plot_items.append(vv.RasterPlotItem(unit_id=unit_id, spike_times_sec=spike_times_sec.astype(np.float32)))
28
+
29
+ view = vv.RasterPlot(start_time_sec=0, end_time_sec=recording.get_num_frames(segment_index=0) / recording.get_sampling_frequency(), plots=plot_items, height=height)
30
+ return view
31
+
32
+
33
+ if __name__ == "__main__":
34
+ main()
@@ -0,0 +1,33 @@
1
+ # 10/10/22
2
+ # https://figurl.org/f?v=gs://figurl/spikesortingview-10&d=sha1://bd702d032c8326d65484238ba3b2c505c421e095&label=Sorting%20curation%20example
3
+
4
+ import kachery as ka
5
+ import sortingview.views as vv
6
+ import spikeinterface.extractors as se
7
+ import spikeinterface as si
8
+ from helpers.create_units_table import create_units_table
9
+
10
+
11
+ def main():
12
+ ka.use_sandbox()
13
+ _, sorting = se.toy_example(num_units=12, duration=300, seed=0, num_segments=1)
14
+
15
+ view = example_sorting_curation(sorting=sorting)
16
+
17
+ url = view.url(label="Sorting curation example")
18
+ print(url)
19
+
20
+
21
+ def example_sorting_curation(*, sorting: si.BaseSorting):
22
+ view_sc = vv.SortingCuration2(label_choices=["accept", "reject", "noise"])
23
+
24
+ view_ut = create_units_table(sorting=sorting)
25
+
26
+ view_ml = vv.MountainLayout(
27
+ items=[vv.MountainLayoutItem(label="Units", view=view_ut), vv.MountainLayoutItem(label="Curation", view=view_sc, is_control=True, control_height=600)]
28
+ )
29
+ return view_ml
30
+
31
+
32
+ if __name__ == "__main__":
33
+ main()