-
Notifications
You must be signed in to change notification settings - Fork 54
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.
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
The get_spm_globals function was added. #22
base: main
Are you sure you want to change the base?
The get_spm_globals function was added. #22
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! I just left one comment on the code, anticipating potential uses.
Although the title of the PR is set, it is not very informative and a description is missing. A PR description would be great for other developers to understand what was done and why. Similarly, for each commit message (there's only one here, so not much to confuse anyone, but sometimes PRs require lots of commits).
vol_mean = spm_global(data[..., i]) | ||
spm_vals.append(vol_mean) | ||
|
||
return spm_vals # Return the result. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the type of spm_vals
?
If you read the docstring (line 54 above) it says array
, which is very unclear but seems to refer to a numpy.array
, however, you return a basic list
here. Consider converting it to array before returning or else downstream methods could fail. For instance, with the current implementation you would not be able to do:
average_spm = get_spm_globals(nifti_file).mean()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! One comment about a mismatch between the documentation and the return type.
vol_mean = spm_global(data[..., i]) | ||
spm_vals.append(vol_mean) | ||
|
||
return spm_vals # Return the result. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spm_vals
is a Python list, but the docstring above says:
Returns
-------
spm_vals : array
SPM global metric for each 3D volume in the 4D image.
I would expect the result to be converted into a Numpy array before being returned.
Apologies for the doubling up. I did not realize @oesteban was reviewing... |
No description provided.