# spatialneuron package

Exported members: `Cylinder`, `Morphology`, `Section`, `Soma`, `SpatialNeuron`

## `morphology` module

Neuronal morphology module. This module defines classes to load and build neuronal morphologies.

Exported members: `Cylinder`, `Morphology`, `Section`, `Soma`

Classes

`Children`(owner) | Helper class to represent the children (sub trees) of a section.

`Cylinder`(diameter[, n, length, x, y, z, type]) | A cylindrical section.

`Morphology`(n[, type]) | Neuronal morphology (tree structure).

`MorphologyIndexWrapper`(morphology) | A simpler version of `IndexWrapper`, not allowing for string indexing (`Morphology` is not a `Group`).

`Node`(index, comp_name, x, y, z, diameter, ...) |

`Section`(diameter[, n, length, x, y, z, ...]) | A section (unbranched structure), described as a sequence of truncated cones with potentially varying diameters and lengths per compartment.

`Soma`(diameter[, x, y, z, type]) | A spherical, iso-potential soma.

`SubMorphology`(morphology, i, j) | A view on a subset of a section in a morphology.

`Topology`(morphology) | A representation of the topology of a `Morphology`.

## `spatialneuron` module

Compartmental models. This module defines the `SpatialNeuron` class, which defines multicompartmental models.

Exported members: `SpatialNeuron`

Classes

`FlatMorphology`(morphology) | Container object to store the flattened representation of a morphology.

`SpatialNeuron`(*args, **kw) | A single neuron with a morphology and possibly many compartments.

`SpatialStateUpdater`(*args, **kw) | The `CodeRunner` that updates the state variables of a `SpatialNeuron` at every timestep.

`SpatialSubgroup`(*args, **kw) | A subgroup of a `SpatialNeuron`.