bids_atlas.datasets.get_HarvardOxford

bids_atlas.datasets.get_HarvardOxford(target_space=None, resolution=None, type='dseg', threshold=None, path=None)[source]

Download the Harvard-Oxford 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.

  • type (string) – Type the atlas should be provided in. If None, the atlas will be provided as dseg. Default = ‘dseg’.

  • threshold (string) – Threshold the atlas should be provided in. If None, the threshold will be set as 25. Default = ‘25’.

  • 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 Harvard-Oxford atlas to the current directory.

>>> get_HarvardOxford()

Download the atlas to a specific path, e.g. the user’s Desktop and indicate a resolution.

>>> get_HarvardOxford(resolution=1, path='/home/user/Desktop')