Base class for all recording devices. More...

#include <recording_device.h>

Inheritance diagram for nest::RecordingDevice:

Collaboration diagram for nest::RecordingDevice:

Classes
struct	Parameters_

struct	State_

Public Types
enum	Type { MULTIMETER , SPIKE_RECORDER , SPIN_DETECTOR , WEIGHT_RECORDER }

Public Member Functions
	RecordingDevice ()

	RecordingDevice (const RecordingDevice &)

void	pre_run_hook (const std::vector< std::string > &, const std::vector< std::string > &)

bool	is_active (Time const &T) const override
	Returns true if the device is active at the given time stamp.

virtual Type	get_type () const =0

const std::string &	get_label () const

void	set_status (const Dictionary &) override
	Change properties of the node according to the entries in the dictionary.

void	get_status (Dictionary &) const override
	Export properties of the node by setting entries in the status dictionary.

virtual void	pre_run_hook ()
	Set internal variables before calls to SimulationManager::run()

virtual void	pre_run_hook ()=0
	Re-calculate dependent parameters of the node.

Public Member Functions inherited from nest::DeviceNode
	DeviceNode ()

	DeviceNode (DeviceNode const &dn)

void	set_local_device_id (const size_t ldid) override
	Sets the local device id.

size_t	get_local_device_id () const override
	Gets the local device id.

Public Member Functions inherited from nest::Node
	Node ()

	Node (Node const &)

virtual	~Node ()

virtual Node *	clone () const
	This function creates a new object by calling the derived class' copy constructor and returning its pointer.

virtual bool	has_proxies () const
	Returns true if the node has proxies on remote threads.

virtual bool	supports_urbanczik_archiving () const
	Returns true if the node supports the Urbanczik-Senn plasticity rule.

virtual bool	local_receiver () const
	Returns true if the node only receives events from nodes/devices on the same thread.

virtual bool	one_node_per_process () const
	Returns true if the node exists only once per process, but does not have proxies on remote threads.

virtual bool	is_off_grid () const
	Returns true if the node sends/receives off-grid events.

virtual bool	is_proxy () const
	Returns true if the node is a proxy node.

std::string	get_name () const
	Return class name.

virtual std::string	get_element_type () const
	Return the element type of the node.

size_t	get_node_id () const
	Return global Network ID.

int	get_model_id () const
	Return model ID of the node.

bool	is_frozen () const
	Returns true if node is frozen, i.e., shall not be updated.

bool	node_uses_wfr () const
	Returns true if the node uses the waveform relaxation method.

void	set_node_uses_wfr (const bool)
	Sets node_uses_wfr_ member variable (to be able to set it to "true" for any class derived from Node)

void	init ()
	Initialize node prior to first simulation after node has been created.

virtual void	calibrate_time (const TimeConverter &)
	Re-calculate time-based properties of the node.

virtual void	post_run_cleanup ()
	Cleanup node after Run.

virtual void	finalize ()
	Finalize node.

virtual void	update (Time const &, const long, const long)=0
	Advance the state of the node in time through the given interval.

virtual bool	wfr_update (Time const &, const long, const long)
	Advance the state of the node in time through the given interval (see Node::update() for more details).

virtual size_t	send_test_event (Node &receiving_node, size_t receptor_type, synindex syn_id, bool dummy_target)
	Send an event to the receiving_node passed as an argument.

virtual size_t	handles_test_event (SpikeEvent &, size_t receptor_type)
	Check if the node can handle a particular event and receptor type.

virtual size_t	handles_test_event (WeightRecorderEvent &, size_t receptor_type)

virtual size_t	handles_test_event (RateEvent &, size_t receptor_type)

virtual size_t	handles_test_event (DataLoggingRequest &, size_t receptor_type)

virtual size_t	handles_test_event (CurrentEvent &, size_t receptor_type)

virtual size_t	handles_test_event (ConductanceEvent &, size_t receptor_type)

virtual size_t	handles_test_event (DoubleDataEvent &, size_t receptor_type)

virtual size_t	handles_test_event (DSSpikeEvent &, size_t receptor_type)

virtual size_t	handles_test_event (DSCurrentEvent &, size_t receptor_type)

virtual size_t	handles_test_event (GapJunctionEvent &, size_t receptor_type)

virtual size_t	handles_test_event (InstantaneousRateConnectionEvent &, size_t receptor_type)

