pymaid.get_connector_links

pymaid.get_connector_links(x, with_tags=False, chunk_size=50, remote_instance=None)

Retrieve connectors links for a set of neurons.

In essence, this will get you all “arrows” that point from a connector to your neuron or from your neuron to a connector. It does NOT give you the entire battery of connectors for a set of connectors. For that you have to use get_connector_details().

Parameters:

• x (int | CatmaidNeuron | CatmaidNeuronList) – Neurons/Skeleton IDs to retrieve link details for. If CatmaidNeuron/List will respect changes made to original neurons (e.g. pruning)!

• with_tags (bool, optional) – If True will also return dictionary of connector tags.

• chunk_size (int, optional) – Neurons are split into chunks of this size and then queried sequentially to prevent server from returning an error.

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

Returns:

• pandas.DataFrame –

  DataFrame in which each row represents a connector link:

    skeleton_id  relation  connector_id  x  y  z  confidence ...
  0
  1
  2
  ...
    creator  node_id  creation_time  edition_time
  0
  1
  2
  

• (links, tags) – If with_tags=True, will return above DataFrame and tags dict.

See also

get_connectors()

If you just need the connector table (ID, x, y, z, creator, etc).

get_connector_details()

Get the same data but by connector, not by link.