diff options
| author | Tomas Farago <sensej007@email.cz> | 2020-06-04 11:43:57 +0200 |
|---|---|---|
| committer | Tomas Farago <sensej007@email.cz> | 2020-06-04 11:46:36 +0200 |
| commit | 00d89ee04293e93a467e6d8e2195b6af03d827c1 (patch) | |
| tree | 574af8e57ec08354b78afa47ccde413c4c770f83 /docs | |
| parent | db3cd886b8303a8a5aff20c76660ed49c2365f94 (diff) | |
| download | ufo-filters-00d89ee04293e93a467e6d8e2195b6af03d827c1.tar.gz ufo-filters-00d89ee04293e93a467e6d8e2195b6af03d827c1.tar.bz2 ufo-filters-00d89ee04293e93a467e6d8e2195b6af03d827c1.tar.xz ufo-filters-00d89ee04293e93a467e6d8e2195b6af03d827c1.zip | |
phase retrieval: enable separate x and y distance
fixes #203
Diffstat (limited to 'docs')
| -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. |