neuroarch.na.NeuroArch.add_Neuron

NeuroArch.add_Neuron(uname, name, referenceId=None, locality=None, synonyms=None, info=None, morphology=None, arborization=None, neurotransmitters=None, neurotransmitters_datasources=None, data_source=None, circuit=None)[source]

Create a Neuron Record and link it to the related node types.

Parameters:

  • uname (str) – A unqiue name assigned to the neuron, must be unique within the DataSource

  • name (str) – Name of the neuron, typically the cell type.

  • referenceId (str (optional)) – Unique identifier in the original data source

  • locality (bool (optional)) – Whether or not the neuron is a local neuron

  • synonyms (list of str (optional)) – Synonyms of the neuron

  • info (dict (optional)) – Additional information about the neuron, values must be str

  • morphology (list of dict (optional)) – Each dict in the list defines a type of morphology of the neuron. Must be loaded from a file. The dict must include the following key to indicate the type of morphology: {‘type’: ‘swc’/’obj’/…} Additional keys must be provides, either ‘filename’ with value indicating the file to be read for the morphology, or a full definition of the morphology according the schema. For swc, required fields are [‘sample’, ‘identifier’, ‘x’, ‘y, ‘z’, ‘r’, ‘parent’]. More formats pending implementation.

  • arborization (list of dict (optional)) – A list of dictionaries define the arborization pattern of the neuron in neuropils, subregions, and tracts, if applicable, with {‘type’: ‘neuropil’ or ‘subregion’ or ‘tract’, ‘dendrites’: {‘EB’: 20, ‘FB’: 2}, ‘axons’: {‘NO’: 10, ‘MB’: 22}} Name of the regions must already be present in the database.

  • neurotransmitters (str or list of str (optional)) – The neurotransmitter(s) expressed by the neuron

  • neurotransmitters_datasources (models.DataSource or list of models.DataSource (optional)) – The datasource of neurotransmitter data. If None, all neurotransmitter will have the same datasource of the Neuron. If specified, the size of the list must be the same as the size of neurotransmitters, and have one to one corresponsdence in the same order.

  • data_source (models.DataSource (optional)) – The datasource. If not specified, default DataSource will be used.

Returns:

neuron – Created Neuron object

Return type:

models.Neuron