From e75d7c8ecf8d743bf2b1efce263a1d7471fc3fe6 Mon Sep 17 00:00:00 2001
From: Julia Stadler <julia.j.stadler@durham.ac.uk>
Date: Tue, 12 Mar 2019 16:07:36 +0000
Subject: [PATCH] point out periodic boundary conditions
---
nifty5/operators/convolution_operators.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/nifty5/operators/convolution_operators.py b/nifty5/operators/convolution_operators.py
index 26a2faea3..32f991381 100644
--- a/nifty5/operators/convolution_operators.py
+++ b/nifty5/operators/convolution_operators.py
@@ -45,6 +45,12 @@ def FuncConvolutionOperator(domain, func, space=None):
The index of the subdomain on which the operator should act
If None, it is set to 0 if `domain` contains exactly one space.
`domain[space]` must be of type `RGSpace`, `HPSpace`, or `GLSpace`.
+
+ Notes
+ -----
+ The operator assumes periodic boundaries in the input domain. This means for a sufficiently
+ broad function a point source close to the boundary will blur into the opposite side of the
+ image. Zero padding can be applied to avoid this behaviour.
"""
domain = DomainTuple.make(domain)
space = utilities.infer_space(domain, space)
--
GitLab