Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update segment to msegment as name present in arbor module #2237

Merged
merged 1 commit into from
Dec 8, 2023
Merged

Update segment to msegment as name present in arbor module #2237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/python/morphology.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Cable cell morphology

Radius of the cable (μm)

.. class:: segment
.. class:: msegment

.. attribute:: prox
:type: mpoint
Expand Down Expand Up @@ -295,7 +295,7 @@ Cable cell morphology
A list of parent indexes of the segments.

.. attribute:: segments
:type: list
:type: list[msegment]

A list of the segments.

Expand Down Expand Up @@ -350,7 +350,7 @@ Cable cell morphology
A list of the segments in a branch, ordered from proximal to distal.

:param int i: branch index
:rtype: list
:rtype: list[msegment]

.. py:class:: place_pwlin

Expand All @@ -374,13 +374,13 @@ Cable cell morphology
Return all points corresponding to the given :class:`location` ``loc``
the placement.

.. py:method:: segments(cables: list[cable]) -> list[segment]
.. py:method:: segments(cables: list[cable]) -> list[msegment]

Return any minimal collection of segments and partial segments whose
union is coterminous with the sub-region of the morphology covered by
the given cables in the placement.

.. py:method:: all_segments(cables: list[cable]) -> list[segment]
.. py:method:: all_segments(cables: list[cable]) -> list[msegment]

Return the maximal set of segments and partial segments whose
union is coterminous with the sub-region of the morphology covered by
Expand Down Expand Up @@ -602,7 +602,7 @@ SWC

The samples in the SWC files are treated as the end points of segments, where a
sample and its parent form a segment.
The :py:attr:`tag <segment.tag>` of each segment is the
The :py:attr:`tag <msegment.tag>` of each segment is the
`structure identifier <http://www.neuronland.org/NLMorphologyConverter/MorphologyFormats/SWC/Spec.html>`_
of the distal sample.
The structure identifier of the first (root) sample is ignored, as it can only be the
Expand Down