bids_atlas.datasets.get_Schaefer2018

bids_atlas.datasets.get_Schaefer2018(target_space=None, resolution=None, n_rois='100', roi_annotation='7', path=None)[source]

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

Parameters:

  • target_space (string) – Target space the atlas should be provided in. If None, the atlas will be provided in MNI152NLin6Asym. Default = None.

  • resolution (string) – Resolution the atlas should be provided in. If None, the atlas will be provided in 2mm resolution. Default = None.

  • n_rois (string) – Version of the Schaefer atlas to be downloaded, ie number of regions. Can be 100 - 1000 in steps of 100. Default = ‘100’.

  • roi_annotation (string) – Annotation that should be used for the ROIs. Can either be based on Yeo 7 networks or Yeo 17 networks. Default = ‘7’.

  • path (string) – Path where the atlas will be saved. If None, the file will be saved in the current working directory. Default = None.

Returns:

dict – A Dictionary containing the paths to the atlas image, tsv and json files.

Return type:

Dictionary

Examples

Download the Schaefer atlas to the current directory.

>>> get_Schaefer()

Download the atlas to a specific path, e.g. the user’s Desktop and indicate a version, here the version with 400 regions.

>>> get_Schaefer(n_rois='400', path='/home/user/Desktop')