validate_additional_references#

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

Check that additional references have expected properties.

Verifies that all additional reference images: 1. Have the same dimensions as the main reference image. 2. Are not identical to the main reference image (i.e., contain different data).

Parameters:

atlas (BrainGlobeAtlas) – The BrainGlobeAtlas object to validate.

Returns:

True if all additional references pass the validation checks.

Return type:

bool

Raises:

AssertionError – If an additional reference has unexpected dimensions or is identical to the main reference.