virtual size_t	handles_test_event (DiffusionConnectionEvent &, size_t receptor_type)

virtual size_t	handles_test_event (DelayedRateConnectionEvent &, size_t receptor_type)

virtual size_t	handles_test_event (LearningSignalConnectionEvent &, size_t receptor_type)

virtual size_t	handles_test_event (SICEvent &, size_t receptor_type)

virtual void	sends_secondary_event (GapJunctionEvent &ge)
	Required to check, if source neuron may send a SecondaryEvent.

virtual void	sends_secondary_event (InstantaneousRateConnectionEvent &re)
	Required to check, if source neuron may send a SecondaryEvent.

virtual void	sends_secondary_event (DiffusionConnectionEvent &de)
	Required to check, if source neuron may send a SecondaryEvent.

virtual void	sends_secondary_event (DelayedRateConnectionEvent &re)
	Required to check, if source neuron may send a SecondaryEvent.

virtual void	sends_secondary_event (LearningSignalConnectionEvent &re)
	Required to check if source node may send a LearningSignalConnectionEvent.

virtual void	sends_secondary_event (SICEvent &sic)
	Required to check if source node may send a SICEvent.

virtual void	register_stdp_connection (double, double)
	Register a STDP connection.

virtual void	register_eprop_connection ()
	Registers an eprop connection.

virtual void	initialize_update_history ()
	Initializes the update history.

virtual long	get_shift () const
	Retrieves the temporal shift of the signal.

virtual void	write_update_to_history (const long t_previous_update, const long t_current_update, const bool is_flush_event, const bool previous_was_flush_event)
	Registers the current update in the update history and deregisters the previous update.

virtual void	erase_used_eprop_history ()
	Erases used e-prop history for bsshslm_2020 models.

virtual void	erase_used_eprop_history (const long t_spike, const long t_spike_previous)
	Erases used e-prop history based on inter-spike interval.

virtual bool	is_eprop_recurrent_node () const
	Checks if the node is part of the recurrent network and thus not a readout neuron.

virtual void	handle (SpikeEvent &e)
	Handle incoming spike events.

virtual void	handle (WeightRecorderEvent &e)
	Handle incoming weight recording events.

virtual void	handle (RateEvent &e)
	Handler for rate events.

virtual void	handle (DataLoggingRequest &e)
	Handler for universal data logging request.

virtual void	handle (DataLoggingReply &e)
	Handler for universal data logging request.

virtual void	handle (CurrentEvent &e)
	Handler for current events.

virtual void	handle (ConductanceEvent &e)
	Handler for conductance events.

virtual void	handle (DoubleDataEvent &e)
	Handler for DoubleData events.

virtual void	handle (GapJunctionEvent &e)
	Handler for gap junction events.

virtual void	handle (InstantaneousRateConnectionEvent &e)
	Handler for rate neuron events.

virtual void	handle (DiffusionConnectionEvent &e)
	Handler for rate neuron events.

virtual void	handle (DelayedRateConnectionEvent &e)
	Handler for delay rate neuron events.

virtual void	handle (LearningSignalConnectionEvent &e)
	Handler for learning signal connection events.

virtual void	handle (SICEvent &e)
	Handler for slow inward current events (SICEvents).

virtual double	get_Ca_minus () const
	Return the Ca_minus value at time Ca_t which corresponds to the time of the last update in Calcium concentration which is performed each time a Node spikes.

virtual double	get_synaptic_elements (std::string) const
	Get the number of synaptic element for the current Node at Ca_t which corresponds to the time of the last spike.

virtual int	get_synaptic_elements_vacant (std::string) const
	Get the number of vacant synaptic element for the current Node Return 0 if not overridden.

virtual int	get_synaptic_elements_connected (std::string) const
	Get the number of connected synaptic element for the current Node.

virtual std::map< std::string, double >	get_synaptic_elements () const
	Get the number of all synaptic elements for the current Node at time t.

virtual void	update_synaptic_elements (double)
	Triggers the update of all SynapticElements stored in the synaptic_element_map_.

virtual void	decay_synaptic_elements_vacant ()
	Is used to reduce the number of synaptic elements in the node through time.

virtual void	connect_synaptic_element (std::string, int)
	Is used to update the number of connected synaptic elements (SynapticElement::z_connected_) when a synapse is formed or deleted.

