generate_metadata_dict#

brainglobe_atlasapi.atlas_generation.metadata_utils.generate_metadata_dict(name, citation, atlas_link, species, symmetric, resolution, orientation, version, shape, additional_references, atlas_packager)[source]#

Generate a dictionary containing metadata for a BrainGlobe atlas.

Parameters:

  • name (str) – The name of the atlas.

  • citation (str) – The citation for the atlas.

  • atlas_link (str) – A URL link to the atlas source or related publication.

  • species (str) – The species the atlas belongs to (e.g., “mouse”, “rat”).

  • symmetric (bool) – True if the atlas is symmetric, False otherwise.

  • resolution (tuple of int/float) – The resolution of the atlas in micrometers per voxel.

  • orientation (str) – The orientation of the atlas (e.g., “RAS”, “LPS”).

  • version (str) – The version of the atlas.

  • shape (tuple of int) – The shape (dimensions) of the atlas volume (e.g., (z, y, x)).

  • additional_references (list of str) – A list of additional reference links or citations.

  • atlas_packager (str) – The name of the person or entity packaging the atlas.

Returns:

A dictionary containing all the metadata.

Return type:

dict