SectionList

classes
   allroots       children       remove         unique         
   append         printnames     subtree        wholetree      

SYNTAX

sl = new SectionList()

DESCRIPTION

Class for creating and managing a list of sections

SEE ALSO

SectionBrowser , Shape , forsec , list


append

SectionList

SYNTAX

sl.append()

DESCRIPTION

append the currently accessed section to the list


remove

SectionList

SYNTAX

n = sl.remove()
n = sl.remove(sectionlist)

DESCRIPTION

remove the currently accessed section from the list If the argument is present then all the sections in sectionlist are removed from sl. Returns the number of sections removed.


children

SectionList

SYNTAX

sl.children()

DESCRIPTION

Appends the sections connected to the currently accessed section. Note that this includes children connected at position 0 of parent.


subtree

SectionList

SYNTAX

sl.subtree()

DESCRIPTION

Appends the subtree of the currently accessed section (including that one).


wholetree

SectionList

SYNTAX

sl.wholetree()

DESCRIPTION

Appends all sections which have a path to the currently accessed section (including the currently accessed section). The section list has the important property that the sections are in root to leaf order.


allroots

SectionList

SYNTAX

sl.allroots()

DESCRIPTION

Appends all the root sections. Root sections have no parent section. The number of root sections is the number of real cells in the simulation.


unique

SectionList

SYNTAX

n = sl.unique()

DESCRIPTION

Removes all duplicates of sections in the SectionList. I.e. ensures that no section appears more than once. Returns the number of sections references that were removed.


printnames

SectionList

SYNTAX

.printnames()

DESCRIPTION

print the names of the sections in the list.

The normal usage of a section list involves efficiently iterating over all the sections in the list with forsec sectionlist {statement}


neuron/neuron/classes/seclist.hel : Nov 23 14:06