swcgeom 0.18.3__py3-none-any.whl → 0.19.0__py3-none-any.whl

swcgeom/analysis/sholl.py

@@ -16,7 +16,7 @@
 """Sholl analysis."""
 
 import warnings
-from typing import Literal, Optional
+from typing import Literal
 
 import numpy as np
 import numpy.typing as npt
@@ -39,13 +39,12 @@ YLABLE = "Count of Intersections"
 class Sholl:
     """Sholl analysis.
 
-    Implementation of original Sholl analysis as described in [1]_. The
-    Sholl analysis is a method to quantify the spatial distribution of
-    neuronal processes. It is based on the number of intersections of
-    concentric circles with the neuronal processes.
+    Implementation of original Sholl analysis as described in [1]_. The Sholl analysis
+    is a method to quantify the spatial distribution of neuronal processes. It is
+    based on the number of intersections of concentric circles with the neuronal
+    processes.
 
-    References
-    ----------
+    References:
     .. [1] Dendritic organization in the neurons of the visual and
        motor cortices of the cat J. Anat., 87 (1953), pp. 387-406
     """
@@ -57,11 +56,7 @@ class Sholl:
     # compat
     step: float | None = None
 
-    def __init__(
-        self,
-        tree: Tree | str,
-        step: Optional[float] = None,
-    ) -> None:
+    def __init__(self, tree: Tree | str, step: float | None = None) -> None:
         tree = Tree.from_swc(tree) if isinstance(tree, str) else tree
         try:
             self.tree = TranslateOrigin.transform(tree)  # shift
@@ -109,18 +104,14 @@ class Sholl:
     ) -> tuple[Figure, Axes]:
         """Plot Sholl analysis.
 
-        Parameters
-        ----------
-        steps : int or list[float], default to 20
-            Steps of raius of circle. If steps is int, then it will be
-            evenly divided into n radii.
-        kind : "bar" | "linechart" | "circles", default `circles`
-        fig : ~matplotlib.figure.Figure
-        ax : ~matplotlib.axes.Axes
-        **kwargs :
-            Forwarding to plot method.
+        Args:
+            steps: Steps of raius of circle.
+                If steps is int, then it will be evenly divided into n radii.
+            kind: Kind of plot.
+            fig: The figure to plot on.
+            ax: The axes to plot on.
+            **kwargs: Forwarding to plot method.
         """
