pymaid.get_connectors_between

pymaid.get_connectors_between(a, b, directional=True, remote_instance=None)[source]

Retrieve connectors between sets of neurons.

Important

This function does currently not return gap junctions between neurons.

Notes

A connector can show up multiple times if it is connecting to more than one nodes of the same neuron.

Parameters:
  • a

    Neurons for which to retrieve connectors. Can be:

    1. list of skeleton ID(s) (int or str)

    2. list of neuron name(s) (str, exact match)

    3. an annotation: e.g. ‘annotation:PN right’

    4. CatmaidNeuron or CatmaidNeuronList object

  • b

    Neurons for which to retrieve connectors. Can be:

    1. list of skeleton ID(s) (int or str)

    2. list of neuron name(s) (str, exact match)

    3. an annotation: e.g. ‘annotation:PN right’

    4. CatmaidNeuron or CatmaidNeuronList object

  • directional (bool, optional) – If True, only connectors a -> b are listed, otherwise it is a <-> b.

  • remote_instance (CatmaidInstance, optional) – If not passed directly, will try using global.

Returns:

DataFrame in which each row represents a connector:

  connector_id  connector_loc  node1_id  source_neuron  ...
0
1
2
...
  confidence1  creator1 node1_loc node2_id  target_neuron  ...
0
1
2
...
 confidence2  creator2  node2_loc
0
1
2

Return type:

pandas.DataFrame

See also

get_edges()

If you just need the number of synapses between neurons, this is much faster.