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
|
.. _secref:
SectionRef
----------
.. note::
Much of this functionality is available in Python through :class:`Section` methods in
recent versions of NEURON. It is, however, sometimes necessary to use this class to
interoperate with legacy code.
.. class:: SectionRef
Syntax:
``sref = h.SectionRef(sec=section)``
Description:
SectionRef keeps a pointer/reference to section. If the ``sec=`` argument is
omitted, the reference is to the currently accessed section.
This class overcomes a HOC limitation where sections were not treated as objects.
----
.. data:: SectionRef.sec
Syntax:
``sref.sec``
Description:
Returns the :class:`Section` the ``SectionRef`` references.
.. code::
from neuron import h
s = h.Section(name="s")
s2 = h.Section(name="s2")
sref = h.SectionRef(sec=s2)
print(sref.sec==s) # False
print(sref.sec==s2) # True
----
.. data:: SectionRef.parent
Syntax:
``sref.parent``
Description:
Returns the parent of ``sref.sec``.
.. warning::
If there is a chance that a section does not have a parent then
:meth:`SectionRef.has_parent` should be called first to avoid an execution error.
Note that the parent is the current parent of sref.sec, not necessarily
the parent when the SectionRef was created.
----
.. data:: SectionRef.trueparent
Syntax:
``sref.trueparent``
Description:
Returns the trueparent of ``sref.sec``.
This is normally identical to :meth:`SectionRef.parent` except when the
parent's :func:`parent_connection` is equal to the parent's
:func:`section_orientation`.
If there is a chance that a section does not have a trueparent then
:meth:`SectionRef.has_trueparent` should be called first to avoid an execution error.
----
.. data:: SectionRef.child
Syntax:
``sref.child[i]``
Description:
Returns the ith child of ``sref.sec``.
Generally it is used in a context like
.. code::
for child in sref.child:
print(child)
Note that the children are the current children of sref.sec, not necessarily
the same as when the SectionRef was created since sections may be
deleted or re-connected subsequent to the instantiation of the SectionRef.
----
.. data:: SectionRef.root
Syntax:
``sref.root``
Description:
Returns the root of ``sref.sec``.
----
.. method:: SectionRef.has_parent
Syntax:
``boolean = sref.has_parent()``
Description:
Returns ``True`` if sref.sec has a parent and ``False`` if sref.sec is a root section.
Invoking sref.parent when sref.sec is a root section will print an
error message and halt execution.
Note:
If ``sec`` is a Section, then ``sec.parentseg()`` is either the segment the section is
attached to or ``None`` if ``sec`` does not have a parent.
----
.. method:: SectionRef.has_trueparent
Syntax:
``boolean = sref.has_trueparent()``
Description:
returns ``True`` if the sref.sec parent node is not the root node and ``False`` otherwise.
Invoking sref.trueparent when it is the root node will print an
error message and halt execution.
----
.. method:: SectionRef.nchild
Syntax:
``num = sref.nchild()``
Description:
Return the number of child sections connected to sref.sec as a float.
.. note::
To get the number of child sections as an int, use: ``num = len(sref.child)``
----
.. method:: SectionRef.is_cas
Syntax:
``boolean = sref.is_cas()``
Description:
Returns True if this section reference is the currently accessed (default) section, False otherwise.
.. note::
An equivalent expression is ``(sref.sec == h.cas())``.
----
.. method:: SectionRef.exists
Syntax:
``boolean = sref.exists()``
Description:
Returns True if the referenced section has not been deleted, False otherwise.
.. seealso::
:func:`delete_section`, :func:`section_exists`
|