virtual double	get_K_value (double t)
	return the Kminus value at t (in ms).

virtual double	get_LTD_value (double t)

virtual void	get_K_values (double t, double &Kminus, double &nearest_neighbor_Kminus, double &Kminus_triplet)
	write the Kminus, nearest_neighbor_Kminus, and Kminus_triplet values at t (in ms) to the provided locations.

virtual void	get_history (double t1, double t2, std::deque< histentry >::iterator start, std::deque< histentry >::iterator finish)
	return the spike history for (t1,t2].

virtual void	get_LTP_history (double t1, double t2, std::deque< histentry_extended >::iterator start, std::deque< histentry_extended >::iterator finish)

virtual void	get_urbanczik_history (double t1, double t2, std::deque< histentry_extended >::iterator start, std::deque< histentry_extended >::iterator finish, int)

virtual double	get_C_m (int comp)

virtual double	get_g_L (int comp)

virtual double	get_tau_L (int comp)

virtual double	get_tau_s (int comp)

virtual double	get_tau_syn_ex (int comp)

virtual double	get_tau_syn_in (int comp)

virtual void	compute_gradient (const long t_spike, const long t_spike_previous, double &z_previous_buffer, double &z_bar, double &e_bar, double &e_bar_reg, double &epsilon, double &weight, const CommonSynapseProperties &cp, WeightOptimizer *optimizer, bool is_flush_event, bool previous_was_flush_event, double &sum_grad, long &remaining_steps_until_cutoff, long &decay_steps)
	Compute gradient change for eprop synapses.

virtual double	compute_gradient (std::vector< long > &presyn_isis, const long t_previous_update, const long t_previous_trigger_spike, const double kappa, const bool average_gradient)
	Compute gradient change for eprop synapses.

virtual void	event_hook (DSSpikeEvent &)
	Modify Event object parameters during event delivery.

virtual void	event_hook (DSCurrentEvent &)

void	set_thread (size_t)
	Store the number of the thread to which the node is assigned.

size_t	get_thread () const
	Retrieve the number of the thread to which the node is assigned.

void	set_vp (size_t)
	Store the number of the virtual process to which the node is assigned.

size_t	get_vp () const
	Retrieve the number of the virtual process to which the node is assigned.

void	set_model_id (int)
	Set the model id.

void	set_initialized ()
	Execute post-initialization actions in node models.

virtual SignalType	sends_signal () const

virtual SignalType	receives_signal () const

Dictionary	get_status_base ()
	Return a dictionary with the node's properties.

void	set_status_base (const Dictionary &)
	Set status dictionary of a node.

bool	is_model_prototype () const
	Returns true if node is model prototype.

void	set_thread_lid (const size_t)
	set thread local index

size_t	get_thread_lid () const
	get thread local index

void	set_tmp_nc_index (size_t index)
	Set index in node collection; required by ThirdOutBuilder.

size_t	get_tmp_nc_index ()
	Return and invalidate index in node collection; required by ThirdOutBuilder.

Public Member Functions inherited from nest::Device
	Device ()

	Device (const Device &n)

virtual	~Device ()

virtual void	init_state ()
	Reset dynamic state to that of model.

virtual void	init_buffers ()
	Reset buffers.

long	get_t_min_ () const
	Return lower limit in steps.

long	get_t_max_ () const
	Return upper limit in steps.

Time const &	get_origin () const

Time const &	get_start () const

Time const &	get_stop () const

Protected Member Functions
void	write (const Event &, const std::vector< double > &, const std::vector< long > &)

void	set_initialized_ () override

Protected Member Functions inherited from nest::Node
virtual void	init_state_ ()
	Configure state variables depending on runtime information.

virtual void	init_buffers_ ()
	Configure persistent internal data structures.

Model &	get_model_ () const

void	set_frozen_ (bool frozen)
	Mark node as frozen.

template<typename ConcreteNode >
const ConcreteNode &	downcast (const Node &)
	Auxiliary function to downcast a Node to a concrete class derived from Node.

Private Attributes
struct nest::RecordingDevice::Parameters_	P_

struct nest::RecordingDevice::State_	S_

Dictionary	backend_params_

Additional Inherited Members
Public Attributes inherited from nest::Node
DeprecationWarning	deprecation_warning
	Member of DeprecationWarning class to be used by models if parameters are deprecated.

