Reference API

bids_atlas.datasets - Dataset tools

get_AAL([target_space, resolution, path])

Download the 3v2 SPM12 version of the AAL atlas in specified target space and resolution, providing it in a BIDS-Atlas compliant manner.

get_Destrieux([target_space, resolution, ...])

Download the Destrieux atlas in specified target space and resolution, providing it in a BIDS-Atlas compliant manner.

get_HarvardOxford([target_space, ...])

Download the Harvard-Oxford atlas in specified target space and resolution, providing it in a BIDS-Atlas compliant manner.

get_Talairach([target_space, resolution, ...])

Download the Talairach atlas in specified target space and resolution, providing it in a BIDS-Atlas compliant manner.

get_Juelich([target_space, resolution, ...])

Download the Juelich atlas in specified target space and resolution, providing it in a BIDS-Atlas compliant manner.

get_Schaefer2018([target_space, resolution, ...])

Download the Schaefer2018 atlas in specified target space and resolution, providing it in a BIDS-Atlas compliant manner.

bids_atlas.utils - Utility functions

check_output_path(path, atlas)

Check if the desired path to save the atlas exists and if not, create it.

resample_atlas_target(atlas, target)

Check if the atlas is in the desired resolution and if not resample it.

generate_json_sidecar_file(atlas_name, path)

Create .json file for the obtained atlas.