docs: update changelog and doc strings

RI-imaging · Apr 4, 2018 · 15e8e11 · 15e8e11
1 parent 03b2212
commit 15e8e11
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 12 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,9 +1,13 @@
 0.3.0
- - Drop support for Python 2
+ - BREAKING CHANGES:
+   - Renamed several functions
+   - Dropped support for Python 2
  - Refactoring:
    - Moved each reconstruction algorithm to a separate file
    - Modified code to comply with PEP8
-   - Moved documentation from source to docs directory
+   - Moved long doc strings from source to docs directory
+   - Removed complicated and redundant 3D reconstruction methods
+   - Improved 3D algorithm (`threed.py`) to support progress-monitoring
 0.2.1
  - Do not include compiled docs in sdist
 0.2.0

diff --git a/docs/code_reference.rst b/docs/code_reference.rst
@@ -79,3 +79,20 @@ Coordinate transforms
 Reconstruction
 --------------
 .. autofunction:: radontea.fan.fan_rec
+
+
+Volumetric reconstruction
+:::::::::::::::::::::::::
+For a slice-wise 3D reconstruction, radontea can use multiprocessing
+to parallelize the reconstruction process.
+
+Convenience functions
+---------------------
+.. autofunction:: backproject_3d
+
+.. autofunction:: fourier_map_3d
+
+General 3D reconstruction
+-------------------------
+.. autofunction:: volume_recon
+
diff --git a/radontea/fan.py b/radontea/fan.py
@@ -9,14 +9,14 @@ def fan_rec(linogram, lds, method, stepsize=1, det_spacing=1,
             numang=None, count=None, max_count=None, **kwargs):
     """2D synthetic aperture reconstruction
 
-    Computes the inverse of the fan-beam radon transform using
+    Computes the inverse of the fan-beam Radon transform using
     interpolation of the linogram and one of the inverse algorithms
     for tomography with the Fourier slice theorem.
 
     Parameters
     ----------
     linogram: 2d ndarray of shape (D, A)
-        Input linogram from the synthetic aprture measurement.
+        Input linogram from the synthetic aperture measurement.
     lds: float
         Distance in pixels between source and detector.
     method: callable

diff --git a/radontea/threed.py b/radontea/threed.py
@@ -19,23 +19,24 @@ def do_work(in_queue, out_list, count, max_count):
 
 def volume_recon(func2d, sinogram=None, angles=None,
                  count=None, max_count=None, ncpus=None, **kwargs):
-    """3D inverse with the Fourier slice theorem
+    """Slice-wise 3D inversion of the Radon transform
 
-    Computes the slice-wise 3D inverse of the radon transform using
+    Computes the slice-wise 3D inverse of the Radon transform using
     multiprocessing.
 
 
     Parameters
     ----------
     func2d: callable
-        A method representing the 2D algorithm.
+        A method for the slice-wise reconstruction
+        (e.g. :func:`backproject`).
     sinogram: ndarray, shape (A,M,N)
-        Three-dimensional sinogram of line recordings. The dimension `M`
-        iterates through the slices. The rotation takes place through
-        the second (y) axis.
+        Three-dimensional sinogram of line recordings. The axis `1`
+        iterates through the `M` slices. The rotation takes place through
+        axis `1`.
     angles: (A,) ndarray
-        Angular positions of the `sinogram` in radians equally
-        distributed from zero to PI.
+        Angular positions of the `sinogram` in radians in the
+        interval [0, PI).
     count, max_count: multiprocessing.Value or `None`
         Can be used to monitor the progress of this function. The
         value of `max_count.value` is set initially and the value