list.rst

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:

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

---

List.append

Syntax:

.append(object)

Description:

Append an object to a list, and return the number of items in list.

---

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.

---

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 insert <keyword_insert> because that name is a HOC keyword.

---

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.

---

List.remove_all

Syntax:

.remove_all()

Description:

Remove all the objects from the list. Return 0.

---

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.

---

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).

---

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:

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

Example of computed labels:

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)

If we now execute the following line to add an entry to the List, the new entry will appear in the browser immediately:

my_list.append(h.String('Neuroscience'))

---

List.selected

Syntax:

.selected()

Description:

Return the index of the highlighted object or -1 if no object is highlighted.

List.browser

---

List.select

Syntax:

.select(i)

Description:

Highlight the object at index i.

List.browser

---

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.

List.browser

---

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 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 hoc_ac_ = -1

Example:

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)

---

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 List.browser by the mouse.

Usage mirrors that of List.select_action.

---

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.

---

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.