Skip to content
Snippets Groups Projects
Commit aef6ea9b authored by Martin Reinecke's avatar Martin Reinecke
Browse files

tweak docs

parent a85c366b
No related branches found
No related tags found
No related merge requests found
......@@ -36,8 +36,8 @@ class Field(object):
This object's global shape must match the domain shape
After construction, the object will no longer be writeable!
Note
----
Notes
-----
If possible, do not invoke the constructor directly, but use one of the
many convenience functions for instantiation!
"""
......@@ -190,8 +190,8 @@ class Field(object):
def val(self):
"""dobj.data_object : the data object storing the field's entries.
Note
----
Notes
-----
This property is intended for low-level, internal use only. Do not use
from outside of NIFTy's core; there should be better alternatives.
"""
......
......@@ -51,13 +51,12 @@ def CorrelatedField(target, amplitude_operator, name='xi', codomain=None):
Operator
Correlated field
Note
----
Non-harmonic RGSpaces are by definition periodic in NIFTy. Thereby, the
output of the operator being constructed by the method at hand, is a
correlated field with *periodic* boundary conditions. If a non-periodic
field is needed, one needs to compose this operator with a
:class:`FieldZeroPadder`.
Notes
-----
In NIFTy, non-harmonic RGSpaces are by definition periodic. Therefore
the operator constructed by this method will output a correlated field
with *periodic* boundary conditions. If a non-periodic field is needed,
one needs to combine this operator with a :class:`FieldZeroPadder`.
"""
tgt = DomainTuple.make(target)
if len(tgt) > 1:
......@@ -99,14 +98,13 @@ def MfCorrelatedField(target, amplitudes, name='xi'):
Operator
Correlated field
Note
----
Non-harmonic RGSpaces are by definition periodic in NIFTy. Thereby, the
output of the operator being constructed by the method at hand, is a
correlated field with *periodic* boundary conditions. If a non-periodic
field is needed, one needs to compose this operator with a
:class:`FieldZeroPadder` or even two of them (one for the energy and one
for the spatial subdomain).
Notes
-----
In NIFTy, non-harmonic RGSpaces are by definition periodic. Therefore
the operator constructed by this method will output a correlated field
with *periodic* boundary conditions. If a non-periodic field is needed,
one needs to combine this operator with a :class:`FieldZeroPadder` or even
two (one for the energy and one for the spatial subdomain)
"""
tgt = DomainTuple.make(target)
if len(tgt) != 2:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment