offset_operator.py 1.14 KB
Newer Older
Philipp Arras's avatar
Philipp Arras committed
1
2
3
4
5
6
7
8
9
10
11
12
13
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
14
# Copyright(C) 2013-2019 Max-Planck-Society
Philipp Arras's avatar
Philipp Arras committed
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
Philipp Arras's avatar
Philipp Arras committed
17
18
19
20

from .operator import Operator


Philipp Arras's avatar
Philipp Arras committed
21
class OffsetOperator(Operator):
22
    """Shifts the input by a fixed field.
Philipp Arras's avatar
Docs    
Philipp Arras committed
23
24
25
26

    Parameters
    ----------
    field : Field
27
28
        The field by which the input is shifted.
    """
Philipp Arras's avatar
Philipp Arras committed
29
30
    def __init__(self, field):
        self._field = field
Philipp Arras's avatar
Philipp Arras committed
31
        self._domain = self._target = field.domain
Philipp Arras's avatar
Philipp Arras committed
32
33
34

    def apply(self, x):
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
35
        return x + self._field