Commit cb6aa9de authored by Martin Reinecke's avatar Martin Reinecke
Browse files

doc tweaks

parent e53a1ac6
Pipeline #25111 canceled with stage
in 1 minute and 23 seconds
......@@ -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):
......
......@@ -32,12 +32,14 @@ class WienerFilterCurvature(EndomorphicOperator):
Parameters
----------
R: LinearOperator,
R: LinearOperator
The response operator of the Wiener filter measurement.
N: EndomorphicOperator
The noise covariance.
S: DiagonalOperator,
S: EndomorphicOperator
The prior signal covariance
inverter : Minimizer
The minimizer to use during numerical inversion
"""
def __init__(self, R, N, S, inverter):
......
......@@ -28,16 +28,16 @@ class WienerFilterEnergy(Energy):
Parameters
----------
position: Field,
position: Field
The current map in harmonic space.
d: Field,
d: Field
the data
R: LinearOperator,
R: LinearOperator
The response operator, description of the measurement process. It needs
to map from harmonic signal space to data space.
N: EndomorphicOperator,
N: EndomorphicOperator
The noise covariance in data space.
S: EndomorphicOperator,
S: EndomorphicOperator
The prior signal covariance in harmonic space.
"""
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment