wiener_filter_curvature.py 2.38 KB
Newer Older
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-2021 Max-Planck-Society
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
Philipp Arras's avatar
Philipp Arras committed
17

18
from ..operators.endomorphic_operator import EndomorphicOperator
Martin Reinecke's avatar
Martin Reinecke committed
19
from ..operators.inversion_enabler import InversionEnabler
20
from ..operators.sampling_enabler import SamplingEnabler
Philipp Arras's avatar
Philipp Arras committed
21
from ..operators.sandwich_operator import SandwichOperator
22

Martin Reinecke's avatar
PEP8    
Martin Reinecke committed
23

24
def WienerFilterCurvature(R, N, S, iteration_controller=None,
25
                          iteration_controller_sampling=None):
Jakob Knollmueller's avatar
Jakob Knollmueller committed
26
27
28
29
    """The curvature of the WienerFilterEnergy.

    This operator implements the second derivative of the
    WienerFilterEnergy used in some minimization algorithms or
30
31
    for error estimates of the posterior maps. It is the
    inverse of the propagator operator.
Jakob Knollmueller's avatar
Jakob Knollmueller committed
32
33
34

    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
35
    R : LinearOperator
Martin Reinecke's avatar
Martin Reinecke committed
36
        The response operator of the Wiener filter measurement.
Martin Reinecke's avatar
Martin Reinecke committed
37
    N : EndomorphicOperator
Martin Reinecke's avatar
Martin Reinecke committed
38
        The noise covariance.
39
40
    S : EndomorphicOperator
        The prior signal covariance.
41
42
43
44
45
    iteration_controller : IterationController
        The iteration controller to use during numerical inversion via
        ConjugateGradient.
    iteration_controller_sampling : IterationController
        The iteration controller to use for sampling.
46
47
48
49
50

    Note
    ----
    If samples shall be drawn from this operator, `N` and `S` have to implement
    `draw_sample()`.
Jakob Knollmueller's avatar
Jakob Knollmueller committed
51
    """
52
53
54
55
56
    if not isinstance(N, EndomorphicOperator):
        raise TypeError
    if not isinstance(S, EndomorphicOperator):
        raise TypeError
    M = SandwichOperator.make(R, N.inverse)
Philipp Arras's avatar
Philipp Arras committed
57
    Sinv = S.inverse
58
    if iteration_controller_sampling is not None:
59
        op = SamplingEnabler(M, Sinv, iteration_controller_sampling, Sinv)
60
    else:
Philipp Arras's avatar
Philipp Arras committed
61
        op = M + Sinv
62
    return InversionEnabler(op, iteration_controller, Sinv)