Commit 750bafe7 authored by Philipp Arras's avatar Philipp Arras
Browse files

Documentation

parent b53c531b
......@@ -32,7 +32,6 @@ class PowerSpace(StructuredDomain):
harmonic_partner : StructuredDomain
The harmonic domain of which this is the power space.
binbounds : None, or tuple of float
FIXME Add docu for binbounds
By default (binbounds=None):
There are as many bins as there are distinct k-vector lengths in
the harmonic partner space.
......
......@@ -41,6 +41,11 @@ class RGSpace(StructuredDomain):
harmonic : bool, optional
Whether the space represents a grid in position or harmonic space.
Default: False.
Notes
-----
Topologically, a n-dimensional RGSpace is a n-Torus, i.e. it has periodic
boundary conditions.
"""
_needed_for_hash = ["_distances", "_shape", "_harmonic"]
......
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