6.1.1. nidata.multimodal.hcp package

6.1.1.1. Module contents

class nidata.multimodal.hcp.HcpDataset(*args, **kwargs)

Bases: nidata.core.datasets.Dataset

TODO: HcpDataset docstring

Methods

fetch(n_subjects=1, data_types=None, tasks=None, atlases=None, mnis=None, force=False, check=True, verbose=1, properties=None, process=None)

Parameters:

n_subjects : int

the number of subjects to fetch files from

data_types : list

the type of data to fetch, can choose from anat, diff, func, or rest

tasks : list

the type of activity for functional data, can choose from emotional, gambling, language, motor, relational, social, and workingmemory

atlases : list

scope of surface data, can choose from native or fsaverage

mnis : list

determines whether to use mninonlinear data or not, can choose from true or false

properties : list

the chosen properties displayed in structural data files can choose from myelinmap, curvature, thickness

process : list

whether or not the data is processed or not can choose from True or False

get_anat_files(process, subj_id, atlas, mni, property)

Parameters:

atlas : String

scope of surface data, can choose from native or fsaverage

mni : boolean

determines whether to use mninonlinear data or not, can choose from true or false

property : String

the chosen properties displayed in structural data files can choose from myelinmap, curvature, thickness

process : boolean

whether or not the data is processed or not can choose from True or False

subj_id : String

the id of the subject the files are on

get_diff_files(process, subj_id)

Parameters:

process : boolean

whether or not the data is processed or not can choose from True or False

subj_id : String

the id of the subject the files are on

get_rest_files(process, subj_id)

Parameters:

process : boolean

whether or not the data is processed or not can choose from True or False

subj_id : String

the id of the subject the files are on

get_subject_list(n_subjects=None)

Get the list of subject IDs. Depends on the # of subjects, which also corresponds to other things (license agreement, type of data available, etc)

get_task_files(process, task, subj_id)

Parameters:

task : String

the type of activity for functional data, can choose from emotional, gambling, language, motor, relational, social, and workingmemory

process : boolean

whether or not the data is processed or not can choose from True or False

subj_id : String

the id of the subject the files are on

prepend(src_files)

Prepends the proper absolute url to a list of files, based on fetcher type.

Parameters:

src_files: list of str

uncompleted urls without the prepended fetcher type

Returns:

list of fully qualified urls

class nidata.multimodal.hcp.HcpHttpFetcher(*args, **kwargs)

Bases: nidata.core.fetchers.http_fetcher.HttpFetcher

TODO: HcpHttpFetcher docstring

Methods

dependencies = ['requests']

fetch(files, force=False, resume=True, check=False, verbose=1)