pymaid.get_skids_by_annotation

pymaid.get_skids_by_annotation(annotations, allow_partial=False, intersect=False, raise_not_found=True, remote_instance=None)[source]

Retrieve the neurons annotated with given annotation(s).

Parameters:

  • annotations (str | list) – Single annotation or list of multiple annotations. Using a tilde (~) as prefix is interpreted as NOT.

  • allow_partial (bool, optional) – If True, allow partial match of annotation.

  • intersect (bool, optional) – If True, neurons must have ALL provided annotations.

  • raise_not_found (bool, optional) – If True raise Exception if no match for any of the query annotations is found. Else log warning.

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

Returns:

[skid1, skid2, skid3, ...]

Return type:

list

See also

pymaid.find_neurons()

Use to retrieve neurons by combining various search criteria. For example names, reviewers, annotations, etc.

pymaid.get_annotated()

Use to retrieve entities (neurons and annotations).