hxtorch.spiking.modules.readout_neuron.Morphology

class hxtorch.spiking.modules.readout_neuron.Morphology

Bases: abc.ABC

Represents the internal structure of a neuron.

This neuron might be made up of several compartments and the compartments themselves can consist of several neuron circuits.

Note

Currently spike and voltage recording is only supported in the first neuron circuit of the first compartment.

__init__()

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

Methods

disable_leak(coord, neuron_block)

Disable the leak for the given neuron.

disable_spiking(coord, neuron_block)

Disable spiking for the given neuron.

enable_madc_recording(coord, neuron_block, …)

Configure neuron such that traces can be recorded with the MADC.

implement_morphology(coord, neuron_block)

Configure the atomic neurons in the given neuron block to represent this morphology.

set_spike_recording(enable, coord, neuron_block)

Set whether spikes are forwarded digitally.

Attributes

compartments

Unplaced coordinate of the logical neuron.

logical_neuron

Base configuration of the logical neuron.
abstract property compartments

Unplaced coordinate of the logical neuron.

static disable_leak(coord: pyhalco_hicann_dls_vx_v3.LogicalNeuronOnDLS, neuron_block: pylola_vx_v3.NeuronBlock) → None

Disable the leak for the given neuron.

Parameters

  • coord – Coordinate of the logical neuron for which the leak is disabled.

  • neuron_block – Neuron block in which the configuration of the atomic neurons is changed.

static disable_spiking(coord: pyhalco_hicann_dls_vx_v3.LogicalNeuronOnDLS, neuron_block: pylola_vx_v3.NeuronBlock) → None

Disable spiking for the given neuron.

Disable the threshold comparator and the digital spike output.

Parameters

  • coord – Coordinate of the logical neuron for which spiking is disabled.

  • neuron_block – Neuron block in which the configuration of the atomic neurons is changed.

static enable_madc_recording(coord: pyhalco_hicann_dls_vx_v3.LogicalNeuronOnDLS, neuron_block: pylola_vx_v3.NeuronBlock, readout_source: pyhaldls_vx_v3.NeuronConfig.ReadoutSource) → None

Configure neuron such that traces can be recorded with the MADC.

Parameters

  • coord – Coordinate of the logical neuron for which the recording is enabled.

  • neuron_block – Neuron block in which the configuration of the atomic neurons is changed.

  • readout_source – Voltage which should be recorded.

implement_morphology(coord: pyhalco_hicann_dls_vx_v3.LogicalNeuronOnDLS, neuron_block: pylola_vx_v3.NeuronBlock) → None

Configure the atomic neurons in the given neuron block to represent this morphology.

Parameters

  • coord – Coordinate of the logical neuron which should be configured.

  • neuron_block – The configuration of neurons at coord will be changed such that a neuron with the given morphology is implemented.

abstract property logical_neuron

Base configuration of the logical neuron.

Default constructed logical neuron, the connections between neuron circuits are configured such that the specified morphology is implemented.

static set_spike_recording(enable: bool, coord: pyhalco_hicann_dls_vx_v3.LogicalNeuronOnDLS, neuron_block: pylola_vx_v3.NeuronBlock) → None

Set whether spikes are forwarded digitally.

Parameters

  • enable – Enable/disable the digital routing of spikes.

  • coord – Coordinate of the logical neuron for which the recording is enabled.

  • neuron_block – Neuron block in which the configuration of the atomic neurons is changed.