From 86945e26c5d4bd962589a8a1cc811523d625097f Mon Sep 17 00:00:00 2001 From: Lukas Platz Date: Wed, 30 Jan 2019 16:42:31 +0100 Subject: [PATCH] unified docstring terminology for structured_domain volumes --- nifty5/domains/structured_domain.py | 4 ++-- nifty5/field.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/nifty5/domains/structured_domain.py b/nifty5/domains/structured_domain.py index 491d0aa0..3ab7d9d4 100644 --- a/nifty5/domains/structured_domain.py +++ b/nifty5/domains/structured_domain.py @@ -30,7 +30,7 @@ class StructuredDomain(Domain): @property def scalar_dvol(self): - """float or None : uniform cell volume, if applicable + """float or None : uniform pixel volume, if applicable Returns the volume factors of this domain as a floating point scalar, if the volume factors are all identical, otherwise @@ -40,7 +40,7 @@ class StructuredDomain(Domain): @property def dvol(self): - """float or numpy.ndarray(dtype=float): Volume factors + """float or numpy.ndarray(dtype=float): pixel volume(s) Returns the volume factors of this domain, either as a floating point scalar (if the volume factors are all identical) or as a diff --git a/nifty5/field.py b/nifty5/field.py index b0e5ef00..79a8af7f 100644 --- a/nifty5/field.py +++ b/nifty5/field.py @@ -284,12 +284,12 @@ class Field(object): return res def weight(self, power=1, spaces=None): - """Weights the pixels of `self` with their invidual pixel-volume. + """Weights the pixels of `self` with their invidual pixel volumes. Parameters ---------- power : number - The pixels get weighted with the volume-factor**power. + The pixel values get multiplied with their volume-factor**power. spaces : None, int or tuple of int Determines on which sub-domain the operation takes place. -- GitLab