endomorphic_operator.py 1.44 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
# 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/>.
Theo Steininger's avatar
Theo Steininger committed
13 14 15 16 17
#
# Copyright(C) 2013-2017 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.
18

Martin Reinecke's avatar
Martin Reinecke committed
19
from .linear_operator import LinearOperator
20 21 22


class EndomorphicOperator(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
23
    """ NIFTy class for endomorphic operators.
24

Martin Reinecke's avatar
Martin Reinecke committed
25
    The  NIFTy EndomorphicOperator class is a class derived from the
Theo Steininger's avatar
Theo Steininger committed
26 27
    LinearOperator. By definition, domain and target are the same in
    EndomorphicOperator.
28 29 30

    Attributes
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
31
    domain : DomainTuple
Theo Steininger's avatar
Theo Steininger committed
32
        The domain on which the Operator's input Field lives.
Martin Reinecke's avatar
Martin Reinecke committed
33
    target : DomainTuple
Theo Steininger's avatar
Theo Steininger committed
34 35
        The domain in which the outcome of the operator lives. As the Operator
        is endomorphic this is the same as its domain.
36 37
    """

38 39 40
    @property
    def target(self):
        return self.domain