visbrain.io.download_file

visbrain.io.download_file(name, astype=None, filename=None, to_path=None, unzip=False, remove_archive=False, use_pwd=False)[source][source]

Download a file.

By default this function download a file to ~/visbrain_data.

Parameters:
namestring

Name of the file to download or url.

astypestr | None

If name is a name of a file that can be downloaded, astype refer to the type of the file.

filenamestring | None

Name of the file to be saved in case of url.

to_pathstring | None

Download file to the path specified.

unzipbool | False

Unzip archive if needed.

remove_archivebool | False

Remove archive after unzip.

use_pwdbool | False

Download the file to the current directory.

Returns:
path_to_filestring

Path to the downloaded file.

Examples using visbrain.io.download_file

Animate objects in the scene

Animate objects in the scene

Brain object (BrainObj) : complete tutorial

Brain object (BrainObj) : complete tutorial

Combine multiple objects

Combine multiple objects

Connectivity object (ConnectObj) : complete tutorial

Connectivity object (ConnectObj) : complete tutorial

Region Of Interest object (RoiObj) : complete tutorial

Region Of Interest object (RoiObj) : complete tutorial

Source object (SourceObj) : complete tutorial

Source object (SourceObj) : complete tutorial

Topoplot object (TopoObj) : complete tutorial

Topoplot object (TopoObj) : complete tutorial

Volume object (VolumeObj) : complete tutorial

Volume object (VolumeObj) : complete tutorial

Plot x3d files

Plot x3d files

Cross-sections and volume control

Cross-sections and volume control

Define a brain template using vertices and faces

Define a brain template using vertices and faces

Add deep sources

Add deep sources

Connect deep sources

Connect deep sources

Add Region of interest (ROI)

Add Region of interest (ROI)

Add time series

Add time series

Add pictures

Add pictures

Screenshot example

Screenshot example

Add multiple objects to the scene

Add multiple objects to the scene

Add Nifti volume

Add Nifti volume

Add vectors

Add vectors

Parcellize brain surface

Parcellize brain surface

Load a BrainVision file

Load a BrainVision file

Load EDF file

Load EDF file

Load EDF file with custom vigilance state configuration

Load EDF file with custom vigilance state configuration

Load ELAN files

Load ELAN files

Load a Matlab file

Load a Matlab file

Load REC files

Load REC files

Load a file using MNE-python

Load a file using MNE-python

Get sleep statistics

Get sleep statistics

Matplotlib plot of an hypnogram

Matplotlib plot of an hypnogram

Replace detection algorithm : basic example

Replace detection algorithm : basic example

Replace detection with wonambi algorithm

Replace detection with wonambi algorithm

Display conjunction map

Display conjunction map

Display fMRI activation

Display fMRI activation

Plot MEG inverse solution

Plot MEG inverse solution

Plot vector-valued MEG inverse solution

Plot vector-valued MEG inverse solution

Page layout example

Page layout example