SIRF icon indicating copy to clipboard operation
SIRF copied to clipboard

Documentation of GeometricalInfo

Open DANAJK opened this issue 5 years ago • 4 comments

UserSpecification.md in SIRF/doc is old.

DeveloperGuide.md This refers to old CCPPETMR GitHub site.

The description of Software layers renders in my browser as just a list spread over 4 lines - the layers are not obvious.

SIRF/src/common/GeometricalInfo.cpp contains few comments. I believe there is an expectation that offset is in patient LPS and this should probably be clear in this file, either explicitly or pointing to where else this is documented.

The direction array in this file has no associated comments - is the expectation that the directions point along the image array in the same sense as the array indices increase and with the dimension ordering of the native language (MATLAB or Python?)

Can num_dimensions here ever be anything other than 3? By allowing it to be a variable we potentially fail to catch an issue where, for example, someone incorrectly assigns time to a spatial dimension?

DANAJK avatar Nov 21 '20 11:11 DANAJK

I suggest to remove UserSpecification.

KrisThielemans avatar Apr 20 '21 10:04 KrisThielemans

3b623e50ddb36da9ad90a4a007f0666e3f7b8879 removed UserSpecification

KrisThielemans avatar Aug 27 '22 08:08 KrisThielemans

a77d2413f9ed234b45de6fc8c39f5b5c8f6c8101 fixed DeveloperGuide.md

KrisThielemans avatar Aug 27 '22 08:08 KrisThielemans

Only comments left on GeometricalInfo, so I'll rename the issue

KrisThielemans avatar Aug 27 '22 08:08 KrisThielemans