validate_atlas_name#

brainglobe_atlasapi.atlas_generation.validate_atlases.validate_atlas_name(atlas: BrainGlobeAtlas)[source]#

Validate the naming convention of the atlas.

Checks if the atlas name adheres to specific rules: - Must be entirely lowercase. - Can only contain lowercase letters, digits, underscores, hyphens, and periods. - Must end with a resolution string (e.g., “5um”, “37.5um”, “1mm”).

Parameters:

atlas (BrainGlobeAtlas) – The BrainGlobeAtlas object to validate.

Returns:

True if the atlas name follows the specified conventions.

Return type:

bool

Raises:

AssertionError – If the atlas name contains capital letters, invalid characters, or does not end with a valid resolution string.