pymaid.get_skids_by_name¶

pymaid.get_skids_by_name(names, allow_partial=True, raise_not_found=True, remote_instance=None)[source]¶

Retrieve the all neurons with matching name.

Parameters:

names (str | list of str) – Name(s) to search for. Like CATMAID’s search widget, you can use regex to search for names by starting the query with a leading /.
allow_partial (bool, optional) – If True, partial matches are returned too.
raise_not_found (bool, optional) – If True, will raise an exception of no matches for given name(s) are found. Else will return empty DataFrame.
remote_instance (CatmaidInstance, optional) – If not passed directly, will try using global.

Returns:

DataFrame in which each row represents a neuron:

  name   skeleton_id
0
1
2
...

Return type:

pandas.DataFrame