From 00d89ee04293e93a467e6d8e2195b6af03d827c1 Mon Sep 17 00:00:00 2001 From: Tomas Farago Date: Thu, 4 Jun 2020 11:43:57 +0200 Subject: phase retrieval: enable separate x and y distance fixes #203 --- docs/filters.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'docs') 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. -- cgit v1.2.1