Commit 55124bb3 authored by Martin Reinecke's avatar Martin Reinecke

cosmetics

parent ce993976
......@@ -22,7 +22,7 @@ from .structured_domain import StructuredDomain
class LMSpace(StructuredDomain):
"""Represents sets of spherical harmonic coefficients.
"""Represents a set of spherical harmonic coefficients.
Its harmonic partner spaces are :class:`~nifty5.domains.hp_space.HPSpace`
and :class:`~nifty5.domains.gl_space.GLSpace`.
......
......@@ -25,7 +25,7 @@ from .domain_tuple import DomainTuple
class Field(object):
"""The discrete representation of a continuous field over multiple spaces.
Stores data arrays and carry all the needed metainformation (i.e. the
Stores data arrays and carries all the needed metainformation (i.e. the
domain) for operators to be able to operate on them.
Parameters
......
......@@ -25,8 +25,8 @@ from ..operators.simple_linear_operators import ducktape
def CorrelatedField(target, amplitude_operator, name='xi'):
'''Constructs operator which turns white Gaussian excitation fields into a
correlated field.
'''Constructs an operator which turns a white Gaussian excitation field
into a correlated field.
This function returns an operator which implements:
......@@ -38,8 +38,7 @@ def CorrelatedField(target, amplitude_operator, name='xi'):
Parameters
----------
target : Domain, DomainTuple or tuple of Domain
Target of the operator. Is not allowed to be a DomainTuple with more
than one space.
Target of the operator. Must contain exactly one space.
amplitude_operator: Operator
name : string
:class:`MultiField` key for xi-field.
......@@ -61,18 +60,17 @@ def CorrelatedField(target, amplitude_operator, name='xi'):
def MfCorrelatedField(target, amplitudes, name='xi'):
'''Constructs operator which turns white Gaussian excitation fields into a
correlated field defined on a DomainTuple with two entries and two separate
correlation structures.
'''Constructs an operator which turns white Gaussian excitation fields
into a correlated field defined on a DomainTuple with two entries and two
separate correlation structures.
This operator may be used as model for multi-frequency reconstructions
This operator may be used as a model for multi-frequency reconstructions
with a correlation structure in both spatial and energy direction.
Parameters
----------
target : Domain, DomainTuple or tuple of Domain
Target of the operator. Is not allowed to be a DomainTuple with more
than one space.
Target of the operator. Must contain exactly one space.
amplitudes: iterable of Operator
List of two amplitude operators.
name : string
......
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