3.1.1. nidata.core.datasets package

3.1.1.1. Module contents

class nidata.core.datasets.AuthenticatedHttpDataset(*args, **kwargs)

Bases: nidata.core.datasets.HttpDataset

Attributes

PASSWD_ENV_VAR
USERNAME_ENV_VAR

Methods

PASSWD_ENV_VAR = None

USERNAME_ENV_VAR = None

class nidata.core.datasets.Dataset(*args, **kwargs)

Bases: nidata.core.objdep.ClassWithDependencies

Methods

clean_data_directory()

Function that guarantees a data directory.

dependencies = []

fetch(force=False, verbose=1, *args, **kwargs)

classmethod get_dataset_descr()

classmethod get_dataset_descr_path()

class nidata.core.datasets.FetcherFunctionDataset(*args, **kwargs)

Bases: nidata.core.datasets.Dataset

Methods

fetch(*args, **kwargs)

class nidata.core.datasets.FetcherFunctionMeta

Bases: nidata.core.objdep.DependenciesMeta

Define fetcher_function; it will reset class docstring.

Methods

class nidata.core.datasets.HttpDataset(*args, **kwargs)

Bases: nidata.core.datasets.Dataset

Methods

class nidata.core.datasets.NilearnDataset(*args, **kwargs)

Bases: nidata.core.datasets.FetcherFunctionDataset

Methods

dependencies = ['numpy', 'scipy', 'sklearn', 'nilearn']

classmethod get_dataset_descr_path()

class nidata.core.datasets.NistatsDataset(*args, **kwargs)

Bases: nidata.core.datasets.FetcherFunctionDataset

Methods

dependencies = ['nistats']

nidata.core.datasets.get_dataset_dir(dataset_name, data_dir=None, env_vars=[], verbose=1)

Create if necessary and returns data directory of given dataset.

Parameters:

dataset_name: string

The unique name of the dataset.

data_dir: string, optional

Path of the data directory. Used to force data storage in a specified location. Default: None

env_vars: list of string, optional

Add environment variables searched even if data_dir is not None.

verbose: int, optional

verbosity level (0 means no message).

Returns:

data_dir: string

Path of the given dataset directory.

Notes

This function retrieves the datasets directory (or data directory) using the following priority : 1. the keyword argument data_dir 2. the global environment variable NILEARN_SHARED_DATA 3. the user environment variable NIDATA_PATH 4. NIDATA_PATH in the user home folder

nidata.core.datasets.readlinkabs(link)

Return an absolute path for the destination of a symlink