1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
.. _api:
API
===
The Spyke Viewer API. It includes the global application configuration,
objects to access the main window and application and convenience functions.
.. data:: spykeviewer.api.config
Global configuration options for Spyke Viewer. Single options can be set
by string like a dictionary (e.g.
``spykeviewer.api.config['ask_plugin_path'] = False``) or directly (e.g.
``spykeviewer.api.config.ask_plugin_path = False``).
They can be set in the :ref:`startup`, from the
console or even in plugins. However, some configuration options are only
effective when changed from the startup script.
The configurations options are:
ask_plugin_path (:class:`bool`)
Ask about plugin paths if saving a file outside of the plugin paths.
Default: ``True``
save_plugin_before_starting (:class:`bool`)
Automatically save and reload a modified plugin before starting.
Default: ``True``
load_selection_on_start (:class:`bool`)
Load the selection that was automatically saved when shutting down
Spyke Viewer automatically on startup. This parameter is
only effective when set in the startup script. Default: ``True``
load_mode (:class:`int`)
The initially selected loading mode. Possible values:
0
Regular: Load all file contents on initial load.
1
Lazy: Only load file structure. Data objects are loaded
automatically when requested and then discarded.
2
Cached lazy: Only load file structure. Data objects are
loaded automatically when requested and then kept in
the object hierarchy so they only need to be loaded once.
This parameter is only effective when set in the startup script.
Default: 0
autoselect_segments (:class:`bool`)
Select all visible segments by default. Default: ``False``
autoselect_channel_groups (:class:`bool`)
Select all visible channel groups by default. Default: ``False``
autoselect_channels (:class:`bool`)
Select all visible channels by default. Default: ``True``
autoselect_units (:class:`bool`)
Select all visible units by default. Default: ``False``
duplicate_channels (:class:`bool`)
Treat :class:`neo.core.RecordingChannel` objects that are
referenced in multiple :class:`neo.core.RecordingChannelGroup`
objects as separate objects for each reference. If ``False``,
each channel will only be displayed (and returned by
:class:`spykeutils.plugin.data_provider.DataProvider`) once,
for the first reference encountered. Default: ``False``
codecomplete_console_enter (:class:`bool`)
Use Enter key for code completion in console. This parameter is
only effective when set in the startup script. Default: ``True``
codecomplete_editor_enter (:class:`bool`)
Use Enter key for code completion in editor. This parameter is
only effective when set in the startup script. Default: ``True``
remote_script_parameters (:class:`list`)
Additional parameters for remote script. Use this if you have a custom
remote script that needs nonstandard parameters. The format is the same
as for :class:`subprocess.Popen`, e.g.
``['--param1', 'first value', '-p2', '2']``. Default: ``[]``
remote_path_transform (function)
When the remote script is used to start plugins on a different
computer, the paths of data files can change. This function can be
used to change the path of all data files sent to a remote script.
For example, if the data files are in the same directory where the
plugin is started on the remote computer, you can strip the path and
just keep the filename:
``spykeviewer.api.config.remote_path_transform = lambda x: os.path.split(x)[1]``
Default: The identity, paths are not changed.
.. data:: spykeviewer.api.window
The main window of Spyke Viewer.
.. data:: spykeviewer.api.app
The PyQt application object.
.. autofunction:: spykeviewer.api.start_plugin
.. autofunction:: spykeviewer.api.get_plugin
|
