pynn_brainscales.brainscales2.morphology.mc_neuron_base.CommonBase

class pynn_brainscales.brainscales2.morphology.mc_neuron_base.CommonBase(**parameters)

Bases: pynn_brainscales.brainscales2.standardmodels.cells_base.StandardCellType, abc.ABC

Common base class for multi-compartment neurons.

__init__(**parameters)

Initialize self. See help(type(self)) for accurate signature.

Methods

get_compartment_ids(labels)	Get compartment Ids of compartments with the specified labels.
get_label(compartment_id)	Retrieve label of a single compartment.
get_labels()	Retrieve list of all used labels.

Attributes

compartments
logical_compartments
logical_neuron

compartments: Dict = {}

abstract classmethod get_compartment_ids(labels: Sequence[str]) → List[pyhalco_hicann_dls_vx_v3.CompartmentOnLogicalNeuron]

Get compartment Ids of compartments with the specified labels.

Parameters

labels – Labels for which to extract the compartment IDs.

Returns

IDs of compartments for which the given labels match. Note that a single label can match one or more compartment IDS.

Raises

ValueError – If no compartment can be matched to one of the given labels.

classmethod get_label(compartment_id: pyhalco_hicann_dls_vx_v3.CompartmentOnLogicalNeuron) → str

Retrieve label of a single compartment.

Parameters

compartment_id – ID of compartment for which to retrieve the label.

Returns

Label of selected compartment.

classmethod get_labels() → List[str]

Retrieve list of all used labels.

Returns

List of all used labels.

logical_compartments: pyhalco_hicann_dls_vx_v3.LogicalNeuronCompartments = LogicalNeuronCompartments( )

logical_neuron: pylola_vx_v3.LogicalNeuron