Commit edf4e610 authored by Philipp Arras's avatar Philipp Arras
Browse files

Docs

parent ccea675a
......@@ -27,8 +27,8 @@ class DiagonalOperator(EndomorphicOperator):
"""Represents a :class:`LinearOperator` which is diagonal.
The NIFTy DiagonalOperator class is a subclass derived from the
:class:`EndomorphicOperator`. It multiplies an input field pixel-wise with its
diagonal.
:class:`EndomorphicOperator`. It multiplies an input field pixel-wise with
its diagonal.
Parameters
----------
......
......@@ -33,6 +33,9 @@ class ScalingOperator(EndomorphicOperator):
Notes
-----
:class:`Operator` supports the multiplication with a scalar. So one does
not need instantiate :class:`ScalingOperator` explicitly in most cases.
Formally, this operator always supports all operation modes (times,
adjoint_times, inverse_times and inverse_adjoint_times), even if `factor`
is 0 or infinity. It is the user's responsibility to apply the operator
......
......@@ -29,8 +29,8 @@ class SlopeOperator(LinearOperator):
Slope and y-intercept of this line are the two parameters which are
defined on an UnstructeredDomain (in this order) which is the domain of
the operator. Being a LogRGSpace instance each pixel has a well-defined coordinate
value.
the operator. Being a LogRGSpace instance each pixel has a well-defined
coordinate value.
The y-intercept is defined to be the value at t_0 of the target.
......
......@@ -28,6 +28,7 @@ from .linear_operator import LinearOperator
class ValueInserter(LinearOperator):
# FIXME THIS IS NOT A LINEAR OPERATOR
"""Inserts one value into a field which is constant otherwise.
Parameters
......
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