Update docs

algotom · Apr 26, 2024 · 05bf384 · 05bf384
1 parent 0126661
commit 05bf384
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/algotom/rec/reconstruction.py b/algotom/rec/reconstruction.py
@@ -24,6 +24,7 @@
 Module of reconstruction methods:
 
     -   Filtered back-projection (FBP) method for GPU and CPU.
+    -   Back-projection filtering (BPF) method for GPU and CPU.
     -   Direct Fourier inversion (DFI) method.
     -   Wrapper for Astra-Toolbox reconstruction methods (optional)
     -   Wrapper for Tomopy-gridrec reconstruction method (optional)
@@ -1407,8 +1408,8 @@ def find_center_based_slice_metric(sinogram, start, stop, step=0.5,
     invert_metric : bool
         Invert the metric scale, used with a custom metric-function.
     metric_function : obj
-        Custom function to calculate metric, accepts keyword
-        arguments (**kwargs).
+        Custom function to calculate metric, accepts keyword arguments
+        (** kwargs).
 
     Returns
     -------

diff --git a/docs/source/toc/api/algotom.rec.reconstruction.rst b/docs/source/toc/api/algotom.rec.reconstruction.rst
@@ -11,7 +11,9 @@
     .. autosummary::
 
         fbp_reconstruction
+        bpf_reconstruction
         dfi_reconstruction
         gridrec_reconstruction
         astra_reconstruction
         find_center_based_slice_metric
+        find_center_visual_slices
diff --git a/docs/source/toc/api/algotom.util.utility.rst b/docs/source/toc/api/algotom.util.utility.rst
@@ -12,7 +12,7 @@
 
     .. autosummary::
 
-        apply_method_to_multiple_sinograms
+        parallel_process_slices
         mapping
         make_circle_mask
         sort_forward
@@ -41,4 +41,3 @@
         locate_slice_chunk
         generate_spiral_positions
         find_center_visual_sinograms
-        find_center_visual_slices
diff --git a/docs/source/toc/section6.rst b/docs/source/toc/section6.rst
@@ -49,3 +49,12 @@ Update notes
 
     + Add methods for loading and saving multiple tiff images in parallel.
     + Release version 1.4.
+
+- 24/03/2024:
+
+    + Add calibration methods for tomography alignment.
+    + Release version 1.5
+
+- 26/04/2024:
+
+    + Add back-projection filtering (BPF) method.