pymaid.get_label_list¶

pymaid.get_label_list(remote_instance=None)[source]¶

Retrieves all labels (node tags only) in a project.

Parameters:

remote_instance (CatmaidInstance, optional) – If not provided, will search for globally defined remote instance.

Returns:

DataFrame in which each row represents a label:

   label_id  tag  skeleton_id  node_id
0
1
...

Return type:

pandas.DataFrame

Examples

>>> # Get all labels
>>> labels = pymaid.get_label_list()
>>> # Get all nodes with a given tag
>>> nodes = labels[labels.tag == 'my_label'].node_id
>>> # Get neuron that have at least a single node with a given tag
>>> neurons = labels[ labels.tag == 'my_label' ].skeleton_id.unique()