Skip to content
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

reshape_niimg() may be too flexible #1070

Open
tsalo opened this issue Apr 10, 2024 · 1 comment
Open

reshape_niimg() may be too flexible #1070

tsalo opened this issue Apr 10, 2024 · 1 comment
Labels
bug issues describing a bug or error found in the project documentation issues related to improving documentation for the project

Comments

@tsalo
Copy link
Member

tsalo commented Apr 10, 2024

Summary

reshape_niimg is more flexible than documented. reshape_niimg will sometimes take as input a file name, sometimes a 3D image array, and sometimes a 1D image array. It seems to work for all those conditions.

If it's a file name, it loads the file and then reshapes and if it's already a loaded image, it just uses it. If it's already 1D, it squeezes the file and is still 1D.

Additional Detail

Stems from #1060 (comment).

@tsalo tsalo added bug issues describing a bug or error found in the project documentation issues related to improving documentation for the project labels Apr 10, 2024
@handwerkerd
Copy link
Member

From our April 2024 dev call, the decision is that the function has fine behavior, but we should update the document to accurately reflect what the function can do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug issues describing a bug or error found in the project documentation issues related to improving documentation for the project
Projects
None yet
Development

No branches or pull requests

2 participants