Command: GetConnections

NEST HelpDesk Command Index NEST Quick Reference
Name:
GetConnections - Retrieve connections between node
Synopsis:
<< /source [snode_id1 snode_id2 ...]
/target [tnode_id1 tnode_id2 ...]
/synapse_model /smodel
/synapse_label label >> GetConnections -> [ conn1 conn2 ... ]
Description:
1. If called with an empty dictionary, GetConnections returns all connections of the
network, as a list of arrays (IntVectorDatum), one array per connection.
2. Each array (connection object) has the following elements:
[source-node_id target-node_id target-thread synapse-model-id port]
where synapse-model-id corresponds to the position of the model in the list
of models available from the /synapse_models property of the kernel status dictionary.
3. The optional dictionary elements /source and /target can be used to filter
for specific pre- and postsynaptic neurons, respectively.
4. The optional parameter /synapse_model can be used to filter for a specific synapse model.
5. The optional parameter /synapse_label can be used to filter for a specific synapse label.
6. In a parallel simulation, GetConnections only returns connections with *targets*
on the MPI process executing the function.
Parameters:
A dictionary that may contain the following fields (all are optional):
/source - array with node IDs of presynaptic nodes whose connections are sought.
If not given, all neurons are searched as sources.
/target - array with node IDs of postsynaptic nodes whose connections are sought.
If not given, all neurons are searched as targets.
/synapse_model - literal specifying synapse model
If not given, connections of all synapse models are returned.
/synapse_label - integer specifying synapse label
If not given, connections of all synapse labels are returned.
Remarks:
1. The /synapse_label property can only be assigned to synapse models with names ending
with '_lbl'. All other synapses have the default synapse_label UNLABELED_CONNECTION (-1).
2. The "port" enumerates connections per source, thread and synapse model. It is
mainly important for NEST internally.
3. In OpenMP mode, GetConnections works thread-parallel for better performance.
4. Connection objects can be converted to SLI lists with cva.
5. Connection objects can be passed to SetStatus, and GetStatus
Source:
/builddir/build/BUILD/nest-simulator-3.3/nest-simulator-3.3/lib/sli/nest-init.sli
NEST HelpDesk Command Index NEST Quick Reference

© 2004 The NEST Initiative