neuromaps_mouse.datasets.available_annotations

neuromaps_mouse.datasets.available_annotations(source=None, desc=None, space=None, res=None, tag=None, format=None)[source]

List available annotations with optional filtering.

Returns a list of available annotation datasets that can be fetched, optionally filtered by various metadata attributes.

See :doc: /listofmaps for details on available annotations.

Parameters:

  • source (str, optional) – Filter by data source. If ‘all’, returns all available annotations without filtering. Default is None.

  • desc (str, optional) – Filter by description. Default is None.

  • space (str, optional) – Filter by anatomical space. Default is None.

  • res (int or float, optional) – Filter by resolution. Default is None.

  • tag (str, optional) – Filter by annotation tag or keyword. Default is None.

  • format (str, optional) – Filter by file format. Default is None.

Returns:

List of tuples representing available annotations. Each tuple contains annotation metadata (source, desc, space, res). If source=’all’, returns all available annotations.

Return type:

list of tuple

See also

neuromaps_mouse.datasets.fetch_annotation

Download and load annotation files.

Examples

>>> # Get all available annotations
>>> all_annots = available_annotations(source='all')
>>> print(f"Found {len(all_annots)} annotations")

>>> # Filter by specific source
>>> lein2006amba = available_annotations(source='lein2006amba')

>>> # Filter by multiple criteria
>>> annots = available_annotations(source='lein2006amba', desc='sagittalenergy')