mne_nirs.datasets.audio_or_visual_speech.data_path

mne_nirs.datasets.audio_or_visual_speech.data_path(path=None, force_update=False, update_path=True, download=True, verbose=None)

Audio and visual speech dataset with 8 participants.

Get path to local copy of data from the article [1].

Parameters:

pathNone | str

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

force_updatebool

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

update_pathbool | None

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

downloadbool

If False and the 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.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:

pathstr

Path to dataset directory.

References

[1]

Maureen J Shader, Robert Luke, Nathalie Gouailhardou, and Colette M McKay. The use of broad vs restricted regions of interest in functional near-infrared spectroscopy for measuring cortical activation to auditory-only and visual-only speech. Hearing Research, 406:108256, 2021. doi:10.1016/j.heares.2021.108256.

Examples using mne_nirs.datasets.audio_or_visual_speech.data_path

Example Datasets

Example Datasets

Utilising Anatomical Information

Utilising Anatomical Information