Skip to content

clearify the data to be shuffled at fcma preprocess is the image data #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mihaic merged 3 commits into from
Apr 30, 2018
Merged

clearify the data to be shuffled at fcma preprocess is the image data #365

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
201b925
clearify the data to be shuffled at fcma preprocess is the image data
yidawang Apr 27, 2018
13c0faf
fix trailing whitespace
yidawang Apr 28, 2018
29679f0
Also clarify prepare_*_data
mihaic Apr 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions brainiak/fcma/preprocessing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ def _randomize_single_subject(data, seed=None):
Parameters
----------
data: 2D array in shape [nVoxels, nTRs]
Activity data to be shuffled.
Activity image data to be shuffled.
seed: Optional[int]
Seed for random state used implicitly for shuffling.

Expand All @@ -123,7 +123,7 @@ def _randomize_subject_list(data_list, random):
Parameters
----------
data_list: list of 2D array in shape [nVxels, nTRs]
Activity data list to be shuffled.
Activity image data list to be shuffled.
random: RandomType
Randomization type.

Expand All @@ -142,11 +142,11 @@ def _randomize_subject_list(data_list, random):
class RandomType(Enum):
"""Define the random types as enumeration

NORANDOM means do not randomize the data;
REPRODUCIBLE means randomize the data with a fixed seed so that the
NORANDOM means do not randomize the image data;
REPRODUCIBLE means randomize the image data with a fixed seed so that the
permutation holds between different runs;
UNREPRODUCIBLE means truly randomize the data which returns different
results in different runs.
UNREPRODUCIBLE means truly randomize the image data which returns
different results in different runs.
"""
NORANDOM = 0
REPRODUCIBLE = 1
Expand All @@ -173,8 +173,7 @@ def prepare_fcma_data(images, conditions, mask1, mask2=None,
variable raw_data2 and the self-correlation on raw_data1 will be
computed
random: Optional[RandomType]
Randomize the data within subject or not.
Default NORANDOM
Randomize the image data within subject or not.
comm: MPI.Comm
MPI communicator to use for MPI operations.

Expand Down Expand Up @@ -344,7 +343,7 @@ def prepare_searchlight_mvpa_data(images, conditions, data_type=np.float32,
data_type
Type to cast image to.
random: Optional[RandomType]
Randomize the data within subject or not.
Randomize the image data within subject or not.

Returns
-------
Expand Down