Commit 87a53824 authored by Philipp Arras's avatar Philipp Arras

Merge branch 'docs_lp' into 'NIFTy_5'

Unified docstring terminology for structured_domain volumes

See merge request ift/nifty-dev!221
parents 3755c48d 5ba0b66d
...@@ -30,7 +30,7 @@ class StructuredDomain(Domain): ...@@ -30,7 +30,7 @@ class StructuredDomain(Domain):
@property @property
def scalar_dvol(self): 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 Returns the volume factors of this domain as a floating
point scalar, if the volume factors are all identical, otherwise point scalar, if the volume factors are all identical, otherwise
...@@ -40,7 +40,7 @@ class StructuredDomain(Domain): ...@@ -40,7 +40,7 @@ class StructuredDomain(Domain):
@property @property
def dvol(self): 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 Returns the volume factors of this domain, either as a floating
point scalar (if the volume factors are all identical) or as a point scalar (if the volume factors are all identical) or as a
......
...@@ -284,12 +284,12 @@ class Field(object): ...@@ -284,12 +284,12 @@ class Field(object):
return res return res
def weight(self, power=1, spaces=None): 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 Parameters
---------- ----------
power : number 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 spaces : None, int or tuple of int
Determines on which sub-domain the operation takes place. Determines on which sub-domain the operation takes place.
......
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