oursin.neurons

Functions

create	Create neuron objects
delete	Delete neuron objects
set_color	Set colors of neuron objects
set_material	Change the material used to render neurons
set_position	Set neuron positions
set_shape	Change the mesh used to render neurons
set_size	Set size of neuron objects in mm units

create(neuron_names)

Create neuron objects

Note: neurons must be created before setting other values

Parameters

neuron_namesstring list

names of the new neuron objects

Examples

>>> urn.create(["n1","n2","n3"])

delete(neuron_names)

Delete neuron objects

Parameters

neuron_namesstring list

names of the neuron objects

Examples

>>> urn.delete(["n1","n2","n3"])

set_position(neuron_positions)

Set neuron positions

Parameters

neuron_positionsdict {string: int list}

keys are neuron names, values are ML/AP/DV coordinates in um units relative to CCF (0,0,0)

Examples

>>> urn.set_positions({'n1':[500,1500,1800]})

set_size(neuron_sizes)

Set size of neuron objects in mm units

Parameters

neuron_sizesdict {string: float}

keys are neuron names, values are float size in mm

Examples

>>> urn.set_size( {'n1':0.02})

set_color(neuron_colors)

Set colors of neuron objects

Parameters

neuron_colorsdict {string: string}

keys are neuron names, values are hex colors

Examples

>>> urn.set_color( {'n1':"#FFFFFF"})

set_shape(neuron_shapes)

Change the mesh used to render neurons

Options are

• ‘sphere’ (default)

• ‘cube’ better performance when rendering tens of thousands of neurons

Parameters

neuron_shapesdict {string: string}

keys are neuron names, values are shape strings

Examples

>>> urn.set_shape( {'n1':'sphere'})

set_material(neuron_materials)

Change the material used to render neurons

Options are - ‘lit-transparent’ (default) - ‘lit’ - ‘unlit’

Parameters

neuron_materialsdict {string: string}

keys are neuron names, values are material strings

Examples

>>> urn.set_neuron_materials( {'n1':'lit-transparent'})