Commit 1cd2368b authored by Pumpe, Daniel (dpumpe)'s avatar Pumpe, Daniel (dpumpe)
Browse files

update Docstring for SmoothingOperator

parent c9c8574b
...@@ -35,15 +35,28 @@ class SmoothingOperator(EndomorphicOperator): ...@@ -35,15 +35,28 @@ class SmoothingOperator(EndomorphicOperator):
Parameters Parameters
---------- ----------
domain : tuple of DomainObjects, i.e. Spaces and FieldTypes domain : DomainObject, i.e. Space or FieldType
The Space on which the operator acts The Space on which the operator acts. The SmoothingOperator
can only live on one space or FieldType
sigma : float sigma : float
Sets the length of the Gaussian convolution kernel Sets the length of the Gaussian convolution kernel
log_distances : boolean log_distances : boolean
States whether the convolution happens on the logarithmic grid or not. States whether the convolution happens on the logarithmic grid or not.
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes Attributes
---------- ----------
domain : DomainObject, i.e. Space or FieldType
The domain on which the Operator's input Field lives.
target : tuple of DomainObjects, i.e. Spaces and FieldTypes
The domain in which the outcome of the operator lives. As the Operator
is endomorphic this is the same as its domain.
unitary : boolean
Indicates whether the Operator is unitary or not.
self_adjoint : boolean
Indicates whether the operator is self_adjoint or not.
sigma : float sigma : float
Sets the length of the Gaussian convolution kernel Sets the length of the Gaussian convolution kernel
log_distances : boolean log_distances : boolean
......
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