neurom.core.population¶
Morphology Population Classes and Functions.
Classes
|
Morphology Population Class. |
- class neurom.core.population.Population(files, name='Population', ignored_exceptions=(), cache=False)¶
Morphology Population Class.
Offers an iterator over morphs within population, neurites of morphs, somas of morphs. It does not store the loaded morphology in memory unless the morphology has been already passed as loaded (instance of
Morphology
).Construct a morphology population.
- Parameters:
files (collections.abc.Sequence[str|Path|Morphology]) – collection of morphology files or paths to them or instances of
Morphology
.name (str) – Optional name for this Population
ignored_exceptions (tuple) – NeuroM and MorphIO exceptions that you want to ignore when loading morphs.
cache (bool) – whether to cache the loaded morphs in memory. If false then a morphology will be loaded everytime it is accessed within the population. Which is good when population is big. If true then all morphs will be loaded upon the construction and kept in memory.
- property morphologies¶
Iterator to populations’s morphologies.
- property neurites¶
Iterator to populations’s neurites.
- property somata¶
Iterator to populations’s somata. Somata is the plural form of soma.