pymaid.get_annotation_id

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

Retrieve the annotation ID for single or list of annotation(s).

Parameters:

  • annotations (str | list of str) – Single annotations or list of multiple annotations.

  • allow_partial (bool, optional) – If True, will allow partial matches.

  • 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:

{'annotation_name': 'annotation_id', ...}

Return type:

dict