Merge pull request #109 from ufo-kit/merge-ankafilters

Merge ankafilters

1 files changed, 77 insertions, 0 deletions

diff --git a/docs/filters.rst b/docs/filters.rst
index f33c7b1..43524d8 100644
--- a/docs/filters.rst
+++ b/docs/filters.rst
@@ -242,6 +242,68 @@ Forward projection
         simply pi divided by :gobj:prop:`num-projections`.
 
 
+Laminographic backprojection
+----------------------------
+
+.. gobj:class:: lamino-backproject
+
+    Backprojects parallel beam computed laminography projection-by-projection
+    into a 3D volume.
+
+    .. gobj:prop:: x-region:GValueArray
+
+        X region for reconstruction as (from, to, step).
+
+    .. gobj:prop:: y-region:GValueArray
+
+        Y region for reconstruction as (from, to, step).
+
+    .. gobj:prop:: z:float
+
+        Z coordinate of the reconstructed slice.
+
+    .. gobj:prop:: region:GValueArray
+
+        Region for the parameter along z-axis as (from, to, step).
+
+    .. gobj:prop:: projection-offset:GValueArray
+
+        Offset to projection data as (x, y) for the case input data is cropped
+        to the necessary range of interest.
+
+    .. gobj:prop:: center:GValueArray
+
+        Center of the volume with respect to projections (x, y), (rotation
+        axes).
+
+    .. gobj:prop:: overall-angle:float
+
+        Angle covered by all projections (can be negative for negative steps in
+        case only num-projections is specified)
+
+    .. gobj:prop:: num-projections:uint
+
+        Number of projections.
+
+    .. gobj:prop:: tomo-angle:float
+
+        Tomographic rotation angle in radians (used for acquiring projections).
+
+    .. gobj:prop:: lamino-angle:float
+
+        Absolute laminogrpahic angle in radians determining the sample tilt.
+
+    .. gobj:prop:: roll-angle:float
+
+        Sample angular misalignment to the side (roll) in radians (CW is
+        positive).
+
+    .. gobj:prop:: parameter:string
+
+        Which paramter will be varied along the z-axis, from "z", "x-center",
+        "lamino-angle", "roll-angle".
+
+
 Phase retrieval
 ---------------
 
@@ -466,6 +528,21 @@ Fast Fourier transform
         Height to crop output.
 
 
+1D stripe filtering
+-------------------
+
+.. gobj:class filter-stripes1d
+
+    Filter stripes in 1D along the x-axis. The input and output are in frequency
+    domain. The filter multiplies the frequencies with an inverse Gaussian
+    profile centered at 0 frequency. The inversed profile means that the filter
+    is f(k) = 1 - gauss(k) in order to suppress the low frequencies.
+
+    .. gobj:prop:: strength:int
+
+        Filter strength, which is the full width at half maximum of the
+        gaussian.
+
 
 Auxiliary filters
 =================