Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
ift
NIFTy
Commits
30893f68
Commit
30893f68
authored
May 15, 2017
by
Theo Steininger
Browse files
Merge branch 'update_Docstring_Operators' into 'master'
Update docstring operators See merge request
!115
parents
4e5998d2
1582d07b
Pipeline
#12417
passed with stages
in 13 minutes and 19 seconds
Changes
9
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
nifty/operators/composed_operator/composed_operator.py
View file @
30893f68
...
...
@@ -28,6 +28,10 @@ class ComposedOperator(LinearOperator):
----------
operators : tuple of NIFTy Operators
The tuple of LinearOperators.
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes
----------
...
...
@@ -35,6 +39,8 @@ class ComposedOperator(LinearOperator):
The NIFTy.space in which the operator is defined.
target : tuple of DomainObjects, i.e. Spaces and FieldTypes
The NIFTy.space in which the outcome of the operator lives
unitary : boolean
Indicates whether the Operator is unitary or not.
Raises
------
...
...
nifty/operators/diagonal_operator/diagonal_operator.py
View file @
30893f68
...
...
@@ -50,9 +50,21 @@ class DiagonalOperator(EndomorphicOperator):
setting the prober distribution_strategy of the
diagonal (default : None). In case diagonal is d2o-object or Field,
their distribution_strategy is used as a fallback.
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes
----------
domain : tuple of DomainObjects, i.e. Spaces and FieldTypes
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.
distribution_strategy : string
Defines the distribution_strategy of the distributed_data_object
in which the diagonal entries are stored in.
...
...
nifty/operators/endomorphic_operator/endomorphic_operator.py
View file @
30893f68
...
...
@@ -30,7 +30,9 @@ class EndomorphicOperator(LinearOperator):
Parameters
----------
#TODO: Copy Parameters from LinearOperator
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes
----------
...
...
@@ -39,6 +41,8 @@ class EndomorphicOperator(LinearOperator):
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.
...
...
nifty/operators/projection_operator/projection_operator.py
View file @
30893f68
...
...
@@ -33,9 +33,21 @@ class ProjectionOperator(EndomorphicOperator):
----------
projection_field : Field
Field on which the operator projects
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes
----------
domain : tuple of DomainObjects, i.e. Spaces and FieldTypes
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.
Raises
------
...
...
nifty/operators/propagator_operator/harmonic_propagator_operator.py
View file @
30893f68
...
...
@@ -46,9 +46,21 @@ class HarmonicPropagatorOperator(InvertibleOperatorMixin, EndomorphicOperator):
(default:ConjugateGradient)
preconditioner : Field
numerical preconditioner to speed up convergence
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes
----------
domain : tuple of DomainObjects, i.e. Spaces and FieldTypes
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.
Raises
------
...
...
nifty/operators/propagator_operator/propagator_operator.py
View file @
30893f68
...
...
@@ -44,9 +44,21 @@ class PropagatorOperator(InvertibleOperatorMixin, EndomorphicOperator):
(default:ConjugateGradient)
preconditioner : Field
numerical preconditioner to speed up convergence
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes
----------
domain : tuple of DomainObjects, i.e. Spaces and FieldTypes
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.
Raises
------
...
...
nifty/operators/response_operator/response_operator.py
View file @
30893f68
...
...
@@ -23,10 +23,19 @@ class ResponseOperator(LinearOperator):
Defines the smoothing length of the operator for each space it lives on
exposure : list(np.float)
Defines the exposure of the operator for each space it lives on
default_spaces : tuple of ints *optional*
Defines on which space(s) of a given field the Operator acts by
default (default: None)
Attributes
----------
domain : tuple of DomainObjects, i.e. Spaces and FieldTypes
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.
Raises
------
...
...
nifty/operators/smoothing_operator/smoothing_operator.py
View file @
30893f68
...
...
@@ -35,15 +35,28 @@ class SmoothingOperator(EndomorphicOperator):
Parameters
----------
domain : tuple of DomainObjects, i.e. Spaces and FieldTypes
The Space on which the operator acts
domain : DomainObject, i.e. Space or FieldType
The Space on which the operator acts. The SmoothingOperator
can only live on one space or FieldType
sigma : float
Sets the length of the Gaussian convolution kernel
log_distances : boolean
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
----------
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
Sets the length of the Gaussian convolution kernel
log_distances : boolean
...
...
test/test_operators/test_response_operator.py
View file @
30893f68
...
...
@@ -6,7 +6,7 @@ from numpy.testing import assert_equal,\
from
nifty
import
Field
,
\
RGSpace
,
\
ResponseOperator
,
\
ResponseOperator
from
itertools
import
product
from
test.common
import
expand
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment