atlas_region_rename

atlas_region_rename(atlas, pattern, replacement)

Rename regions matching a pattern.

Only affects the ‘region’ column, not ‘label’.

Parameters

Name Type Description Default
atlas BrainAtlas Brain atlas object. required
pattern str Regex pattern to match (case-insensitive). required
replacement str | Callable[[str], str] Replacement string or function that takes matched names. required

Returns

Name Type Description
BrainAtlas Modified atlas copy.

Examples

>>> from ggsegpy import dk, atlas_region_rename
>>> atlas = dk()
>>> renamed = atlas_region_rename(atlas, "superior", "sup.")