hcp_interface
¶
Module: hcp_interface.downloader_aws
¶
-
class
dmipy.hcp_interface.downloader_aws.
HCPInterface
(your_aws_public_key, your_aws_secret_key)¶ Function to download HCP data directly from AWS server. Since HCP requires you to sign its user agreements, this function takes as input the user’s personal public and secret AWS key.
These keys can be generated following the the instructions here: https://wiki.humanconnectome.org/display/PublicData/How+To+Connect+to+Connectome+Data+via+AWS
The reason this function is set up this way is because we cannot sign the user agreement for the user. Now, the user takes its own responsibility and we can provide this convenient downloader without having to go through the HCP interface.
Parameters: your_aws_public_key : string
user aws public key
your_aws_secret_key : string
user aws secret key
Attributes
Methods
-
available_subjects
¶
-
download_and_prepare_dmipy_example_dataset
()¶ Downloads subect 100307 of the Wu-Minn HCP data and prepares it to be used for the dmipy example notebooks.
-
download_subject
(subject_ID)¶ Downloads Wu-Minn HCP subject data to the dmipy data folder. The downloaded data includes the b-values, gradient orientations, diffusion-weighted images and the binary brain mask.
Parameters: subject_ID: integer :
the identification number of the Wu-Minn HCP subject
-
prepare_example_slice
(subject_ID)¶ Prepares a coronal slice for the dmipy example notebooks.
-
HCPInterface
¶
-
class
dmipy.hcp_interface.downloader_aws.
HCPInterface
(your_aws_public_key, your_aws_secret_key) Function to download HCP data directly from AWS server. Since HCP requires you to sign its user agreements, this function takes as input the user’s personal public and secret AWS key.
These keys can be generated following the the instructions here: https://wiki.humanconnectome.org/display/PublicData/How+To+Connect+to+Connectome+Data+via+AWS
The reason this function is set up this way is because we cannot sign the user agreement for the user. Now, the user takes its own responsibility and we can provide this convenient downloader without having to go through the HCP interface.
Parameters: your_aws_public_key : string
user aws public key
your_aws_secret_key : string
user aws secret key
Attributes
Methods
-
__init__
(your_aws_public_key, your_aws_secret_key)¶
-
available_subjects
-
download_and_prepare_dmipy_example_dataset
() Downloads subect 100307 of the Wu-Minn HCP data and prepares it to be used for the dmipy example notebooks.
-
download_subject
(subject_ID) Downloads Wu-Minn HCP subject data to the dmipy data folder. The downloaded data includes the b-values, gradient orientations, diffusion-weighted images and the binary brain mask.
Parameters: subject_ID: integer :
the identification number of the Wu-Minn HCP subject
-
prepare_example_slice
(subject_ID) Prepares a coronal slice for the dmipy example notebooks.
-