MUSIC related devices

class music_cont_in_proxy : public DeviceNode

#include <music_cont_in_proxy.h>

Name: music_cont_in_proxy - A device which receives continuous data from MUSIC.

Description:

A music_cont_in_proxy can be used to receive continuous data from remote MUSIC applications in NEST.

It uses the MUSIC library to receive the data from other applications. The music_cont_in_proxy represents a complete port to which MUSIC can connect and send data. The music_cont_in_proxy can queried using GetStatus to retrieve the messages.

Parameters:

The following properties are available in the status dictionary:

port_name	string	The name of the MUSIC input port to listen to (default: cont_in)
port_width	integer	The width of the MUSIC input port
data	list	The data received on the port
published	boolean	A bool indicating if the port has been already published with MUSIC

The parameter port_name can be set using SetStatus.

Examples:

/music_cont_in_proxy Create /mcip Set
10 Simulate
mcip GetStatus /data get /gaze_directions Set

Author: Jochen Martin Eppler

FirstVersion: July 2010

Availability: Only when compiled with MUSIC

SeeAlso: music_event_out_proxy, music_event_in_proxy, music_message_in_proxy

class music_cont_out_proxy : public DeviceNode

#include <music_cont_out_proxy.h>

Name: music_cont_out_proxy - A device which sends continuous data from NEST to MUSIC.

Description:

A music_cont_out_proxy can be used to send continuous data from neurons over MUSIC to remote applications. It works in a similar fashion like the multimeter model. The user has to specify the recordable values to observe (e.g. [“V_m”]) via the record_from parameter. The target neurons are specified by a list of global neuron ids which must be passed via the “targets” parameter. The music_cont_out_proxy will be connected automatically to the specified target neurons. It is not possible to apply further changes to the list of target neurons or observed quantities once the simulation has been started for the first time.

In case of multiple recordables the data can be read out (PyNEST only) of the receiving buffer via the following access pattern:

buffer[ target_gid_index ][ recordable_index] = buffer[ target_gid_index *
record_from.size() + recordable_index ]

For example:
target_gids = [ 2, 5, 4 ], record_from = ["V_m"] and

we want to get "V_m" for neuron with GID 5: buffer[ 1*1 + 0 ]

Parameters:

The following properties are available in the status dictionary:

interval	ms	Recording interval
targets	array	Global id list of neurons to be observed
port_name	string	The name of the MUSIC input port to listen to (default: cont_in)
port_width	integer	The width of the MUSIC input port
published	boolean	A bool indicating if the port has been already published with MUSIC
record_from	array	Array containing the names of variables to record from, obtained from the /recordables entry of the model from which one wants to record

Author: Martin Asghar Schulze, Forschungszentrum fur Informatik Karlsruhe (FZI)

FirstVersion: March 2016

Availability: Only when compiled with MPI and MUSIC

SeeAlso: music_cont_in_proxy, music_event_out_proxy, music_event_in_proxy, music_message_in_proxy

class music_event_in_proxy : public DeviceNode

#include <music_event_in_proxy.h>

Name: music_event_in_proxy - A device which receives spikes from MUSIC.

Description:

A music_event_in_proxy can be used to pass spikes to nodes within NEST which are received from another application.

It uses the MUSIC library to receive spike events from other applications. The music_event_in_proxy represents one channel on a port to which MUSIC can connect an event source. The music_event_in_proxy can be connected to local neurons or devices within NEST to receive the events. Multiple music_in_proxies can be configured to listen on the same port, but each channel can only listened to by a single proxy.

Parameters:

The following properties are available in the status dictionary:

port_name	string	The name of the MUSIC input port to listen to (default: event_in)
music_channel	integer	The MUSIC global index on the input port to listen to
registered	boolean	A bool indicating if the port has been already registered with the corresponding MUSIC event handler

The parameters port_name and music_channel can be set using SetStatus. The acceptable latency of the MUSIC input port can be set using the command SetAcceptableLatency.

Examples:

/music_event_in_proxy Create /meip Set
meip << /music_channel 2 >> SetStatus
/iaf_psc_alpha Create /n Set
(event_in) 0.2 SetAcceptableLatency
meip n Connect

Author: Moritz Helias, Jochen Martin Eppler

FirstVersion: October 2008

Availability: Only when compiled with MUSIC

SeeAlso: SetAcceptableLatency, music_event_out_proxy, music_cont_in_proxy, music_message_in_proxy

class music_event_out_proxy : public DeviceNode

#include <music_event_out_proxy.h>

Name: music_event_out_proxy - Device to forward spikes to remote applications using MUSIC.

Description:

A music_event_out_proxy is used to send spikes to a remote application that also uses MUSIC.

The music_event_out_proxy represents a complete MUSIC event output port. The channel on the port to which a source node forwards its events is determined during connection setup by using the parameter music_channel of the connection. The name of the port is set via SetStatus (see Parameters section below).

Parameters:

The following properties are available in the status dictionary:

port_name	string	The name of the MUSIC output_port to forward events to (default: event_out)
port_width	integer	The width of the MUSIC input port
published	boolean	A bool indicating if the port has been already published with MUSIC

The parameter port_name can be set using SetStatus.

Examples:

/iaf_psc_alpha Create /n Set
/music_event_out_proxy Create /meop Set
n meop << /music_channel 2 >> Connect

Author: Moritz Helias, Jochen Martin Eppler

FirstVersion: March 2009

Availability: Only when compiled with MUSIC

SeeAlso: music_event_in_proxy, music_cont_in_proxy, music_message_in_proxy

class MsgHandler : public MessageHandler

#include <music_message_in_proxy.h>

Name: music_message_in_proxy - A device which receives message strings from MUSIC.

Description:

A music_message_in_proxy can be used to receive message strings from remote MUSIC applications in NEST.

It uses the MUSIC library to receive message strings from other applications. The music_message_in_proxy represents an input port to which MUSIC can connect a message source. The music_message_in_proxy can queried using GetStatus to retrieve the messages.

Parameters:

The following properties are available in the status dictionary:

port_name	string	The name of the MUSIC input port to listen to (default: message_in)
port_width	integer	The width of the MUSIC input port
data	array	A sub-dictionary that contains the string messages in the form of two arrays: messages - The strings message_times - The times the messages were sent (ms)
n_messages	integer	The number of messages
published	boolean	A bool indicating if the port has been already published with MUSIC

The parameter port_name can be set using SetStatus. The field n_messages can be set to 0 to clear the data arrays.

Examples:

/music_message_in_proxy Create /mmip Set
10 Simulate
mmip GetStatus /data get /messages get 0 get /command Set
(Executing command ') command join ('.) join =
command cvx exec

Author: Jochen Martin Eppler

FirstVersion: July 2010

Availability: Only when compiled with MUSIC

SeeAlso: music_event_out_proxy, music_event_in_proxy, music_cont_in_proxy