From cb6aa9dec8ed6a56bb456debeb282964aa7e8456 Mon Sep 17 00:00:00 2001
From: Martin Reinecke <martin@mpa-garching.mpg.de>
Date: Mon, 19 Feb 2018 09:49:35 +0100
Subject: [PATCH] doc tweaks
---
nifty4/library/nonlinear_power_energy.py | 2 +-
nifty4/library/wiener_filter_curvature.py | 12 +++++++-----
nifty4/library/wiener_filter_energy.py | 20 ++++++++++----------
3 files changed, 18 insertions(+), 16 deletions(-)
diff --git a/nifty4/library/nonlinear_power_energy.py b/nifty4/library/nonlinear_power_energy.py
index f6d2ce48d..f05ce9a24 100644
--- a/nifty4/library/nonlinear_power_energy.py
+++ b/nifty4/library/nonlinear_power_energy.py
@@ -50,7 +50,7 @@ class NonlinearPowerEnergy(Energy):
corrections.
default : 3
"""
-
+ # MR FIXME: docstring incomplete and outdated
def __init__(self, position, d, N, xi, D, ht, Instrument, nonlinearity,
Distribution, sigma=0., samples=3, xi_sample_list=None,
inverter=None):
diff --git a/nifty4/library/wiener_filter_curvature.py b/nifty4/library/wiener_filter_curvature.py
index 6588e60bd..39597bdac 100644
--- a/nifty4/library/wiener_filter_curvature.py
+++ b/nifty4/library/wiener_filter_curvature.py
@@ -32,12 +32,14 @@ class WienerFilterCurvature(EndomorphicOperator):
Parameters
----------
- R: LinearOperator,
- The response operator of the Wiener filter measurement.
+ R: LinearOperator
+ The response operator of the Wiener filter measurement.
N: EndomorphicOperator
- The noise covariance.
- S: DiagonalOperator,
- The prior signal covariance
+ The noise covariance.
+ S: EndomorphicOperator
+ The prior signal covariance
+ inverter : Minimizer
+ The minimizer to use during numerical inversion
"""
def __init__(self, R, N, S, inverter):
diff --git a/nifty4/library/wiener_filter_energy.py b/nifty4/library/wiener_filter_energy.py
index 0e75607c6..925c7729a 100644
--- a/nifty4/library/wiener_filter_energy.py
+++ b/nifty4/library/wiener_filter_energy.py
@@ -28,17 +28,17 @@ class WienerFilterEnergy(Energy):
Parameters
----------
- position: Field,
+ position: Field
The current map in harmonic space.
- d: Field,
- the data
- R: LinearOperator,
- The response operator, description of the measurement process. It needs
- to map from harmonic signal space to data space.
- N: EndomorphicOperator,
- The noise covariance in data space.
- S: EndomorphicOperator,
- The prior signal covariance in harmonic space.
+ d: Field
+ the data
+ R: LinearOperator
+ The response operator, description of the measurement process. It needs
+ to map from harmonic signal space to data space.
+ N: EndomorphicOperator
+ The noise covariance in data space.
+ S: EndomorphicOperator
+ The prior signal covariance in harmonic space.
"""
def __init__(self, position, d, R, N, S, inverter, _j=None):
--
GitLab