Commit 7585873e authored by Martin Reinecke's avatar Martin Reinecke
Browse files

Merge branch '14-add-documentation-to-samplingenabler' into 'NIFTy_5'

Resolve "Add documentation to SamplingEnabler"

Closes #14

See merge request ift/nifty-dev!9
parents 55a5717b 50aaa53f
......@@ -24,16 +24,17 @@ from .endomorphic_operator import EndomorphicOperator
class SamplingEnabler(EndomorphicOperator):
"""Class which augments the capability of another operator object via
numerical inversion.
"""Class which acts as the operator object (likelihood + prior)
and enables sampling from its inverse even if the operator object
itself does not support it.
op : :class:`EndomorphicOperator`
The operator to be enhanced.
The InversionEnabler object will support the same operation modes as
`op`, and additionally the inverse set. The newly-added modes will
be computed by iterative inversion.
likelihood : :class:`EndomorphicOperator`
Curvature of the likelihood
prior : :class:`EndomorphicOperator`
Inverse curvature of the prior
iteration_controller : :class:`IterationController`
The iteration controller to use for the iterative numerical inversion
done by a :class:`ConjugateGradient` object.
Supports Markdown
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