py-neuromodulation 0.0.1__py3-none-any.whl → 0.0.3__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 (206) hide show
  1. docs/build/_downloads/09df217f95985497f45d69e2d4bdc5b1/plot_2_example_add_feature.py +68 -0
  2. docs/build/_downloads/3b4900a2b2818ff30362215b76f7d5eb/plot_1_example_BIDS.py +233 -0
  3. docs/build/_downloads/7e92dd2e6cc86b239d14cafad972ae4f/plot_3_example_sharpwave_analysis.py +219 -0
  4. docs/build/_downloads/c2db0bf2b334d541b00662b991682256/plot_6_real_time_demo.py +97 -0
  5. docs/build/_downloads/ce3914826f782cbd1ea8fd024eaf0ac3/plot_5_example_rmap_computing.py +64 -0
  6. docs/build/_downloads/da36848a41e6a3235d91fb7cfb6d59b4/plot_0_first_demo.py +192 -0
  7. docs/build/_downloads/eaa4305c75b19a1e2eea941f742a6331/plot_4_example_gridPointProjection.py +210 -0
  8. docs/build/html/_downloads/09df217f95985497f45d69e2d4bdc5b1/plot_2_example_add_feature.py +68 -0
  9. docs/build/html/_downloads/3b4900a2b2818ff30362215b76f7d5eb/plot_1_example_BIDS.py +239 -0
  10. docs/build/html/_downloads/7e92dd2e6cc86b239d14cafad972ae4f/plot_3_example_sharpwave_analysis.py +219 -0
  11. docs/build/html/_downloads/c2db0bf2b334d541b00662b991682256/plot_6_real_time_demo.py +97 -0
  12. docs/build/html/_downloads/ce3914826f782cbd1ea8fd024eaf0ac3/plot_5_example_rmap_computing.py +64 -0
  13. docs/build/html/_downloads/da36848a41e6a3235d91fb7cfb6d59b4/plot_0_first_demo.py +192 -0
  14. docs/build/html/_downloads/eaa4305c75b19a1e2eea941f742a6331/plot_4_example_gridPointProjection.py +210 -0
  15. docs/source/_build/html/_downloads/09df217f95985497f45d69e2d4bdc5b1/plot_2_example_add_feature.py +76 -0
  16. docs/source/_build/html/_downloads/0d0d0a76e8f648d5d3cbc47da6351932/plot_real_time_demo.py +97 -0
  17. docs/source/_build/html/_downloads/3b4900a2b2818ff30362215b76f7d5eb/plot_1_example_BIDS.py +240 -0
  18. docs/source/_build/html/_downloads/5d73cadc59a8805c47e3b84063afc157/plot_example_BIDS.py +233 -0
  19. docs/source/_build/html/_downloads/7660317fa5a6bfbd12fcca9961457fc4/plot_example_rmap_computing.py +63 -0
  20. docs/source/_build/html/_downloads/7e92dd2e6cc86b239d14cafad972ae4f/plot_3_example_sharpwave_analysis.py +219 -0
  21. docs/source/_build/html/_downloads/839e5b319379f7fd9e867deb00fd797f/plot_example_gridPointProjection.py +210 -0
  22. docs/source/_build/html/_downloads/ae8be19afe5e559f011fc9b138968ba0/plot_first_demo.py +192 -0
  23. docs/source/_build/html/_downloads/b8b06cacc17969d3725a0b6f1d7741c5/plot_example_sharpwave_analysis.py +219 -0
  24. docs/source/_build/html/_downloads/c2db0bf2b334d541b00662b991682256/plot_6_real_time_demo.py +121 -0
  25. docs/source/_build/html/_downloads/c31a86c0b68cb4167d968091ace8080d/plot_example_add_feature.py +68 -0
  26. docs/source/_build/html/_downloads/ce3914826f782cbd1ea8fd024eaf0ac3/plot_5_example_rmap_computing.py +64 -0
  27. docs/source/_build/html/_downloads/da36848a41e6a3235d91fb7cfb6d59b4/plot_0_first_demo.py +189 -0
  28. docs/source/_build/html/_downloads/eaa4305c75b19a1e2eea941f742a6331/plot_4_example_gridPointProjection.py +210 -0
  29. docs/source/auto_examples/plot_0_first_demo.py +189 -0
  30. docs/source/auto_examples/plot_1_example_BIDS.py +240 -0
  31. docs/source/auto_examples/plot_2_example_add_feature.py +76 -0
  32. docs/source/auto_examples/plot_3_example_sharpwave_analysis.py +219 -0
  33. docs/source/auto_examples/plot_4_example_gridPointProjection.py +210 -0
  34. docs/source/auto_examples/plot_5_example_rmap_computing.py +64 -0
  35. docs/source/auto_examples/plot_6_real_time_demo.py +121 -0
  36. docs/source/conf.py +105 -0
  37. examples/plot_0_first_demo.py +189 -0
  38. examples/plot_1_example_BIDS.py +240 -0
  39. examples/plot_2_example_add_feature.py +76 -0
  40. examples/plot_3_example_sharpwave_analysis.py +219 -0
  41. examples/plot_4_example_gridPointProjection.py +210 -0
  42. examples/plot_5_example_rmap_computing.py +64 -0
  43. examples/plot_6_real_time_demo.py +121 -0
  44. packages/realtime_decoding/build/lib/realtime_decoding/__init__.py +4 -0
  45. packages/realtime_decoding/build/lib/realtime_decoding/decoder.py +104 -0
  46. packages/realtime_decoding/build/lib/realtime_decoding/features.py +163 -0
  47. packages/realtime_decoding/build/lib/realtime_decoding/helpers.py +15 -0
  48. packages/realtime_decoding/build/lib/realtime_decoding/run_decoding.py +345 -0
  49. packages/realtime_decoding/build/lib/realtime_decoding/trainer.py +54 -0
  50. packages/tmsi/build/lib/TMSiFileFormats/__init__.py +37 -0
  51. packages/tmsi/build/lib/TMSiFileFormats/file_formats/__init__.py +36 -0
  52. packages/tmsi/build/lib/TMSiFileFormats/file_formats/lsl_stream_writer.py +200 -0
  53. packages/tmsi/build/lib/TMSiFileFormats/file_formats/poly5_file_writer.py +496 -0
  54. packages/tmsi/build/lib/TMSiFileFormats/file_formats/poly5_to_edf_converter.py +236 -0
  55. packages/tmsi/build/lib/TMSiFileFormats/file_formats/xdf_file_writer.py +977 -0
  56. packages/tmsi/build/lib/TMSiFileFormats/file_readers/__init__.py +35 -0
  57. packages/tmsi/build/lib/TMSiFileFormats/file_readers/edf_reader.py +116 -0
  58. packages/tmsi/build/lib/TMSiFileFormats/file_readers/poly5reader.py +294 -0
  59. packages/tmsi/build/lib/TMSiFileFormats/file_readers/xdf_reader.py +229 -0
  60. packages/tmsi/build/lib/TMSiFileFormats/file_writer.py +102 -0
  61. packages/tmsi/build/lib/TMSiPlotters/__init__.py +2 -0
  62. packages/tmsi/build/lib/TMSiPlotters/gui/__init__.py +39 -0
  63. packages/tmsi/build/lib/TMSiPlotters/gui/_plotter_gui.py +234 -0
  64. packages/tmsi/build/lib/TMSiPlotters/gui/plotting_gui.py +440 -0
  65. packages/tmsi/build/lib/TMSiPlotters/plotters/__init__.py +44 -0
  66. packages/tmsi/build/lib/TMSiPlotters/plotters/hd_emg_plotter.py +446 -0
  67. packages/tmsi/build/lib/TMSiPlotters/plotters/impedance_plotter.py +589 -0
  68. packages/tmsi/build/lib/TMSiPlotters/plotters/signal_plotter.py +1326 -0
  69. packages/tmsi/build/lib/TMSiSDK/__init__.py +54 -0
  70. packages/tmsi/build/lib/TMSiSDK/device.py +588 -0
  71. packages/tmsi/build/lib/TMSiSDK/devices/__init__.py +34 -0
  72. packages/tmsi/build/lib/TMSiSDK/devices/saga/TMSi_Device_API.py +1764 -0
  73. packages/tmsi/build/lib/TMSiSDK/devices/saga/__init__.py +34 -0
  74. packages/tmsi/build/lib/TMSiSDK/devices/saga/saga_device.py +1366 -0
  75. packages/tmsi/build/lib/TMSiSDK/devices/saga/saga_types.py +520 -0
  76. packages/tmsi/build/lib/TMSiSDK/devices/saga/xml_saga_config.py +165 -0
  77. packages/tmsi/build/lib/TMSiSDK/error.py +95 -0
  78. packages/tmsi/build/lib/TMSiSDK/sample_data.py +63 -0
  79. packages/tmsi/build/lib/TMSiSDK/sample_data_server.py +99 -0
  80. packages/tmsi/build/lib/TMSiSDK/settings.py +45 -0
  81. packages/tmsi/build/lib/TMSiSDK/tmsi_device.py +111 -0
  82. packages/tmsi/build/lib/__init__.py +4 -0
  83. packages/tmsi/build/lib/apex_sdk/__init__.py +34 -0
  84. packages/tmsi/build/lib/apex_sdk/device/__init__.py +41 -0
  85. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_API.py +1009 -0
  86. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_API_enums.py +239 -0
  87. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_API_structures.py +668 -0
  88. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_device.py +1611 -0
  89. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_dongle.py +38 -0
  90. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_event_reader.py +57 -0
  91. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_structures/apex_channel.py +44 -0
  92. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_structures/apex_config.py +150 -0
  93. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_structures/apex_const.py +36 -0
  94. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_structures/apex_impedance_channel.py +48 -0
  95. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_structures/apex_info.py +108 -0
  96. packages/tmsi/build/lib/apex_sdk/device/devices/apex/apex_structures/dongle_info.py +39 -0
  97. packages/tmsi/build/lib/apex_sdk/device/devices/apex/measurements/download_measurement.py +77 -0
  98. packages/tmsi/build/lib/apex_sdk/device/devices/apex/measurements/eeg_measurement.py +150 -0
  99. packages/tmsi/build/lib/apex_sdk/device/devices/apex/measurements/impedance_measurement.py +129 -0
  100. packages/tmsi/build/lib/apex_sdk/device/threads/conversion_thread.py +59 -0
  101. packages/tmsi/build/lib/apex_sdk/device/threads/sampling_thread.py +57 -0
  102. packages/tmsi/build/lib/apex_sdk/device/tmsi_channel.py +83 -0
  103. packages/tmsi/build/lib/apex_sdk/device/tmsi_device.py +201 -0
  104. packages/tmsi/build/lib/apex_sdk/device/tmsi_device_enums.py +103 -0
  105. packages/tmsi/build/lib/apex_sdk/device/tmsi_dongle.py +43 -0
  106. packages/tmsi/build/lib/apex_sdk/device/tmsi_event_reader.py +50 -0
  107. packages/tmsi/build/lib/apex_sdk/device/tmsi_measurement.py +118 -0
  108. packages/tmsi/build/lib/apex_sdk/sample_data_server/__init__.py +33 -0
  109. packages/tmsi/build/lib/apex_sdk/sample_data_server/event_data.py +44 -0
  110. packages/tmsi/build/lib/apex_sdk/sample_data_server/sample_data.py +50 -0
  111. packages/tmsi/build/lib/apex_sdk/sample_data_server/sample_data_server.py +136 -0
  112. packages/tmsi/build/lib/apex_sdk/tmsi_errors/error.py +126 -0
  113. packages/tmsi/build/lib/apex_sdk/tmsi_sdk.py +113 -0
  114. packages/tmsi/build/lib/apex_sdk/tmsi_utilities/apex/apex_structure_generator.py +134 -0
  115. packages/tmsi/build/lib/apex_sdk/tmsi_utilities/decorators.py +60 -0
  116. packages/tmsi/build/lib/apex_sdk/tmsi_utilities/logger_filter.py +42 -0
  117. packages/tmsi/build/lib/apex_sdk/tmsi_utilities/singleton.py +42 -0
  118. packages/tmsi/build/lib/apex_sdk/tmsi_utilities/support_functions.py +72 -0
  119. packages/tmsi/build/lib/apex_sdk/tmsi_utilities/tmsi_logger.py +98 -0
  120. py_neuromodulation/{helper.py → _write_example_dataset_helper.py} +1 -1
  121. py_neuromodulation/nm_EpochStream.py +2 -3
  122. py_neuromodulation/nm_IO.py +43 -70
  123. py_neuromodulation/nm_RMAP.py +308 -11
  124. py_neuromodulation/nm_analysis.py +1 -1
  125. py_neuromodulation/nm_artifacts.py +25 -0
  126. py_neuromodulation/nm_bispectra.py +168 -0
  127. py_neuromodulation/nm_bursts.py +43 -31
  128. py_neuromodulation/nm_coherence.py +2 -1
  129. py_neuromodulation/nm_define_nmchannels.py +1 -1
  130. py_neuromodulation/nm_features.py +6 -1
  131. py_neuromodulation/nm_filter.py +63 -32
  132. py_neuromodulation/nm_filter_preprocessing.py +91 -0
  133. py_neuromodulation/nm_fooof.py +47 -29
  134. py_neuromodulation/nm_generator.py +10 -10
  135. py_neuromodulation/nm_mne_connectivity.py +1 -1
  136. py_neuromodulation/nm_normalization.py +50 -74
  137. py_neuromodulation/nm_oscillatory.py +151 -31
  138. py_neuromodulation/nm_plots.py +13 -10
  139. py_neuromodulation/nm_rereference.py +10 -8
  140. py_neuromodulation/nm_run_analysis.py +28 -13
  141. py_neuromodulation/nm_sharpwaves.py +103 -136
  142. py_neuromodulation/nm_stats.py +44 -30
  143. py_neuromodulation/nm_stream_abc.py +18 -10
  144. py_neuromodulation/nm_stream_offline.py +185 -43
  145. py_neuromodulation/utils/_logging.py +24 -0
  146. {py_neuromodulation-0.0.1.dist-info → py_neuromodulation-0.0.3.dist-info}/METADATA +182 -131
  147. py_neuromodulation-0.0.3.dist-info/RECORD +188 -0
  148. {py_neuromodulation-0.0.1.dist-info → py_neuromodulation-0.0.3.dist-info}/WHEEL +2 -1
  149. py_neuromodulation-0.0.3.dist-info/top_level.txt +5 -0
  150. tests/__init__.py +0 -0
  151. tests/conftest.py +117 -0
  152. tests/test_all_examples.py +10 -0
  153. tests/test_all_features.py +63 -0
  154. tests/test_bispectra.py +70 -0
  155. tests/test_bursts.py +105 -0
  156. tests/test_feature_sampling_rates.py +143 -0
  157. tests/test_fooof.py +16 -0
  158. tests/test_initalization_offline_stream.py +41 -0
  159. tests/test_multiprocessing.py +58 -0
  160. tests/test_nan_values.py +29 -0
  161. tests/test_nm_filter.py +95 -0
  162. tests/test_nm_resample.py +63 -0
  163. tests/test_normalization_settings.py +146 -0
  164. tests/test_notch_filter.py +31 -0
  165. tests/test_osc_features.py +424 -0
  166. tests/test_preprocessing_filter.py +151 -0
  167. tests/test_rereference.py +171 -0
  168. tests/test_sampling.py +57 -0
  169. tests/test_settings_change_after_init.py +76 -0
  170. tests/test_sharpwave.py +165 -0
  171. tests/test_target_channel_add.py +100 -0
  172. tests/test_timing.py +80 -0
  173. py_neuromodulation/data/README +0 -6
  174. py_neuromodulation/data/dataset_description.json +0 -8
  175. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/MOV_aligned_features_ch_ECOG_RIGHT_0_all.png +0 -0
  176. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/all_feature_plt.pdf +0 -0
  177. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_FEATURES.csv +0 -182
  178. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_LM_ML_RES.p +0 -0
  179. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_SETTINGS.json +0 -273
  180. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_SIDECAR.json +0 -6
  181. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_decoding_performance.png +0 -0
  182. py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_nm_channels.csv +0 -11
  183. py_neuromodulation/data/participants.json +0 -32
  184. py_neuromodulation/data/participants.tsv +0 -2
  185. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_space-mni_coordsystem.json +0 -5
  186. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_space-mni_electrodes.tsv +0 -11
  187. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_channels.tsv +0 -11
  188. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.eeg +0 -0
  189. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.json +0 -18
  190. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.vhdr +0 -35
  191. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.vmrk +0 -13
  192. py_neuromodulation/data/sub-testsub/ses-EphysMedOff/sub-testsub_ses-EphysMedOff_scans.tsv +0 -2
  193. py_neuromodulation/grid_cortex.tsv +0 -40
  194. py_neuromodulation/grid_subcortex.tsv +0 -1429
  195. py_neuromodulation/nm_settings.json +0 -261
  196. py_neuromodulation/plots/STN_surf.mat +0 -0
  197. py_neuromodulation/plots/Vertices.mat +0 -0
  198. py_neuromodulation/plots/faces.mat +0 -0
  199. py_neuromodulation/plots/grid.mat +0 -0
  200. py_neuromodulation/py_neuromodulation.egg-info/PKG-INFO +0 -104
  201. py_neuromodulation/py_neuromodulation.egg-info/dependency_links.txt +0 -1
  202. py_neuromodulation/py_neuromodulation.egg-info/requires.txt +0 -26
  203. py_neuromodulation/py_neuromodulation.egg-info/top_level.txt +0 -1
  204. py_neuromodulation-0.0.1.dist-info/RECORD +0 -72
  205. /py_neuromodulation/{py_neuromodulation.egg-info/SOURCES.txt → utils/__init__.py} +0 -0
  206. {py_neuromodulation-0.0.1.dist-info → py_neuromodulation-0.0.3.dist-info}/LICENSE +0 -0
@@ -1,261 +0,0 @@
1
- {
2
- "sampling_rate_features_hz": 10,
3
- "segment_length_features_ms": 1000,
4
- "preprocessing": [
5
- "raw_resampling",
6
- "notch_filter",
7
- "re_referencing"
8
- ],
9
- "documentation_preprocessing_options": [
10
- "raw_resampling",
11
- "notch_filter",
12
- "re_referencing",
13
- "raw_normalization"
14
- ],
15
- "features": {
16
- "raw_hjorth": true,
17
- "return_raw": true,
18
- "bandpass_filter": false,
19
- "stft": false,
20
- "fft": true,
21
- "sharpwave_analysis": true,
22
- "fooof": false,
23
- "bursts": true,
24
- "linelength": true,
25
- "coherence": false,
26
- "nolds": false,
27
- "mne_connectivity": false
28
- },
29
- "postprocessing": {
30
- "feature_normalization": true,
31
- "project_cortex": false,
32
- "project_subcortex": false
33
- },
34
- "raw_resampling_settings": {
35
- "resample_freq_hz": 1000
36
- },
37
- "documentation_normalization_options": [
38
- "mean",
39
- "median",
40
- "zscore",
41
- "zscore-median",
42
- "quantile",
43
- "power",
44
- "robust",
45
- "minmax"
46
- ],
47
- "raw_normalization_settings": {
48
- "normalization_time_s": 30,
49
- "normalization_method": "zscore",
50
- "clip": 3
51
- },
52
- "feature_normalization_settings": {
53
- "normalization_time_s": 30,
54
- "normalization_method": "zscore",
55
- "clip": 3
56
- },
57
- "frequency_ranges_hz": {
58
- "theta": [
59
- 4,
60
- 8
61
- ],
62
- "alpha": [
63
- 8,
64
- 12
65
- ],
66
- "low beta": [
67
- 13,
68
- 20
69
- ],
70
- "high beta": [
71
- 20,
72
- 35
73
- ],
74
- "low gamma": [
75
- 60,
76
- 80
77
- ],
78
- "high gamma": [
79
- 90,
80
- 200
81
- ],
82
- "HFA": [
83
- 200,
84
- 400
85
- ]
86
- },
87
- "fft_settings": {
88
- "windowlength_ms": 1000,
89
- "log_transform": true,
90
- "kalman_filter": false
91
- },
92
- "stft_settings": {
93
- "windowlength_ms": 500,
94
- "log_transform": true,
95
- "kalman_filter": false
96
- },
97
- "bandpass_filter_settings": {
98
- "segment_lengths_ms": {
99
- "theta": 1000,
100
- "alpha": 500,
101
- "low beta": 333,
102
- "high beta": 333,
103
- "low gamma": 100,
104
- "high gamma": 100,
105
- "HFA": 100
106
- },
107
- "bandpower_features": {
108
- "activity": true,
109
- "mobility": false,
110
- "complexity": false
111
- },
112
- "log_transform": true,
113
- "kalman_filter": false
114
- },
115
- "kalman_filter_settings": {
116
- "Tp": 0.1,
117
- "sigma_w": 0.7,
118
- "sigma_v": 1,
119
- "frequency_bands": [
120
- "theta",
121
- "alpha",
122
- "low beta",
123
- "high beta",
124
- "low gamma",
125
- "high gamma",
126
- "HFA"
127
- ]
128
- },
129
- "burst_settings": {
130
- "threshold": 75,
131
- "time_duration_s": 30,
132
- "frequency_bands": [
133
- "low beta",
134
- "high beta",
135
- "low gamma"
136
- ],
137
- "burst_features": {
138
- "duration": true,
139
- "amplitude": true,
140
- "burst_rate_per_s": true,
141
- "in_burst": true
142
- }
143
- },
144
- "sharpwave_analysis_settings": {
145
- "sharpwave_features": {
146
- "peak_left": false,
147
- "peak_right": false,
148
- "trough": false,
149
- "width": false,
150
- "prominence": true,
151
- "interval": true,
152
- "decay_time": false,
153
- "rise_time": false,
154
- "sharpness": true,
155
- "rise_steepness": false,
156
- "decay_steepness": false,
157
- "slope_ratio": false
158
- },
159
- "filter_ranges_hz": [
160
- [
161
- 5,
162
- 80
163
- ],
164
- [
165
- 5,
166
- 30
167
- ]
168
- ],
169
- "detect_troughs": {
170
- "estimate": true,
171
- "distance_troughs_ms": 10,
172
- "distance_peaks_ms": 5
173
- },
174
- "detect_peaks": {
175
- "estimate": true,
176
- "distance_troughs_ms": 5,
177
- "distance_peaks_ms": 10
178
- },
179
- "estimator": {
180
- "mean": [
181
- "interval"
182
- ],
183
- "median": null,
184
- "max": [
185
- "prominence",
186
- "sharpness"
187
- ],
188
- "min": null,
189
- "var": null
190
- },
191
- "apply_estimator_between_peaks_and_troughs": true
192
- },
193
- "project_cortex_settings": {
194
- "max_dist_mm": 20
195
- },
196
- "project_subcortex_settings": {
197
- "max_dist_mm": 5
198
- },
199
- "coherence": {
200
- "channels": [
201
- [
202
- "STN_RIGHT_0",
203
- "ECOG_RIGHT_0"
204
- ]
205
- ],
206
- "frequency_bands": [
207
- "high beta"
208
- ],
209
- "features": {
210
- "mean_fband": true,
211
- "max_fband": true,
212
- "max_allfbands": true
213
- },
214
- "method": {
215
- "coh": true,
216
- "icoh": true
217
- }
218
- },
219
- "fooof": {
220
- "aperiodic": {
221
- "exponent": true,
222
- "offset": true,
223
- "knee": true
224
- },
225
- "periodic": {
226
- "center_frequency": false,
227
- "band_width": false,
228
- "height_over_ap": false
229
- },
230
- "windowlength_ms": 800,
231
- "peak_width_limits": [
232
- 0.5,
233
- 12
234
- ],
235
- "max_n_peaks": 3,
236
- "min_peak_height": 0,
237
- "peak_threshold": 2,
238
- "freq_range_hz": [
239
- 2,
240
- 40
241
- ],
242
- "knee": true
243
- },
244
- "nolds_features": {
245
- "sample_entropy": false,
246
- "correlation_dimension": false,
247
- "lyapunov_exponent": true,
248
- "hurst_exponent": false,
249
- "detrended_fluctutaion_analysis": false,
250
- "data": {
251
- "raw": true,
252
- "frequency_bands": [
253
- "low beta"
254
- ]
255
- }
256
- },
257
- "mne_connectiviy": {
258
- "method": "plv",
259
- "mode": "multitaper"
260
- }
261
- }
Binary file
Binary file
Binary file
Binary file
@@ -1,104 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: py-neuromodulation
3
- Version: 0.0.1.dev0
4
- Summary: Real-time analysis of intracranial neurophysiology recordings.
5
- Author: Timon Merk
6
- Maintainer: Timon Merk
7
- License: MIT License
8
-
9
- Copyright (c) 2021 Interventional Cognitive Neuromodulation - Neumann Lab Berlin
10
-
11
- Permission is hereby granted, free of charge, to any person obtaining a copy
12
- of this software and associated documentation files (the "Software"), to deal
13
- in the Software without restriction, including without limitation the rights
14
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
- copies of the Software, and to permit persons to whom the Software is
16
- furnished to do so, subject to the following conditions:
17
-
18
- The above copyright notice and this permission notice shall be included in all
19
- copies or substantial portions of the Software.
20
-
21
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
- SOFTWARE.
28
-
29
- Project-URL: bugtracker, https://github.com/neuromodulation/py_neuromodulation/issues
30
- Project-URL: repository, https://github.com/neuromodulation/py_neuromodulation
31
- Keywords: real-time,eeg,ieeg,dbs,ecog,electrocorticography,deep-brain-stimulation,machine-learning
32
- Classifier: Development Status :: 2 - Pre-Alpha
33
- Classifier: License :: OSI Approved :: MIT License
34
- Classifier: Programming Language :: Python
35
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
36
- Requires-Python: >=3.10
37
- Description-Content-Type: text/x-rst
38
- Provides-Extra: dev
39
- License-File: LICENSE
40
-
41
- py_neuromodulation
42
- ==================
43
-
44
- .. image:: https://app.travis-ci.com/neuromodulation/py_neuromodulation.svg?branch=main
45
- :target: https://app.travis-ci.com/neuromodulation/py_neuromodulation
46
-
47
- Click this button to run the "example_BIDS.ipynb":
48
-
49
- .. image:: https://mybinder.org/badge_logo.svg
50
- :target: https://mybinder.org/v2/gh/neuromodulation/py_neuromodulation/HEAD
51
-
52
- The py_neuromodulation toolbox allows for real time capable processing of multimodal electrophysiological data. The primary use is movement prediction for `adaptive deep brain stimulation <https://pubmed.ncbi.nlm.nih.gov/30607748/>`_.
53
-
54
- Find the documentation here https://neuromodulation.github.io/py_neuromodulation/ for example usage and parametrization.
55
-
56
- Setup
57
- =====
58
-
59
- For running this toolbox first create a new virtual conda environment and activate it:
60
-
61
- .. code-block::
62
-
63
- conda create -n pynm-test python=3.10
64
- conda activate pynm-test
65
-
66
- Then install the packages listed in the `pyproject.toml`.
67
-
68
- .. code-block::
69
-
70
- pip install .[dev]
71
- pytest -v .
72
-
73
-
74
- Optionally the ipython kernel can be specified to installed for the pynm-test conda environment:
75
-
76
- .. code-block::
77
-
78
- ipython kernel install --user --name=pynm-test
79
-
80
- Then py_neuromodulation can be imported via:
81
-
82
- .. code-block::
83
-
84
- import py_neuromodulation as py_nm
85
-
86
- The main modules include running real time enabled feature preprocessing based on `iEEG BIDS <https://www.nature.com/articles/s41597-019-0105-7>`_ data.
87
-
88
- Different features can be enabled/disabled and parametrized in the `https://github.com/neuromodulation/py_neuromodulation/blob/main/pyneuromodulation/nm_settings.json>`_.
89
-
90
- The current implementation mainly focuses band power and `sharpwave <https://www.sciencedirect.com/science/article/abs/pii/S1364661316302182>`_ feature estimation.
91
-
92
- An example folder with a mock subject and derivate `feature <https://github.com/neuromodulation/py_neuromodulation/tree/main/examples/data>`_ set was estimated.
93
-
94
- To run feature estimation given the example BIDS data run in root directory.
95
-
96
- .. code-block::
97
-
98
- python examples/example_BIDS.py
99
-
100
-
101
- This will write a feature_arr.csv and different sidecar files in the 'examples/data/derivatives' folder.
102
-
103
- For further documentation view `ParametrizationDefinition <ParametrizationDefinition.html#>`_ for description of necessary parametrization files.
104
- `FeatureEstimationDemo <FeatureEstimationDemo.html#>`_ walks through an example feature estimation and explains sharpwave estimation.
@@ -1,26 +0,0 @@
1
- mne
2
- filterpy>=1.4.5
3
- fooof
4
- imbalanced-learn
5
- matplotlib>=3.3.4
6
- mne-bids>=0.8
7
- mne-connectivity
8
- mrmr-selection
9
- nolds
10
- numba
11
- numpy>=1.21.2
12
- pandas>=1.2.2
13
- pip
14
- pynput
15
- pybids
16
- scikit-image
17
- scikit-learn>=0.24.2
18
- scikit-optimize
19
- scipy>=1.7.1
20
- seaborn>=0.11
21
- xgboost
22
-
23
- [dev]
24
- black
25
- pytest
26
- pytest-cov
@@ -1 +0,0 @@
1
- py_neuromodulation
@@ -1,72 +0,0 @@
1
- py_neuromodulation/FieldTrip.py,sha256=cq4BIibMvcpyAHd7U8eEK4AhVSOTrRKXcywtgtc-Mg4,18597
2
- py_neuromodulation/__init__.py,sha256=3aujkEqF4dzt8WKtK7gaolh782UsR5FFkqcg7fOtze4,296
3
- py_neuromodulation/grid_cortex.tsv,sha256=DRnJEBwLBqyzCp3UwBL-Us_9h9GyokCorYl0HLsHSLk,683
4
- py_neuromodulation/grid_subcortex.tsv,sha256=oCQDYLDdYSa1DAI9ybwECfuzWulFzXqKHyf7oZ1oDBM,25842
5
- py_neuromodulation/helper.py,sha256=MBDMyP-JsqjqpmljCq2sqsLfYpihA-S8MXf_Nc3johs,2510
6
- py_neuromodulation/nm_EpochStream.py,sha256=h6qmYfnyBbWwcOqZM3LmJQKPQjDhImxxOSza7kocrdA,2603
7
- py_neuromodulation/nm_IO.py,sha256=BrsxpCbcyyxojU3yXJtEDkW1o5ZpxQiU3avaM-CGZPQ,12713
8
- py_neuromodulation/nm_RMAP.py,sha256=UEh0vzjTF8UMO4uNgo0CqOeolviBF7zOr6owwdnupHM,7594
9
- py_neuromodulation/nm_across_patient_decoding.py,sha256=9Mwu5o5cUAbtSP8BTx4c-BJfJZtk8wsMx_WH0VIegdI,38690
10
- py_neuromodulation/nm_analysis.py,sha256=QD7lfi-6VA2v4E1-wCIMNs2GnZK9UvFMsr7slWyZGhA,38509
11
- py_neuromodulation/nm_bursts.py,sha256=XHhHYE4zmdGvwKv3UVpTiBmfSRW_fqBLtus5JxLUOf0,7299
12
- py_neuromodulation/nm_coherence.py,sha256=tMqxHIGbmqoyIVDUyv2D19T_qF3f_QWm65Tyg2R_awM,7420
13
- py_neuromodulation/nm_cohortwrapper.py,sha256=eJVCBW745DB5MX7OBVJh2ZAT1vy-3-_2MCHnjrsO9qI,16643
14
- py_neuromodulation/nm_decode.py,sha256=d15D-l0RUAcW8FfXyDcPaNwRpS9wuq1XK-pWmImPHDg,35645
15
- py_neuromodulation/nm_define_nmchannels.py,sha256=LdmQi_QV1XtoQEsdXjjfmMqHE2mE_yS839MarLPjfPU,11058
16
- py_neuromodulation/nm_eval_timing.py,sha256=JcnLYyxjH8hvNX7rbJ4PEj-NZzqs2NMGOhyuQQuGiYc,8800
17
- py_neuromodulation/nm_features.py,sha256=WrFqAG3sZx8Ca6YshCC1m0TToc8p1X3j8OF557XK3Z8,3323
18
- py_neuromodulation/nm_features_abc.py,sha256=6CX8NHbtpGDY-l9K4CUomlRJVZHPmo6KHJX4RJ1YolM,917
19
- py_neuromodulation/nm_filter.py,sha256=rWzRiu8u9iW78FKq5-xiTn1IzZUlKH0df3VUWSVrIq8,6437
20
- py_neuromodulation/nm_fooof.py,sha256=gyaX9UKkFWtaK7eXJqUVcIZfE3JgK0t-md2dipDWj-o,5607
21
- py_neuromodulation/nm_generator.py,sha256=wMWYOArshVgTuFsDvfLOBwIigR86fcJTJ2KNuf5-zfM,1102
22
- py_neuromodulation/nm_hjorth_raw.py,sha256=EvXOBr3k9Q5xypv1Gj8GFqa5EJ_wRYNDGgGnXCUekiM,2180
23
- py_neuromodulation/nm_kalmanfilter.py,sha256=dgs7_XMBpLEE49l6aAVNA4d6ovTS63CZsAI472eG3JA,2006
24
- py_neuromodulation/nm_linelength.py,sha256=0iZO7j6g7IeprvlEvWG6a_CaUL2p0sQKGiFgDrzYtxk,954
25
- py_neuromodulation/nm_mne_connectivity.py,sha256=52Y5q-uvaZp3ZVLlJ5fELPSAn3YdA1b0vzar5a_neew,3895
26
- py_neuromodulation/nm_nolds.py,sha256=KZr3ZKqvKJkYKh2BMYuuUMkP8hhmJTUgtLZrE8l-DqQ,3660
27
- py_neuromodulation/nm_normalization.py,sha256=3IsZ-xQOqMlrOMjiSYnsm0_H8D0MD9EzAls5X_HvENo,8019
28
- py_neuromodulation/nm_oscillatory.py,sha256=Sw_DROPpWUMIs5nm6SWP583ISL8QiI07lFJ0vwQ_F1U,12450
29
- py_neuromodulation/nm_plots.py,sha256=bjGe6HVB7VNA7JvVabit_5s-m4rWMV2RK3pO9aiWA2E,17688
30
- py_neuromodulation/nm_projection.py,sha256=g8VersyOGiWj3PjR_U6dvLttsp6CHi_GCyYnu_ha8uc,15309
31
- py_neuromodulation/nm_rereference.py,sha256=eleKoJyml6r7b8jH_1dDSUVD0gicfb9zKTJZcS3VTk4,3167
32
- py_neuromodulation/nm_resample.py,sha256=MSMu8gvmrYZ194fAVJdlB_4yEkuGKHgHrLd11zBDRY0,1122
33
- py_neuromodulation/nm_run_analysis.py,sha256=xrjcKYulMMAZeNmEeaiSxK93TxRDs3OUyyjs8ig3gCk,14607
34
- py_neuromodulation/nm_settings.json,sha256=bzt6D4gdNsRrU05tpsZrBrIRvY64oxkNu5slLnJ9xXU,6333
35
- py_neuromodulation/nm_settings.py,sha256=7d17vwSGrABxQJ7C6x3FqP8kdboUFpm5LrN4djoVlFA,1775
36
- py_neuromodulation/nm_sharpwaves.py,sha256=zgoEs7GxqengbYYSs3CLZ4HmEyKL7KJ01T5Q8D0zbjE,17493
37
- py_neuromodulation/nm_stats.py,sha256=8I8MzMuUSP38a356dT2p5hkKuyrTp5gFJ4h1f7K_IMs,15876
38
- py_neuromodulation/nm_stream_abc.py,sha256=rc1B79CDOWAVBYe6eNFKnnaoYqoLsVbDnCzH1Np4Hsw,7576
39
- py_neuromodulation/nm_stream_offline.py,sha256=fGTDUvtdTJXkASyci6ceAXQlZvyF_JU9zmVXK8lx-HI,7795
40
- py_neuromodulation/data/README,sha256=Xw-QRZXGq2YefZ3ZDvrK736DruAkFVeaqOn70BzFnPs,714
41
- py_neuromodulation/data/dataset_description.json,sha256=4LRbbS8x0ifRZhqTNOrtPmm306AmipYnl9duL3OXHrA,130
42
- py_neuromodulation/data/participants.json,sha256=o24uxJ95GE_b3SAA6nQg6G8Ene6zPL_u02wYT38A8OY,788
43
- py_neuromodulation/data/participants.tsv,sha256=rPmG1JoJ2O0xbhlLHDJszAK-QSR_7gkSiaykn-HaXvo,79
44
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/MOV_aligned_features_ch_ECOG_RIGHT_0_all.png,sha256=2rh1gfB4K_nAzRilS1Q1U_c1K0l-ixQnxRt7ErQv9vw,78507
45
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/all_feature_plt.pdf,sha256=T9MUq0ybhFfAvlngswc7IwRZwNAO_OBJiXgfLy4iWfM,113368
46
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_FEATURES.csv,sha256=deeo_mZxq64taqK4nNSSqgku0mVZU6_LWS6OsqywGyM,229130
47
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_LM_ML_RES.p,sha256=IaAHXuJlZG-pGfiPWycSPqFuNDNDyVOP38yhgzGDDoU,1027034
48
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_SETTINGS.json,sha256=08YaBHI_lKx4VBuXhJE288pspweI7OaRdsBEyGqqd2I,6694
49
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_SIDECAR.json,sha256=CnUYu5u5sqEzDftuNsHrDl03mvSort2ta-RV1ZLZrdc,97
50
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_decoding_performance.png,sha256=7wzfRupi6UdK-NKcqKxx2ASBuUoV4siH6OISz8gaXzw,93276
51
- py_neuromodulation/data/derivatives/sub-testsub_ses-EphysMedOff_task-gripforce_run-0/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_nm_channels.csv,sha256=GDmeOFl7EcPDUD3wa9PRxPY79UYpphbATfA7Hn2YOyY,634
52
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/sub-testsub_ses-EphysMedOff_scans.tsv,sha256=zu2Ym07qo164jbClxfT3L960-nHQeRo6WG3QmbpNgl0,91
53
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_space-mni_coordsystem.json,sha256=NzLVNODlEAIDwTk49_YcbOUjWiRMdZ8toZYBpmAWS1A,123
54
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_space-mni_electrodes.tsv,sha256=eHBvuZa9WJGI5LSid2TBRxzgyacK7AwrFGKEByl3i4w,733
55
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_channels.tsv,sha256=cZSFnJqjRK8mrtTN271U9L6H_Lo2kuUHimhcKcv9xdY,790
56
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.eeg,sha256=NnQeMDrKpeK3lctIZ5Bzh85UMTs5OCUCaivn_NU5rc4,760040
57
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.json,sha256=A0zHnbKXKLBmPly9NshT2B6lsrogFZeIAMXeTzwEYyk,492
58
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.vhdr,sha256=hUwxHtbCZMo16-e06xJ1rVqgs1Ac8LtP8_5AmhjeDw8,1023
59
- py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.vmrk,sha256=WV1mN_QGC1WlFh5qcKzXpedyMhtXVHVwgV5v8n1-_Zw,553
60
- py_neuromodulation/plots/STN_surf.mat,sha256=Hh2nfQRmP0TYIt8SWV-ajKnC8yk7EmBoAj1c6RMoi9g,124526
61
- py_neuromodulation/plots/Vertices.mat,sha256=k72WB8-0Datt-bRScxcfpp38LBPHV34zzodS49kQAgs,3709780
62
- py_neuromodulation/plots/faces.mat,sha256=gWSr-9qNxsAPoG8q-muNnaFZHVHGKqnKN0j3Q1JfMk4,2859245
63
- py_neuromodulation/plots/grid.mat,sha256=G3MYIVcvk8lbf_kKWIe3lZZ4d0QV6HkoLsOFN1A2vhE,775
64
- py_neuromodulation/py_neuromodulation.egg-info/PKG-INFO,sha256=qTwplxI-l0mHOa52B_AjP_lODr_weBsh5ArlFBNC6u4,4651
65
- py_neuromodulation/py_neuromodulation.egg-info/SOURCES.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
66
- py_neuromodulation/py_neuromodulation.egg-info/dependency_links.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
67
- py_neuromodulation/py_neuromodulation.egg-info/requires.txt,sha256=796jIT4geNGiOXR7sATwqQh7IQe7ePEhVaWHR59tFiA,281
68
- py_neuromodulation/py_neuromodulation.egg-info/top_level.txt,sha256=uqanKxhNbYqoz0TQijlQFGWLntCySmjJwr1c_wglN98,19
69
- py_neuromodulation-0.0.1.dist-info/LICENSE,sha256=V6yfss2JKJxeY-TsaEVqVomfd8ttziMyB9ik5L-BI7o,1139
70
- py_neuromodulation-0.0.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
71
- py_neuromodulation-0.0.1.dist-info/METADATA,sha256=dxjN5apJIUMEv6Q3Plajntnup5onjYU34MVvLOi9LRQ,4758
72
- py_neuromodulation-0.0.1.dist-info/RECORD,,