generate_metadata_dict#

brainglobe_atlasapi.atlas_generation.metadata_utils.generate_metadata_dict(name: str, location: str, citation: str, atlas_link: str, species: str, symmetric: bool, resolution: Tuple[int, int, int] | Tuple[float, float, float], orientation: str, version: str, shape: Tuple[int, int, int], additional_references: List[TemplateInfo], atlas_packager: str, coordinate_space: CoordinateSpaceInfo, terminology: TerminologyInfo, annotation_set: AnnotationInfo, template: TemplateInfo)[source]#

Generate a dictionary containing metadata for a BrainGlobe atlas.

Parameters:

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

  • location (str) – The relative path to the atlas data within the brainglobe directory.

  • 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[int, int, int] | Tuple[float, float, 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[int, int, int]) – The shape (dimensions) of the atlas volume (e.g., (z, y, x)).

  • additional_references (List[TemplateInfo]) – A list of additional reference links or citations.

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

  • coordinate_space (CoordinateSpaceInfo) – Metadata for the coordinate space.

  • terminology (TerminologyInfo) – Metadata for the terminology.

  • annotation_set (AnnotationInfo) – Metadata for the annotation set.

  • template (TemplateInfo) – Metadata for the template.

Returns:

A dictionary containing all the metadata.

Return type:

dict