tmd.Neuron.Neuron

TMD class : Neuron.

Classes

Neuron([name])

A Neuron object is a container for Trees and a Soma.

class tmd.Neuron.Neuron.Neuron(name='Neuron')

Bases: object

A Neuron object is a container for Trees and a Soma.

The Trees can be basal_dendrite, apical_dendrite and axon.

Parameters:

name (str) – The name of the Neuron.

property apical

Get apical dendrites.

append_tree(new_tree, tree_types)

Append a Tree object to the Neuron.

If type of object is tree this function finds the type of tree and adds the new_tree to the correct list of trees in neuron.

property basal

Get basal dendrites.

copy_neuron()

Returns a deep copy of the Neuron.

property dendrites

Get dendrites.

get_bounding_box()

Get the bounding box of the neurites.

Parameters:

neuron – A TMD neuron.

Returns:

np.array

([xmin,ymin,zmin], [xmax,ymax,zmax])

Return type:

bounding_box

is_equal(neu)

Tests if all neuron structures are the same.

is_same(neu)

Tests if all neuron data are the same.

property neurites

Get neurites.

rename(new_name)

Modifies the name of the Neuron to new_name.

set_soma(new_soma)

Set the given Soma object as the soma of the current Neuron.

simplify()

Creates a copy of itself and simplifies all trees to create a skeleton of the neuron.

size(neurite_type='all')

Neuron method to get size.