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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
|
.. _list:
List
----
.. class:: List
List of objects
Syntax:
``h.List()``
``h.List("templatename")``
Description:
The List class provides useful tools for creating and manipulating lists of objects.
For example, if you have
a network of cells connected at synapses and each synapse is a separate object, you may want to use
lists to help organize the network. You could create one list of all pre-synaptic connections and
another of post-synaptic connections, as well as a list of all the connecting cells.
``h.List()``
Create an empty list. Objects added to the list are referenced.
Objects removed from the list are unreferenced.
``h.List("templatename")``
Create a list of all the object instances of the template.
These object instances are NOT referenced and therefore the list
dynamically changes as objects of template instances are
created and destroyed. Adding and removing objects
from this kind of list is not allowed.
Example:
.. code-block::
python
from neuron import h
clamps = h.IClamp(), h.IClamp(), h.IClamp()
all_iclamps = h.List('IClamp')
print('There are initially %d IClamp objects.' % len(all_iclamps)) # 3
another = h.IClamp()
print('There are now %d IClamp objects.' % len(all_iclamps)) # 4
----
.. method:: List.append
Syntax:
``.append(object)``
Description:
Append an object to a list, and return the number of items in list.
----
.. method:: List.prepend
Syntax:
``.prepend(object)``
Description:
Add an object to the beginning of a list, and return the number of objects in the list.
The inserted object has index=0. Following objects have an incremented
index.
----
.. method:: List.insrt
Syntax:
``.insrt(i, object)``
Description:
Insert an object before item *i*, and return the number of items in the list.
The inserted object has index *i*, following items have an incremented
index.
Not called :ref:`insert <keyword_insert>` because that name is a HOC keyword.
----
.. method:: List.remove
Syntax:
``.remove(i)``
Description:
Remove the object at index *i*. Following items have a decremented
index. ie it's often most convenient to remove items from back
to front. Return the number of objects remaining in the list.
----
.. method:: List.remove_all
Syntax:
``.remove_all()``
Description:
Remove all the objects from the list. Return 0.
----
.. method:: List.index
Syntax:
``.index(object)``
Description:
Return the index of the object in the list. Return a -1 if the
object is not in the list.
----
.. method:: List.count
Syntax:
``.count()``
Description:
Return the number of objects in the list.
This is mostly useful for legacy code. A more Python solution is to just use ``len(my_list)``.
----
.. method:: List.browser
Syntax:
``.browser()``
``.browser("title", "strname")``
``.browser("title", py_callable)``
Description:
``.browser(["title"], ["strname"])``
Make the list visible on the screen.
The items are normally the object names but if the second arg is
present and is the name of a string symbol that is defined
in the object's template, then that string is displayed in the list.
``.browser("title", py_callable)``
Browser labels are computed. For each item, ``py_callable`` is executed
with ``h.hoc_ac_`` set to the index of the item. Some objects
notify the List when they change, ie point processes when they change
their location notify the list.
Example:
.. code-block::
python
from neuron import h, gui
my_list = h.List()
for word in ['Python', 'HOC', 'NEURON', 'NMODL']:
my_list.append(h.String(word))
my_list.browser('title', 's') # h.String objects have an s attribute that returns the Python string
.. image:: ../../images/list-browser1.png
:align: center
Example of computed labels:
.. code-block::
python
from neuron import h, gui
my_list = h.List()
for word in ['NEURON', 'HOC', 'Python', 'NMODL']:
my_list.append(h.String(word))
def label_with_lengths():
item_id = h.hoc_ac_
item = my_list[item_id].s
return '%s (%d)' % (item, len(item))
my_list.browser('Words!', label_with_lengths)
.. image:: ../../images/list-browser2.png
:align: center
If we now execute the following line to add an entry to the List, the new entry will appear in the browser immediately:
.. code-block::
python
my_list.append(h.String('Neuroscience'))
.. image:: ../../images/list-browser2b.png
:align: center
----
.. method:: List.selected
Syntax:
``.selected()``
Description:
Return the index of the highlighted object or -1 if no object is highlighted.
.. seealso::
:meth:`List.browser`
----
.. method:: List.select
Syntax:
``.select(i)``
Description:
Highlight the object at index *i*.
.. seealso::
:meth:`List.browser`
----
.. method:: List.scroll_pos
Syntax:
``index = list.scroll_pos()``
``list.scroll_pos(index)``
Description:
Returns the index of the top of the browser window. Sets the scroll so that
index is the top of the browser window. A large number will cause a scroll
to the bottom.
.. seealso::
:meth:`List.browser`
----
.. method:: List.select_action
Syntax:
``list.select_action(command)``
``list.select_action(command, 0or1)``
Description:
Execute a command (a Python funciton handle) when an item in the
list :meth:`List.browser` is selected by single clicking the mouse.
If the second arg exists and is 1 (or True) then the action is only called on
the mouse button release. If nothing is selected at that time then
:data:`hoc_ac_` = -1
Example:
.. code-block::
python
from neuron import h, gui
my_list = h.List()
def on_click():
item_id = my_list.selected()
if item_id >= 0: # check to make sure selection isn't dragged off
print('Item %d selected (%s)' % (item_id, my_list[item_id].s))
for word in ['Python', 'HOC', 'NEURON', 'NMODL']:
my_list.append(h.String(word))
my_list.browser('title', 's')
my_list.select_action(on_click)
.. image:: ../../images/list-browser1.png
:align: center
----
.. method:: List.accept_action
Syntax:
``list.accept_action(command)``
Description:
Execute a command (a Python function handle) when double clicking
on an item displayed in the list :meth:`List.browser` by the mouse.
Usage mirrors that of :meth:`List.select_action`.
----
.. method:: List.object
Syntax:
``.object(i)``
``.o(i)``
Description:
Return the object at index *i*.
This is mostly useful for legacy code. In Python, use, e.g. ``my_list[i]`` instead.
----
.. method:: List.o
Syntax:
``.object(i)``
``.o(i)``
Description:
Return the object at index *i*.
This is mostly useful for legacy code. In Python, use, e.g. ``my_list[i]`` instead.
|
