Description Format¶
Arbor provides readers and writers for describing label dictionaries, decoration objects, morphologies and cable cells, referred to here as arbor-components.
A detailed description of the s-expression format used to describe each of these components can be found here.
The arbor-components and meta-data¶
-
class
arbor.
meta_data
¶ -
string version
Stores the version of the format being used.
-
-
class
arbor.
cable_cell_component
¶ -
meta_data meta
Stores meta-data pertaining to the description of a cable cell component.
-
component
¶ Stores one of
decor
,label_dict
,morphology
orcable_cell
.
-
Reading and writing arbor-components¶
-
arbor.
load_component
(filename)¶ Load
cable_cell_component
(decor, morphology, label_dict, cable_cell) from file.- Parameters
filename (str) – the name of the file containing the component description.
- Return type
-
arbor.
write_component
(comp, filename)¶ Write the
cable_cell_component
to file.- Parameters
comp (cable_cell_component) – the component to be written to file.
filename (str) – the name of the file.
-
arbor.
write_component
(dec, filename) Write the
decor
to file. Use the most recent version of the cable cell format to construct the meta-data.- Parameters
dec (decor) – the decor to be written to file.
filename (str) – the name of the file.
-
arbor.
write_component
(dict, filename) Write the
label_dict
to file. Use the most recent version of the cable cell format to construct the meta-data.- Parameters
dict (label_dict) – the label dictionary to be written to file.
filename (str) – the name of the file.
-
arbor.
write_component
(morpho, filename) Write the
morphology
to file. Use the most recent version of the cable cell format to construct the meta-data.- Parameters
morpho (morphology) – the morphology to be written to file.
filename (str) – the name of the file.
-
arbor.
write_component
(cell, filename) Write the
cable_cell
to file. Use the most recent version of the cable cell format to construct the meta-data.- Parameters
cell (cable_cell) – the cable_cell to be written to file.
filename (str) – the name of the file.