Skip to content

Commit 8382ae4

Browse files
committed
adding detailed documentation on reconstruction methods
1 parent f4790fc commit 8382ae4

File tree

5 files changed

+73
-2
lines changed

5 files changed

+73
-2
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Conda environment
3434
3535
$ conda create --name httomolibgpu # create a fresh conda environment
3636
$ conda activate httomolibgpu # activate the environment
37-
$ conda install -c conda-forge cupy==12.3.0 # for linux users
37+
$ conda install conda-forge::cupy==12.3.0
3838
$ pip install httomolibgpu
3939
4040
Setup the development environment:

docs/source/reference/methods.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Modules from `Data denoising` can be used as post-processing tools. For instance
3838
Stripes removal module
3939
^^^^^^^^^^^^^^^^^^^^^^
4040

41-
Modules from `Stripes removal` normally used as pre-processing tools. Stripes removal is equivalent to removing ring artefacts in the reconstructed images.
41+
Modules from `Stripes removal` are normally used as a pre-processing tool. Stripes removal is equivalent to removing ring artefacts in the reconstructed images.
4242

4343

4444
.. toctree::
@@ -49,6 +49,23 @@ Modules from `Stripes removal` normally used as pre-processing tools. Stripes re
4949
methods_list/remove_stripe_ti
5050
methods_list/raven_filter
5151

52+
53+
.. _image_reconstruction_module:
54+
55+
Image reconstruction module
56+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
57+
58+
Modules from `Image reconstruction` are needed in order to reconstruct data from the set of sinograms into a reconstructed volume. The reconstruction methods can be divided into two groups: Direct methods and Iterative methods.
59+
The former are faster and suitable for the majority of well-sampled and well-exposed data. The latter are more complex and slower methods when the data is erroneuos or/and undersampled.
60+
61+
.. toctree::
62+
:glob:
63+
64+
methods_list/LPRec3d_tomobar
65+
methods_list/FBP3d_tomobar
66+
methods_list/FBP2d_astra
67+
68+
5269
.. _data_rescale_module:
5370

5471
Data rescale module
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _method_FBP2d_astra:
2+
3+
FBP using ASTRA-Toolbox
4+
^^^^^^^^^^^^^^^^^^^^^^^
5+
6+
**Description**
7+
8+
This module performs Filtered-Back-projection direct reconstruction using `ASTRA-Toolbox <https://astra-toolbox.com>`_. It is an implementation of parallel-beam
9+
`FBP <https://astra-toolbox.com/docs/algs/FBP.html>`_ reconstruction method by ASTRA with the related parameters exposed (see the adjustable parameters bellow).
10+
11+
12+
.. note:: This is the slowest direct reconstruction method in the library and it is recommended to use other methods, such as, :ref:`method_FBP3d_tomobar` or :ref:`method_LPRec3d_tomobar`.
13+
14+
**Where and how to use it:**
15+
16+
This reconstruction method can be used as a back-up option if other reconstruction algorithms.
17+
18+
**What are the adjustable parameters:**
19+
20+
21+
**Practical example:**
22+
23+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _method_FBP3d_tomobar:
2+
3+
FBP3D (ToMoBAR)
4+
^^^^^^^^^^^^^^^
5+
6+
**Description**
7+
8+
9+
**Where and how to use it:**
10+
11+
12+
**What are the adjustable parameters:**
13+
14+
15+
**Practical example:**
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _method_LPRec3d_tomobar:
2+
3+
Log-Polar 3D (ToMoBAR)
4+
^^^^^^^^^^^^^^^^^^^^^^
5+
6+
**Description**
7+
8+
9+
**Where and how to use it:**
10+
11+
12+
**What are the adjustable parameters:**
13+
14+
15+
**Practical example:**
16+

0 commit comments

Comments
 (0)