Commit 4404fc4a authored by Philipp Arras's avatar Philipp Arras

Live -> is defined

parent ab18a1b7
......@@ -95,7 +95,7 @@ if __name__ == '__main__':
# Build instrument response consisting of a discretization, mask
# and harmonic transformaion
# Data lives in a geometry-free space, thus the geometry is removed
# Data is defined on a geometry-free space, thus the geometry is removed
GR = ift.GeometryRemover(position_space)
# Masking operator to model that parts of the field have not been observed
......
......@@ -92,7 +92,7 @@ class StructuredDomain(Domain):
"""Helper for Gaussian smoothing.
This method, which is only implemented for harmonic domains, helps
smoothing fields that live on a domain that has this domain as
smoothing fields that are defined on a domain that has this domain as
its harmonic partner. The returned function multiplies field values of
a field with a zero centered Gaussian which corresponds to a
convolution with a Gaussian kernel and sigma standard deviation in
......
......@@ -336,7 +336,7 @@ class Field(object):
Returns
----------
Field, lives on the product space of self.domain and x.domain
Field, defined on the product space of self.domain and x.domain
"""
if not isinstance(x, Field):
raise TypeError("The multiplier must be an instance of " +
......@@ -350,7 +350,7 @@ class Field(object):
Parameters
----------
x : Field
x must live on the same domain as `self`.
x must be defined on the same domain as `self`.
spaces : None, int or tuple of int (default: None)
The dot product is only carried out over the sub-domains in this
......
......@@ -117,7 +117,7 @@ def AmplitudeModel(s_space, Npixdof, ceps_a, ceps_k, sm, sv, im, iv,
keys=['tau', 'phi'], zero_mode=True):
'''
Computes a smooth power spectrum.
Output lives in PowerSpace.
Output is defined on a PowerSpace.
Parameters
----------
......
......@@ -39,7 +39,7 @@ class DiagonalOperator(EndomorphicOperator):
diagonal : Field
The diagonal entries of the operator.
domain : Domain, tuple of Domain or DomainTuple, optional
The domain on which the Operator's input Field lives.
The domain on which the Operator's input Field is defined.
If None, use the domain of "diagonal".
spaces : int or tuple of int, optional
The elements of "domain" on which the operator acts.
......
......@@ -63,7 +63,7 @@ class DOFDistributor(LinearOperator):
if not isinstance(dofdex, Field):
raise TypeError("dofdex must be a Field")
if not len(dofdex.domain) == 1:
raise ValueError("dofdex must live on exactly one Space")
raise ValueError("dofdex must be defined on exactly one Space")
if not np.issubdtype(dofdex.dtype, np.integer):
raise TypeError("dofdex must contain integer numbers")
if partner != dofdex.domain[0]:
......
......@@ -36,7 +36,7 @@ class ExpTransform(LinearOperator):
This operator creates a log-space subject to the degrees of freedom and
and its target-domain.
Then transforms between this log-space and its target, which lives in
Then transforms between this log-space and its target, which is defined in
normal units.
E.g: A field in log-log-space can be transformed into log-norm-space,
......
......@@ -14,14 +14,14 @@ class Operator(NiftyMetaBase()):
def domain(self):
"""DomainTuple or MultiDomain : the operator's input domain
The domain on which the Operator's input Field lives."""
The domain on which the Operator's input Field is defined."""
return self._domain
@property
def target(self):
"""DomainTuple or MultiDomain : the operator's output domain
The domain on which the Operator's output Field lives."""
The domain on which the Operator's output Field is defined."""
return self._target
@staticmethod
......
......@@ -36,7 +36,7 @@ class ScalingOperator(EndomorphicOperator):
factor : scalar
The multiplication factor
domain : Domain or tuple of Domain or DomainTuple
The domain on which the Operator's input Field lives.
The domain on which the Operator's input Field is defined.
Notes
-----
......
......@@ -278,7 +278,7 @@ class Plot(object):
Parameters
----------
f: Field, or list of Field objects
If `f` is a single Field, it must live over a single `RGSpace`,
If `f` is a single Field, it must be defined on a single `RGSpace`,
`PowerSpace`, `HPSpace`, `GLSPace`.
If it is a list, all list members must be Fields living over the
same one-dimensional `RGSpace` or `PowerSpace`.
......
......@@ -175,12 +175,12 @@ def _create_power_field(domain, power_spectrum):
def create_power_operator(domain, power_spectrum, space=None):
""" Creates a diagonal operator with the given power spectrum.
Constructs a diagonal operator that lives over the specified domain.
Constructs a diagonal operator that is defined on the specified domain.
Parameters
----------
domain : Domain, tuple of Domain or DomainTuple
Domain over which the power operator shall live.
Domain on which the power operator shall be defined.
power_spectrum : callable or Field
An object that contains the power spectrum as a function of k.
space : int
......
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