morph-tool 2.3.0

Installation

In a fresh virtualenv:

pip install morph-tool

Usage

In a shell, do:

morph-tool --help

Currently the three sub-command are:

morph-tool convert input_file output_file
morph-tool diff morph1 morph2
morph-tool soma-surface input_file

Morphology diffing

One can compare two morphologies with the CLI

morph-tool diff morph1 morph2

whose error code is 0 if morphologies are the same, else 1.

Morphologies with different formats can be compared.

Morphologies are considered different if one or more of the following properties differ:

• number of root sections

• sections type

• sections point array

• sections diameter array

• sections perimeter array

• sections number of children

The soma are not taken into consideration

The same functionality is also avalaible through the python API:

from morph_tool import diff

# The result can be used as a boolean:
if diff(filename1, filename2):
    print('morphologies differ')

# And also contains information about how morphologies differ
result = diff(filename1, filename2)
print(result.info)

Converter

from morph_tool import convert
convert(inputfile, outputfile)

# Additionally the morphology can be recentered or written according to the NEURON neurite order during the conversion
convert(inputfile, outputfile, recenter=True, nrn_order=True)

morph-tool convert file ./inputfile ./outputfile
# with additional options
morph-tool convert file --recenter --nrn-order ./inputfile ./outputfile
# or an entire folder
morph-tool convert folder -ext SWC ./h5_input_folder ./swc_output_folder
# for more info use
morph-tool convert folder --help

NRN simulator compartment coordinates

The NRN simulator splits each section into chunks of equal length (equal only among a given section). These compartments do not really exist in the physical world but we can remap them to paths along the section. Each compartment can be associated to a path (a list of 3D points) such that the path and the compartment have the same path-length.

The following function can be used to access the mapping NeuroM section ID -> list of paths for the section:

morph_tool.nrnhines.NeuroM_section_to_NRN_compartment_paths

Example (in 2D) for one section:

               (1, 2) ------ (2, 2)
                  |
                  |
                  |
                  |
                  |
                  |
                  |
                  |
                  |
(0, 0) ------- (1, 0)

Splitting this section into 3 compartments would results in the following paths:

[[0.        , 0.        ],
 [1.        , 0.        ],
 [1.        , 0.33333333]]

[[1.        , 0.33333333],
 [1.        , 1.66666667]]

[[1.        , 1.66666667],
 [1.        , 2.        ],
 [2.        , 2.        ]]

Dendrogram with synapses

This functionality is available only when the package is installed with dendrogram extras:

pip install morph-tool

Draw NeuroM dendrogram with synapses on it. Synapses must be represented as a DataFrame. Required columns in this dataframe are:

from morph_tool import dendrogram
required_columns = [dendrogram.SOURCE_NODE_ID, dendrogram.TARGET_NODE_ID,
                    dendrogram.POST_SECTION_ID, dendrogram.POST_SECTION_POS,
                    dendrogram.PRE_SECTION_ID, dendrogram.PRE_SECTION_POS]

or equivalently

required_columns = ['@source_node', '@target_node',
                    'afferent_section_id', 'afferent_section_pos',
                    'efferent_section_id', 'efferent_section_pos']

For usage examples look at examples/dendrogram.py.

Contributing

If you want to improve the project or you see any issue, every contribution is welcome. Please check the contribution guidelines for more information.

Acknowledgements

This research was supported by the EBRAINS research infrastructure, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).

License

morph-tool is licensed under the terms of the GNU Lesser General Public License version 3. Refer to COPYING.LESSER and COPYING for details.