diff options
| author | Tomas Farago <sensej007@email.cz> | 2020-06-25 09:20:38 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-25 09:20:38 +0200 |
| commit | 2444279f92dbc057ff503f8800a5aa98d11b5130 (patch) | |
| tree | 62234f42d6a69acc403a922196d3ea805b90bf0f /docs/filters.rst | |
| parent | 04f1cf13aae8d6a18d0e7ad23dec93a5baa3e66f (diff) | |
| parent | 00d89ee04293e93a467e6d8e2195b6af03d827c1 (diff) | |
| download | ufo-filters-2444279f92dbc057ff503f8800a5aa98d11b5130.tar.gz ufo-filters-2444279f92dbc057ff503f8800a5aa98d11b5130.tar.bz2 ufo-filters-2444279f92dbc057ff503f8800a5aa98d11b5130.tar.xz ufo-filters-2444279f92dbc057ff503f8800a5aa98d11b5130.zip | |
Merge pull request #205 from ufo-kit/directional-phaseretrieval
phase retrieval: enable separate x and y distance
Diffstat (limited to 'docs/filters.rst')
| -rw-r--r-- | docs/filters.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/filters.rst b/docs/filters.rst index ff901bb..2906401 100644 --- a/docs/filters.rst +++ b/docs/filters.rst @@ -1235,6 +1235,10 @@ Phase retrieval Computes and applies a fourier filter to correct phase-shifted data. Expects frequencies as an input and produces frequencies as an output. + Propagation distance can be specified for both x and y directions together + by the :gobj:prop:`distance` parameter or separately by + :gobj:prop:`distance-x` and :gobj:prop:`distance-y`, which is useful e.g. + when pixel size is not symmetrical. .. gobj:prop:: method:enum @@ -1248,6 +1252,14 @@ Phase retrieval Distance in meters. + .. gobj:prop:: distance-x:float + + Distance in x-direction in meters. + + .. gobj:prop:: distance-y:float + + Distance in y-direction in meters. + .. gobj:prop:: pixel-size:float Pixel size in meters. |