-
         if plot_type is not None:
             warnings.warn(
                 "`plot_type` has been renamed to `kind` since v0.5.0, "
@@ -136,9 +127,11 @@ class Sholl:
             case "bar":
                 sns.barplot(x=xs, y=ys, ax=ax, **kwargs)
                 ax.set_ylabel(YLABLE)
+
             case "linechart":
                 sns.lineplot(x=xs, y=ys, ax=ax, **kwargs)
                 ax.set_ylabel(YLABLE)
+
             case "circles":
                 kwargs.setdefault("y_min", 0)
                 drawtree = kwargs.pop("drawtree", True)
@@ -155,6 +148,7 @@ class Sholl:
                     fig.colorbar(patches, ax=ax, label=YLABLE)
                 elif isinstance(colorbar, (Axes, np.ndarray, list)):
                     fig.colorbar(patches, ax=colorbar, label=YLABLE)
+
             case _:
                 raise ValueError(f"unsupported kind: {kind}")
 

swcgeom/analysis/trunk.py

@@ -19,7 +19,7 @@
 
 from collections.abc import Iterable
 from itertools import chain
-from typing import Any, Literal, Optional, cast
+from typing import Any, Literal, cast
 
 import numpy as np
 import numpy.typing as npt
@@ -42,8 +42,8 @@ def draw_trunk(
     t: Tree,
     florets: Iterable[int | Iterable[int]],
     *,
-    fig: Optional[Figure] = None,
-    ax: Optional[Axes] = None,
+    fig: Figure | None = None,
+    ax: Axes | None = None,
     bound: Bounds | tuple[Bounds, dict[str, Any]] | None = "ellipse",
     point: bool | dict[str, Any] = True,
     projection: Projection = "2d",
@@ -52,29 +52,24 @@ def draw_trunk(
 ) -> tuple[Figure, Axes]:
     """Draw trunk tree.
 
-    Parameters
-    ----------
-    t : Tree
-    florets : List of (int | list of int)
-        The florets that needs to be removed, each floret can be a
-        subtree or multiple subtrees (e.g., dendrites are a bunch of
-        subtrees), each number is the id of a tree node.
-    fig : ~matplotlib.figure.Figure, optional
-    ax : ~matplotlib.axes.Axes, optional
-    bound : Bounds | (Bounds, dict[str, Any]) | None, default 'ellipse'
-        Kind of bound, support 'aabb', 'ellipse'. If bound is None, no
-        bound will be drawn. If bound is a tuple, the second item will
-        used as kwargs and forward to draw function.
-    point : bool | dict[str, Any], default True
-        Draw point at the start of a subtree. If point is False, no
-        point will be drawn. If point is a dict, this will used a
-        kwargs and forward to draw function.
-    cmap : Any, default 'viridis'
-        Colormap, any value supported by ~matplotlib.cm.Colormap. We
-        will use the ratio of the length of the subtree to the total
-        length of the tree to determine the color.
-    **kwargs : dict[str, Any]
-        Forward to ~swcgeom.analysis.draw.
+    Args:
+        t: Tree
+        florets: The florets that needs to be removed.
+            Each floret can be a subtree or multiple subtrees (e.g., dendrites are a
+            bunch of subtrees), each number is the id of a tree node.
+        fig: Figure to plot on.
+        ax: Axes to plot on.
+        bound: Kind of bound, support 'aabb', 'ellipse'.
+            If bound is None, no bound will be drawn. If bound is a tuple, the second
+            item will used as kwargs and forward to draw function.
+        point: Draw point at the start of a subtree.
+            If point is False, no point will be drawn. If point is a dict, this will
+            used a kwargs and forward to draw function.
+        cmap: Colormap.
+            Any value supported by ~matplotlib.cm.Colormap. We will use the ratio of
+            the length of the subtree to the total length of the tree to determine the
+            color.
+        **kwargs: Forward to ~swcgeom.analysis.draw.
     """
     # pylint: disable=too-many-locals
     trunk, tss = split_florets(t, florets)
@@ -138,7 +133,7 @@ def create_bound_2d(ts: Iterable[Tree], bound: Bounds, **kwargs) -> Patch:
         return create_aabb_2d(xy, **kwargs)
     if bound == "ellipse":
         return create_ellipse_2d(xy, **kwargs)
-    raise ValueError(f"unsupport bound `{bound}` in 2d projection")
+    raise ValueError(f"unsupported bound `{bound}` in 2d projection")
 
 
 def create_aabb_2d(xy: npt.NDArray, fill: bool = False, **kwargs) -> Rectangle:
@@ -177,7 +172,7 @@ def draw_point(ts: Iterable[Tree], ax: Axes, projection: Projection, **kwargs) -
 
 
 def create_point_2d(
-    ts: Iterable[Tree], radius: Optional[float] = None, **kwargs
+    ts: Iterable[Tree], radius: float | None = None, **kwargs
 ) -> Circle:
     if radius is None:
         xyz = np.concatenate([t.xyz() for t in ts])  # TODO: cache

swcgeom/analysis/visualization.py

@@ -1,4 +1,5 @@
 # Copyright 2022-2025 Zexin Yuan
+
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,7 +18,7 @@
 
 import os
 import weakref
-from typing import Any, Literal, Optional
+from typing import Any, Literal
 
 import numpy as np
 from matplotlib.axes import Axes
@@ -50,52 +51,45 @@ ax_weak_memo = weakref.WeakKeyDictionary[Axes, dict[str, Any]]({})
 def draw(
     swc: SWCLike | str,
     *,
-    fig: Optional[Figure] = None,
-    ax: Optional[Axes] = None,
+    fig: Figure | None = None,
+    ax: Axes | None = None,
     show: bool | None = None,
     camera: CameraOptions = "xy",
-    color: Optional[dict[int, str] | str] = None,
+    color: dict[int, str] | str | None = None,
     label: str | bool = True,
     direction_indicator: Positions | Literal[False] = "rb",
-    unit: Optional[str] = None,
+    unit: str | None = None,
     **kwargs,
 ) -> tuple[Figure, Axes]:
     r"""Draw neuron tree.
 
-    Parameters
-    ----------
-    swc : SWCLike | str
-        If it is str, then it is treated as the path of swc file.
-    fig : ~matplotlib.axes.Figure, optional
-    ax : ~matplotlib.axes.Axes, optional
-    show : bool | None, default `None`
-        Wheather to call `plt.show()`. If not specified, it will depend
-        on if ax is passed in, it will not be called, otherwise it will
-        be called by default.
-    camera : CameraOptions | CameraPreset, default "xy"
-        Camera options (position, look-at, up). One, two, or three
-        vectors are supported, if only one vector, then threat it as
-        look-at, so camera is ((0, 0, 0), look-at, (0, 1, 0)); if two
-        vector, then then threat it as (look-at, up), so camera is
-        ((0, 0, 0), look-at, up). An easy way is to use the presets
-        "xy", "yz" and "zx".
-    color : dict[int, str] | "vaa3d" | str, optional
-        Color map. If is dict, segments will be colored by the type of
-        parent node.If is string, the value will be use for any type.
-    label : str | bool, default True
-        Label of legend, disable if False.
-    direction_indicator : str or (float, float), default 'rb'
-        Draw a xyz direction indicator, can be place on 'lt', 'lb',
-        'rt', 'rb', or custom position.
-    unit : str, optional
-        Add unit text, e.g.: r"$\mu m$".
-    **kwargs : dict[str, Unknown]
-        Forwarded to `~matplotlib.collections.LineCollection`.
-
-    Returns
-    -------
-    fig : ~matplotlib.axes.Figure
-    ax : ~matplotlib.axes.Axes
+    Args:
+        swc: The swc tree to draw.
+            If it is str, then it is treated as the path of swc file.
+        fig: The figure to plot on.
+        ax: The axes to plot on.
+        show: Weather to call `plt.show()`.
+            If not specified, it will depend on if ax is passed in, it will not be
+            called, otherwise it will be called by default.
+        camera: Camera options (position, look-at, up).
+            One, two, or three vectors are supported, if only one vector, then threat
+            it as look-at, so camera is ((0, 0, 0), look-at, (0, 1, 0)); if two vector,
+            then then threat it as (look-at, up), so camera is ((0, 0, 0), look-at, up).
+            An easy way is to use the presets "xy", "yz" and "zx".
+        color: Color map.
+            If is dict, segments will be colored by the type of parent node.If is
+            string, the value will be use for any type.
+        label: Label of legend, disable if False.
+        direction_indicator: Draw a xyz direction indicator.
+            Can be place on 'lt', 'lb', 'rt', 'rb', or custom position.
+        unit: str, optional
+            Add unit text, e.g.: r"$\mu m$".
+        **kwargs: dict[str, Unknown]
+            Forwarded to `~matplotlib.collections.LineCollection`.
+
+    Returns:
+        fig: The figure to plot on.
+        ax: The axes to plot on.
     """
     # pylint: disable=too-many-locals
     swc = Tree.from_swc(swc) if isinstance(swc, str) else swc
@@ -141,7 +135,9 @@ def get_ax_swc(ax: Axes) -> list[SWCLike]:
 
 
 def get_ax_color(
-    ax: Axes, swc: SWCLike, color: Optional[dict[int, str] | str] = None
+    ax: Axes,
+    swc: SWCLike,
+    color: dict[int, str] | str | None = None,  # TODO: improve typing
 ) -> str | list[str]:
     if color == "vaa3d":
         color = palette.vaa3d
@@ -176,10 +172,7 @@ def set_ax_legend(ax: Axes, *args, **kwargs) -> Legend | None:
 
 
 def _set_ax_memo(
-    ax: Axes,
-    swc: SWCLike,
-    label: Optional[str | bool] = None,
-    handle: Optional[Any] = None,
+    ax: Axes, swc: SWCLike, label: str | bool | None = None, handle: Any | None = None
 ):
     ax_weak_memo.setdefault(ax, {})
     ax_weak_memo[ax].setdefault("swc", [])

swcgeom/analysis/visualization3d.py

@@ -15,13 +15,9 @@
 
 """Painter utils.
 
-Notes
------
-This is a experimental function, it may be changed in the future.
+NOTE: This is a experimental function, it may be changed in the future.
 """
 
-from typing import Optional
-
 import numpy as np
 from matplotlib.axes import Axes
 from matplotlib.figure import Figure
@@ -45,37 +41,32 @@ def draw3d(
     *,
     ax: Axes,
     show: bool | None = None,
-    color: Optional[dict[int, str] | str] = None,
+    color: dict[int, str] | str | None = None,  # TODO: improve typing
     label: str | bool = True,
     **kwargs,
 ) -> tuple[Figure, Axes]:
     r"""Draw neuron tree.
 
-    Parameters
-    ----------
-    swc : SWCLike | str
-        If it is str, then it is treated as the path of swc file.
-    fig : ~matplotlib.axes.Figure, optional
-    ax : ~matplotlib.axes.Axes, optional
-    show : bool | None, default `None`
-        Wheather to call `plt.show()`. If not specified, it will depend
-        on if ax is passed in, it will not be called, otherwise it will
-        be called by default.
-    color : dict[int, str] | "vaa3d" | str, optional
-        Color map. If is dict, segments will be colored by the type of
-        parent node.If is string, the value will be use for any type.
-    label : str | bool, default True
-        Label of legend, disable if False.
-    **kwargs : dict[str, Unknown]
-        Forwarded to `~mpl_toolkits.mplot3d.art3d.Line3DCollection`.
+    Args:
+        swc: The swc tree to draw.
+            If it is str, then it is treated as the path of swc file.
+        fig: The figure to plot on.
+        ax: The axes to plot on.
+        show: Weather to call `plt.show()`.
+            If not specified, it will depend on if ax is passed in, it will not be
+            called, otherwise it will be called by default.
+        color: Color map.
+            If is dict, segments will be colored by the type of parent node.If is
+            string, the value will be use for any type.
+        label: Label of legend, disable if False.
+        **kwargs: Forwarded to `~mpl_toolkits.mplot3d.art3d.Line3DCollection`.
     """
-
     assert isinstance(ax, Axes3D), "only support 3D axes."
 
     swc = Tree.from_swc(swc) if isinstance(swc, str) else swc
 
     show = (show is True) or (show is None and ax is None)
-    my_color = get_ax_color(ax, swc, color)  # type: ignore
+    my_color = get_ax_color(ax, swc, color)
 
     xyz = swc.xyz()
     starts, ends = swc.id()[1:], swc.pid()[1:]

swcgeom/analysis/volume.py

@@ -37,45 +37,34 @@ def get_volume(
 ) -> float:
     """Get the volume of the tree.
 
-    Parameters
-    ----------
-    tree : Tree
-        Neuronal tree.
-    method : {"frustum_cone"}, optional
-        Method for volume calculation.
-    accuracy : int or {"low", "middle", "high"}, optional
-        Accuracy level for volume calculation. The higher the accuracy,
-        the more accurate the volume calculation, but the slower the
-        calculation. The accuracy level can be specified either as an
-        integer or as a string.
-
-        The string values correspond to the following accuracy levels:
-
-        - "low": 3
-        - "middle": 5
-        - "high": 8
-
-    Returns
-    -------
-    volume : float
-        Volume of the tree.
-
-    Notes
-    -----
-    The SWC format is a method for representing neurons, which includes
-    both the radius of individual points and their interconnectivity.
-    Consequently, there are multiple distinct approaches to
-    representation within this framework.
-
-    Currently, we support a standard approach to volume calculation.
-    This method involves treating each node as a sphere and
-    representing the connections between them as truncated cone-like
-    structures, or frustums, with varying radii at their top and bottom
-    surfaces.
+    Args:
+        tree: Neuronal tree.
+        method: Method for volume calculation.
+        accuracy: Accuracy level for volume calculation. The higher the accuracy,
+            the more accurate the volume calculation, but the slower the
+            calculation. The accuracy level can be specified either as an
+            integer or as a string.
+
+            The string values correspond to the following accuracy levels:
+
+            - "low": 3
+            - "middle": 5
+            - "high": 8
+
+    Returns:
+        volume: Volume of the tree.
+
+    NOTE: The SWC format is a method for representing neurons, which includes both the
+    radius of individual points and their interconnectivity. Consequently, there are
+    multiple distinct approaches to representation within this framework.
+
+    Currently, we support a standard approach to volume calculation. This method
+    involves treating each node as a sphere and representing the connections between
+    them as truncated cone-like structures, or frustums, with varying radii at their
+    top and bottom surfaces.
 
     We welcome additional representation methods through pull requests.
     """
-
     if isinstance(accuracy, str):
         accuracy = ACCURACY_LEVELS[accuracy]
 
@@ -91,18 +80,15 @@ def get_volume(
 def _get_volume_frustum_cone(tree: Tree, *, accuracy: int) -> float:
     """Get the volume of the tree using the frustum cone method.
 
-    Parameters
-    ----------
-    tree : Tree
-        Neuronal tree.
-    accuracy : int
-        1 : Sphere only
-        2 : Sphere and Frustum Cone
-        3 : Sphere, Frustum Cone, and intersection in single-branch
-        5 : Above and Sphere-Frustum Cone intersection in multi-branch
-        10 : Fully calculated by Monte Carlo method
+    Args:
+        tree: Neuronal tree.
+        accuracy: Accuracy level.
+            1 : Sphere only
+            2 : Sphere and Frustum Cone
+            3 : Sphere, Frustum Cone, and intersection in single-branch
+            5 : Above and Sphere-Frustum Cone intersection in multi-branch
+            10 : Fully calculated by Monte Carlo method
     """
-
     if accuracy == 10:
         return _get_volume_frustum_cone_mc_only(tree)
 

swcgeom/core/__init__.py

@@ -20,12 +20,7 @@ from swcgeom.core.branch import *  # noqa: F403
 from swcgeom.core.branch_tree import *  # noqa: F403
 
 # Segment and Segments don't expose
-from swcgeom.core.compartment import (
-    Compartment as Compartment,
-)
-from swcgeom.core.compartment import (
-    Compartments as Compartments,
-)
+from swcgeom.core.compartment import Compartment, Compartments  # noqa: F401
 from swcgeom.core.node import *  # noqa: F403
 from swcgeom.core.path import *  # noqa: F403
 from swcgeom.core.population import *  # noqa: F403

swcgeom/core/branch.py

@@ -31,10 +31,8 @@ __all__ = ["Branch"]
 class Branch(Path, Generic[SWCTypeVar]):
     r"""Neural branch.
 
-    Notes
-    -----
-    Only a part of data of branch nodes is valid, such as `x`, `y`, `z` and
-    `r`, but the `id` and `pid` is usually invalid.
+    NOTE: Only a part of data of branch nodes is valid, such as `x`, `y`, `z` and `r`,
+    but the `id` and `pid` is usually invalid.
     """
 
     attach: SWCTypeVar
@@ -76,12 +74,10 @@ class Branch(Path, Generic[SWCTypeVar]):
     def from_xyzr(cls, xyzr: npt.NDArray[np.float32]) -> "Branch[DictSWC]":
         r"""Create a branch from ~numpy.ndarray.
 
-        Parameters
-        ----------
-        xyzr : npt.NDArray[np.float32]
-            Collection of nodes. If shape (n, 4), both `x`, `y`, `z`, `r` of
-            nodes is enabled. If shape (n, 3), only `x`, `y`, `z` is enabled
-            and `r` will fill by 1.
+        Args:
+            xyzr: Collection of nodes.
+                If shape (n, 4), both `x`, `y`, `z`, `r` of nodes is enabled. If shape
+                (n, 3), only `x`, `y`, `z` is enabled and `r` will fill by 1.
         """
         assert xyzr.ndim == 2 and xyzr.shape[1] in (
             3,
@@ -111,14 +107,11 @@ class Branch(Path, Generic[SWCTypeVar]):
     ) -> list["Branch[DictSWC]"]:
         r"""Create list of branch form ~numpy.ndarray.
 
-        Parameters
-        ----------
-        xyzr : npt.NDArray[np.float32]
-            Batch of collection of nodes. If shape (bs, n, 4), both `x`, `y`,
-            `z`, `r` of nodes is enabled. If shape (bs, n, 3), only `x`, `y`,
-            `z` is enabled and `r` will fill by 1.
+        Args:
+            xyzr: Batch of collection of nodes.
+                If shape (bs, n, 4), both `x`, `y`, `z`, `r` of nodes is enabled. If
+                shape (bs, n, 3), only `x`, `y`, `z` is enabled and `r` will fill by 1.
         """
-
         assert xyzr_batch.ndim == 3
         assert xyzr_batch.shape[1] >= 3
 

swcgeom/core/branch_tree.py

@@ -19,6 +19,7 @@ import itertools
 
 import numpy as np
 import pandas as pd
+from typing_extensions import Self
 
 from swcgeom.core.branch import Branch
 from swcgeom.core.swc_utils import to_sub_topology
@@ -44,7 +45,7 @@ class BranchTree(Tree):
         return self.branches[idx]
 
     @classmethod
-    def from_tree(cls, tree: Tree) -> "BranchTree":
+    def from_tree(cls, tree: Tree) -> Self:
         """Generating a branch tree from tree."""
 
         branches = tree.get_branches()
@@ -69,6 +70,6 @@ class BranchTree(Tree):
         return branch_tree
 
     @classmethod
-    def from_data_frame(cls, df: pd.DataFrame, *args, **kwargs) -> "BranchTree":
+    def from_data_frame(cls, df: pd.DataFrame, *args, **kwargs) -> Self:
         tree = super().from_data_frame(df, *args, **kwargs)
         return cls.from_tree(tree)

swcgeom/core/compartment.py

@@ -60,7 +60,7 @@ T = TypeVar("T", bound=Compartment)
 
 
 class Compartments(list[T]):
-    r"""Comparments contains a set of comparment."""
+    r"""Comparments contains a set of compartment."""
 
     names: SWCNames
 

swcgeom/core/node.py

@@ -119,11 +119,9 @@ class Node(Generic[SWCTypeVar]):
     def is_bifurcation(self) -> bool:
         """Is furcation node.
 
-        Notes
-        -----
-        Deprecated due to the wrong spelling of furcation. For now, it
-        is just an alias of `is_furcation` and raise a warning. It will
-        be change to raise an error in the future.
+        NOTE: Deprecated due to the wrong spelling of furcation. For now, it is just an
+        alias of `is_furcation` and raise a warning. It will be change to raise an
+        error in the future.
         """
         return self.is_furcation()
 
@@ -132,7 +130,6 @@ class Node(Generic[SWCTypeVar]):
 
     def detach(self) -> "Node[DictSWC]":
         """Detach from current attached object."""
-        # pylint: disable=consider-using-dict-items
         attact = DictSWC(
             **{k: np.array([self[k]]) for k in self.keys()},
             source=self.attach.source,

swcgeom/core/path.py

@@ -56,15 +56,12 @@ class Path(SWCLike, Generic[SWCTypeVar]):
     def __repr__(self) -> str:
         return f"Neuron path with {len(self)} nodes."
 
-    # fmt:off
     @overload
     def __getitem__(self, key: int) -> Node: ...
     @overload
     def __getitem__(self, key: slice) -> list[Node]: ...
     @overload
     def __getitem__(self, key: str) -> npt.NDArray: ...
-    # fmt:on
-
     def __getitem__(self, key):
         if isinstance(key, slice):
             return [self.node(i) for i in range(*key.indices(len(self)))]
@@ -118,22 +115,22 @@ class Path(SWCLike, Generic[SWCTypeVar]):
     def id(self) -> npt.NDArray[np.int32]:  # pylint: disable=invalid-name
         """Get the ids of shape (n_sample,).
 
-        Returns a consecutively incremented id.
+        Returns:
+            a consecutively incremented id.
 
-        See Also
-        --------
-        self.origin_id
+        See Also:
+            self.origin_id
         """
         return np.arange(len(self.origin_id()), dtype=np.int32)
 
     def pid(self) -> npt.NDArray[np.int32]:
         """Get the ids of shape (n_sample,).
 
-        Returns a consecutively incremented pid.
+        Returns:
+            a consecutively incremented pid.
 
-        See Also
-        --------
-        self.origin_pid
+        See Also:
+            self.origin_pid
         """
         return np.arange(-1, len(self.origin_id()) - 1, dtype=np.int32)
 
@@ -153,17 +150,15 @@ class Path(SWCLike, Generic[SWCTypeVar]):
     def straight_line_distance(self) -> float:
         """Straight-line distance of path.
 
-        The end-to-end straight-line distance between start point and
-        end point.
+        The end-to-end straight-line distance between start point and end point.
         """
         return np.linalg.norm(self.node(-1).xyz() - self.node(0).xyz()).item()
 
     def tortuosity(self) -> float:
         """Tortuosity of path.
 
-        The straight-line distance between two consecutive branch
-        points divided by the length of the neuronal path between
-        those points.
+        The straight-line distance between two consecutive branch points divided by the
+        length of the neuronal path between those points.
         """
         if (length := self.length()) == 0:
             return 1