Improve docs and usage of dimensions()

AnderBiguri commented 4 years ago

Refer to conversation here: https://github.com/SyneRBI/SIRF/pull/628#discussion_r411535114

KrisThielemans commented 4 years ago

A few additional things to check:

Reg's get_dimensions() should be renamed to get_nifti_dimensions I guess. Also, its doc shouldn't mention x,y,z https://github.com/SyneRBI/SIRF/blob/dc094db9f8a5b052af4f5bda1ac729913df6f5ff/src/Registration/pReg/Reg.py.in#L247. Some for get_voxel_sizes https://github.com/SyneRBI/SIRF/blob/dc094db9f8a5b052af4f5bda1ac729913df6f5ff/src/Registration/pReg/Reg.py.in#L259 (I find it terribly confusing)
what's the relation between shape and dimensions?
do we have/need any of this for MATLAB?

KrisThielemans commented 4 years ago

I see that get_dimensions is in fact all over the place. Is the Nifti version compatible with the rest?

AnderBiguri commented 4 years ago

@KrisThielemans I realized I did not answer this. Do you mean if get_dimensions is compatible with dimensions ? It is not, the first returns an array, second a tuple. However, depending on its usage within the code, a change may not have an influence.

KrisThielemans commented 3 years ago

@DANAJK this relates to some things we were discussion I believe

SyneRBI / SIRF

Improve docs and usage of dimensions() #632