CIL icon indicating copy to clipboard operation
CIL copied to clipboard

Properties and centre of rotation methods of AcquisitionGeometry are not documented

Open lauramurgatroyd opened this issue 1 year ago • 0 comments

Docs for AcquisitionGeometry: https://tomographicimaging.github.io/CIL/nightly/framework.html?highlight=ndim#acquisitiongeometry It would be useful to list the properties of AcquisitionGeometry in the docs. Methods are documented here for configuring and using the geometry: https://tomographicimaging.github.io/CIL/nightly/framework.html?highlight=ndim#configure-the-geometry However, the methods to do with the centre of rotation are not documented. Which section should they be documented in? https://github.com/TomographicImaging/CIL/blob/955ef6f2f5ca863e79c93e54dacf03f36fccfe52/Wrappers/Python/cil/framework/framework.py#L2224 Perhaps the getter should be in using the geometry? https://tomographicimaging.github.io/CIL/nightly/framework.html?highlight=ndim#use-the-geometry https://github.com/TomographicImaging/CIL/blob/955ef6f2f5ca863e79c93e54dacf03f36fccfe52/Wrappers/Python/cil/framework/framework.py#L2284 https://github.com/TomographicImaging/CIL/blob/955ef6f2f5ca863e79c93e54dacf03f36fccfe52/Wrappers/Python/cil/framework/framework.py#L2338 And the setters be in configuring the geometry? https://tomographicimaging.github.io/CIL/nightly/framework.html?highlight=ndim#configure-the-geometry

Or we could make a centre of rotation section within the AcquisitionGeometry documentation

Note, we have all the methods and properties of AcquisitionData in the docs: https://tomographicimaging.github.io/CIL/nightly/framework.html?highlight=ndim#acquisitiondata so I think it would be good to have similar for AcquisitionGeometry.

lauramurgatroyd avatar Jan 17 '24 09:01 lauramurgatroyd