Protected Attributes inherited from nest::DeviceNode
size_t	local_device_id_

Detailed Description

Base class for all recording devices.

Recording devices collect or sample data and output it to one or more recording backends selected by setting the device property record_to to the name of the backend.

Class RecordingDevice is merely a shallow interface class from which concrete recording devices can inherit in order to use the recording backend infrastructure more easily and provide a consistent handling of activity windows by means of start/stop and origin.

If the device is configured to record from start to stop, this is interpreted as (start, stop], i.e., the earliest recorded event will have time stamp start+1, as it was generated during the update step (start, start+1].

If the device node is not an actual instance used by the user, but rather a prototype node in a Model class, it will cache device-specific properties of the recording backend and use them for enrollment of the device with the backend as the last step during the creation of instances. This mechanism is implemented in set_status() and set_initialized_().

Author: HEP 2002-07-22, 2008-03-21, 2011-02-11

Member Enumeration Documentation

◆ Type

enum nest::RecordingDevice::Type

Enumerator
MULTIMETER
SPIKE_RECORDER
SPIN_DETECTOR
WEIGHT_RECORDER

Constructor & Destructor Documentation

◆ RecordingDevice() [1/2]

nest::RecordingDevice::RecordingDevice ( )

◆ RecordingDevice() [2/2]

nest::RecordingDevice::RecordingDevice ( const RecordingDevice & rd )

Member Function Documentation

◆ get_label()

const std::string & nest::RecordingDevice::get_label ( ) const

References nest::RecordingDevice::Parameters_::label_, and P_.

Referenced by nest::RecordingBackendSIONlib::enroll(), and nest::RecordingBackendMPI::get_port().

Here is the caller graph for this function:

◆ get_status()

void nest::RecordingDevice::get_status ( Dictionary & ) const

overridevirtual

Export properties of the node by setting entries in the status dictionary.

Parameters

d	Dictionary.

Implements nest::Node.

Reimplemented in nest::spike_recorder, nest::spin_detector, and nest::weight_recorder.

References backend_params_, nest::names::element_type(), nest::RecordingDevice::Parameters_::get(), nest::RecordingDevice::State_::get(), nest::Node::get_node_id(), nest::IOManager::get_recording_backend_device_defaults(), nest::IOManager::get_recording_backend_device_status(), nest::Device::get_status(), nest::KernelManager::io_manager, nest::kernel(), P_, nest::RecordingDevice::Parameters_::record_to_, nest::names::recorder(), and S_.

Referenced by nest::multimeter::get_status(), nest::spike_recorder::get_status(), nest::spin_detector::get_status(), and nest::weight_recorder::get_status().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_type()

virtual Type nest::RecordingDevice::get_type ( ) const

pure virtual

Implemented in nest::multimeter, nest::spike_recorder, nest::spin_detector, and nest::weight_recorder.

Referenced by nest::RecordingBackendMPI::enroll(), and nest::RecordingBackendSIONlib::enroll().

Here is the caller graph for this function:

◆ is_active()

bool nest::RecordingDevice::is_active ( Time const & T ) const

overridevirtual

Returns true if the device is active at the given time stamp.

Semantics are implemented by subclasses.

Implements nest::Device.

References nest::Time::get_steps(), nest::Device::get_t_max_(), and nest::Device::get_t_min_().

Referenced by nest::multimeter::handle(), nest::spike_recorder::handle(), nest::spin_detector::handle(), and nest::weight_recorder::handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pre_run_hook() [1/3]

void nest::Device::pre_run_hook ( )

virtual

Set internal variables before calls to SimulationManager::run()

Implements nest::Node.

Reimplemented in nest::spike_recorder, nest::spin_detector, and nest::weight_recorder.

Referenced by nest::multimeter::pre_run_hook(), nest::spike_recorder::pre_run_hook(), nest::spin_detector::pre_run_hook(), and nest::weight_recorder::pre_run_hook().

Here is the caller graph for this function:

◆ pre_run_hook() [2/3]

virtual void nest::Node::pre_run_hook ( )

virtual

Re-calculate dependent parameters of the node.

This function is called each time a simulation is begun/resumed. It must re-calculate all internal Variables of the node required for spike handling or updating the node.

Implements nest::Node.

Reimplemented in nest::spike_recorder, nest::spin_detector, and nest::weight_recorder.