diff options
author | Tomas Farago <sensej007@email.cz> | 2019-05-09 16:59:29 +0200 |
---|---|---|
committer | Tomas Farago <sensej007@email.cz> | 2019-05-09 16:59:29 +0200 |
commit | be93eb70ac43ea772ddf129249ee89e01da60bb2 (patch) | |
tree | 51d92ed520aa4b512b9492e3a4c5b1cc6a24e624 /docs | |
parent | a75184e7e3dd11e6f1eb0fe7b16459362c93eadf (diff) | |
download | ufo-filters-be93eb70ac43ea772ddf129249ee89e01da60bb2.tar.gz ufo-filters-be93eb70ac43ea772ddf129249ee89e01da60bb2.tar.bz2 ufo-filters-be93eb70ac43ea772ddf129249ee89e01da60bb2.tar.xz ufo-filters-be93eb70ac43ea772ddf129249ee89e01da60bb2.zip |
phase retrieval: Update docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/filters.rst | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/docs/filters.rst b/docs/filters.rst index 4426182..96a40ea 100644 --- a/docs/filters.rst +++ b/docs/filters.rst @@ -1093,8 +1093,7 @@ Phase retrieval .. gobj:prop:: method:enum - Retrieval method which is one of ``tie``, ``ctf``, ``ctfhalfsine``, - ``qp``, ``qphalfsine`` or ``qp2``. + Retrieval method which is one of ``tie``, ``ctf``, ``qp`` or ``qp2``. .. gobj:prop:: energy:float @@ -1102,17 +1101,18 @@ Phase retrieval .. gobj:prop:: distance:float - Distance in meter. + Distance in meters. .. gobj:prop:: pixel-size:float - Pixel size in meter. + Pixel size in meters. .. gobj:prop:: regularization-rate:float Regularization parameter is log10 of the constant to be added to the denominator to regularize the singularity at zero frequency: 1/sin(x) -> - 1/(sin(x)+10^-RegPar). + 1/(sin(x)+10^-RegPar). It is also log10(delta / beta) where the complex + refractive index is delta + beta * 1j. Typical values [2, 3]. @@ -1125,6 +1125,14 @@ Phase retrieval Typical values in [0.01, 0.1], ``qp`` retrieval is rather independent of cropping width. + .. gobj:prop:: frequency-cutoff:float + + Cutoff frequency after which the filter is set to 0 in radians. + + .. gobj:prop:: output-filter:boolean + + Output filter values instead of the filtered frequencies. + General matrix-matrix multiplication ==================================== |