This documentation is for development version 0.18.dev0.

mne.datasets.phantom_4dbti.data_path

mne.datasets.phantom_4dbti.data_path(path=None, force_update=False, update_path=True, download=True, verbose=None)[source]

Get path to local copy of phantom_4dbti dataset.

Parameters:
path : None | str

Location of where to look for the phantom_4dbti dataset. If None, the environment variable or config parameter MNE_DATASETS_PHANTOM_4DBTI_PATH is used. If it doesn’t exist, the “~/mne_data” directory is used. If the phantom_4dbti dataset is not found under the given path, the data will be automatically downloaded to the specified folder.

force_update : bool

Force update of the phantom_4dbti dataset even if a local copy exists.

update_path : bool | None

If True, set the MNE_DATASETS_PHANTOM_4DBTI_PATH in mne-python config to the given path. If None, the user is prompted.

download : bool

If False and the phantom_4dbti dataset has not been downloaded yet, it will not be downloaded and the path will be returned as ‘’ (empty string). This is mostly used for debugging purposes and can be safely ignored by most users.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:
path : str

Path to phantom_4dbti dataset directory.

Examples using mne.datasets.phantom_4dbti.data_path