From b3c37a3fa98ad2a256b4db12782f48a687dd84b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patrick=20H=C3=A4cker?= Date: Tue, 20 Jan 2026 04:57:57 +0100 Subject: [PATCH] Fix formatting in mapwindow.jl documentation This was hard to read the way it was. --- src/mapwindow.jl | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/mapwindow.jl b/src/mapwindow.jl index d1584f8..52cd6d1 100644 --- a/src/mapwindow.jl +++ b/src/mapwindow.jl @@ -14,19 +14,19 @@ export mapwindow, mapwindow! border = "replicate", indices = default_imginds(img, window, border), callmode=:copy!) -Apply `f` to sliding windows of `img``, with window size or axes specified by window. For +Apply `f` to sliding windows of `img`, with window size or axes specified by window. For example, `mapwindow(median!, img, window)` returns an Array of values similar to `img` (median-filtered, of course), whereas `mapwindow(extrema, img, window)` returns an Array of -(min, max) tuples over a window of size window centered on each point of `img`. +(min, max) tuples over a window of size `window` centered on each point of `img`. -The function `f` receives a buffer `buf`` for the window of data surrounding the current point. +The function `f` receives a buffer `buf` for the window of data surrounding the current point. -If `window`` is specified as a Dims-tuple (tuple-of-integers), then all the integers must be +If `window` is specified as a Dims-tuple (tuple-of-integers), then all the integers must be odd and the window is centered around the current image point. -For example, if `window = (3,3)`, then `f` will receive an Array `buf`` -corresponding to offsets (-1:1, -1:1) from the `imgf[i, j]`` for which this is -currently being computed. Alternatively, window can be a tuple of +For example, if `window = (3,3)`, then `f` will receive an Array `buf` +corresponding to offsets `(-1:1, -1:1)` from the `imgf[i, j]` for which this is +currently being computed. Alternatively, `window` can be a tuple of `AbstractUnitRange`s, in which case the specified ranges are used for `buf`; this allows you to use asymmetric windows if needed.