simple_linear_operators.py 7.41 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke 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
Martin Reinecke's avatar
Martin Reinecke committed
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
Martin Reinecke's avatar
Martin Reinecke committed
17 18 19

from ..domain_tuple import DomainTuple
from ..domains.unstructured_domain import UnstructuredDomain
Martin Reinecke's avatar
Martin Reinecke committed
20
from ..field import Field
Philipp Arras's avatar
Philipp Arras committed
21
from ..multi_domain import MultiDomain
Martin Reinecke's avatar
Martin Reinecke committed
22
from ..multi_field import MultiField
Philipp Arras's avatar
Philipp Arras committed
23 24
from .endomorphic_operator import EndomorphicOperator
from .linear_operator import LinearOperator
Martin Reinecke's avatar
Martin Reinecke committed
25 26 27


class VdotOperator(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
28 29 30 31 32 33 34
    """Operator computing the scalar product of its input with a given Field.

    Parameters
    ----------
    field : Field/MultiField
        The field used to build the scalar product with the operator input
    """
Martin Reinecke's avatar
Martin Reinecke committed
35 36
    def __init__(self, field):
        self._field = field
Martin Reinecke's avatar
Martin Reinecke committed
37
        self._domain = field.domain
Martin Reinecke's avatar
Martin Reinecke committed
38
        self._target = DomainTuple.scalar_domain()
Martin Reinecke's avatar
Martin Reinecke committed
39
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
40 41

    def apply(self, x, mode):
Martin Reinecke's avatar
Martin Reinecke committed
42
        self._check_mode(mode)
Martin Reinecke's avatar
Martin Reinecke committed
43
        if mode == self.TIMES:
Martin Reinecke's avatar
Martin Reinecke committed
44
            return Field.scalar(self._field.vdot(x))
Martin Reinecke's avatar
Martin Reinecke committed
45
        return self._field*x.local_data[()]
Martin Reinecke's avatar
Martin Reinecke committed
46 47


Martin Reinecke's avatar
Martin Reinecke committed
48
class ConjugationOperator(EndomorphicOperator):
Martin Reinecke's avatar
Martin Reinecke committed
49
    """Operator computing the complex conjugate of its input."""
Martin Reinecke's avatar
Martin Reinecke committed
50
    def __init__(self, domain):
Martin Reinecke's avatar
Martin Reinecke committed
51
        self._domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
52
        self._capability = self._all_ops
Martin Reinecke's avatar
Martin Reinecke committed
53 54 55 56 57 58 59

    def apply(self, x, mode):
        self._check_input(x, mode)
        return x.conjugate()


class Realizer(EndomorphicOperator):
Martin Reinecke's avatar
Martin Reinecke committed
60
    """Operator returning the real component of its input."""
Martin Reinecke's avatar
Martin Reinecke committed
61
    def __init__(self, domain):
Martin Reinecke's avatar
Martin Reinecke committed
62
        self._domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
63
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
64 65 66 67

    def apply(self, x, mode):
        self._check_input(x, mode)
        return x.real
Martin Reinecke's avatar
Martin Reinecke committed
68 69


70
class FieldAdapter(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
71
    """Operator for conversion between Fields and MultiFields.
Philipp Arras's avatar
Philipp Arras committed
72 73 74

    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
75 76 77 78 79 80 81 82
    tgt : Domain, tuple of Domain, DomainTuple, dict or MultiDomain:
        If this is a Domain, tuple of Domain or DomainTuple, this will be the
        operator's target, and its domain will be a MultiDomain consisting of
        its domain with the supplied `name`
        If this is a dict or MultiDomain, everything except for `name` will
        be stripped out of it, and the result will be the operator's target.
        Its domain will then be the DomainTuple corresponding to the single
        entry in the operator's domain.
Philipp Arras's avatar
Philipp Arras committed
83 84

    name : String
Martin Reinecke's avatar
Martin Reinecke committed
85
        The relevant key of the MultiDomain.
Philipp Arras's avatar
Philipp Arras committed
86 87
    """

Martin Reinecke's avatar
Martin Reinecke committed
88 89 90 91 92 93 94 95 96
    def __init__(self, tgt, name):
        from ..sugar import makeDomain
        tmp = makeDomain(tgt)
        if isinstance(tmp, DomainTuple):
            self._target = tmp
            self._domain = MultiDomain.make({name: tmp})
        else:
            self._domain = tmp[name]
            self._target = MultiDomain.make({name: tmp[name]})
Martin Reinecke's avatar
Martin Reinecke committed
97
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
98 99 100

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
101
        if isinstance(x, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
102
            return x.values()[0]
Martin Reinecke's avatar
Martin Reinecke committed
103 104 105 106 107 108 109 110 111
        else:
            return MultiField(self._tgt(mode), (x,))

    def __repr__(self):
        key = self.domain.keys()[0]
        return 'FieldAdapter: {}'.format(key)


def ducktape(left, right, name):
Martin Reinecke's avatar
Martin Reinecke committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
    """Convenience function for computing an adapter between two operators.

    Parameters
    ----------
    left : None, Operator, or Domainoid
        Something describing the input domain of the left operator.
        If `left` is an `Operator`, its domain is used as `left`.

    right : None, Operator, or Domainoid
        Something describing the target domain of the right operator.
        If `right` is an `Operator`, its target is used as `right`.

    name : string
        The component of the `MultiDomain` that will be extracted/inserted

    Notes
    -----
    - one of the involved domains must be a `DomainTuple`, the other a
      `MultiDomain`.
    - `left` and `right` must not be both `None`, but one of them can (and
      probably should) be `None`. In this case, the missing information is
      inferred.
Martin Reinecke's avatar
Martin Reinecke committed
134 135 136 137 138 139 140
    - the returned operator's domains are
        - a `DomainTuple` and
        - a `MultiDomain` with exactly one entry called `name` and the same
          `DomainTuple`

      Which of these is the domain and which is the target depends on the
      input.
Martin Reinecke's avatar
Martin Reinecke committed
141 142 143 144 145 146

    Returns
    -------
    FieldAdapter : an adapter operator converting between the two (possibly
                   partially inferred) domains.
    """
Martin Reinecke's avatar
Martin Reinecke committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    from ..sugar import makeDomain
    from .operator import Operator
    if left is None:  # need to infer left from right
        if isinstance(right, Operator):
            right = right.target
        elif right is not None:
            right = makeDomain(right)
        if isinstance(right, MultiDomain):
            left = right[name]
        else:
            left = MultiDomain.make({name: right})
    else:
        if isinstance(left, Operator):
            left = left.domain
        else:
            left = makeDomain(left)
163
    return FieldAdapter(left, name)
Martin Reinecke's avatar
Martin Reinecke committed
164 165 166 167 168 169 170 171 172 173


class GeometryRemover(LinearOperator):
    """Operator which transforms between a structured and an unstructured
    domain.

    Parameters
    ----------
    domain: Domain, tuple of Domain, or DomainTuple:
        the full input domain of the operator.
174 175 176
    space: int, optional
        The index of the subdomain on which the operator should act
        If None, it acts on all spaces
Martin Reinecke's avatar
Martin Reinecke committed
177 178 179 180 181 182 183 184

    Notes
    -----
    The operator will convert every sub-domain of its input domain to an
    UnstructuredDomain with the same shape. No weighting by volume factors
    is carried out.
    """

185
    def __init__(self, domain, space=None):
Martin Reinecke's avatar
Martin Reinecke committed
186
        self._domain = DomainTuple.make(domain)
187 188 189 190 191 192
        if space is not None:
            tgt = [dom for dom in self._domain]
            tgt[space] = UnstructuredDomain(self._domain[space].shape)
        else:
            tgt = [UnstructuredDomain(dom.shape) for dom in self._domain]
        self._target = DomainTuple.make(tgt)
Martin Reinecke's avatar
Martin Reinecke committed
193
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
194 195 196

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
197
        return x.cast_domain(self._tgt(mode))
Martin Reinecke's avatar
Martin Reinecke committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214


class NullOperator(LinearOperator):
    """Operator corresponding to a matrix of all zeros.

    Parameters
    ----------
    domain : DomainTuple or MultiDomain
        input domain
    target : DomainTuple or MultiDomain
        output domain
    """

    def __init__(self, domain, target):
        from ..sugar import makeDomain
        self._domain = makeDomain(domain)
        self._target = makeDomain(target)
Martin Reinecke's avatar
Martin Reinecke committed
215
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
216 217 218 219

    @staticmethod
    def _nullfield(dom):
        if isinstance(dom, DomainTuple):
Martin Reinecke's avatar
Martin Reinecke committed
220
            return Field(dom, 0)
Martin Reinecke's avatar
Martin Reinecke committed
221 222 223 224 225
        else:
            return MultiField.full(dom, 0)

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
226
        return self._nullfield(self._tgt(mode))