Commit 9367b18c authored by Natalia Porqueres's avatar Natalia Porqueres
Browse files

Added docu for attributes in space classes

parent 41961dc0
...@@ -38,13 +38,22 @@ class GLSpace(Space): ...@@ -38,13 +38,22 @@ class GLSpace(Space):
.. /______/ .. /______/
NIFTY subclass for Gauss-Legendre pixelizations [#]_ of the two-sphere. NIFTY subclass for Gauss-Legendre pixelizations [#]_ of the two-sphere.
Parameters Attributes
---------- ----------
dim : np.int
Total number of dimensionality, i.e. the number of pixels.
harmonic : bool
Specifies whether the space is a signal or harmonic space.
nlat : int nlat : int
Number of latitudinal bins, or rings. Number of latitudinal bins (or rings) that are used for this
pixelization.
nlon : int, *optional* nlon : int, *optional*
Number of longitudinal bins (default: ``2*nlat - 1``). Number of longditudinal bins that are used for this pixelization.
total_volume : np.float
The total volume of the space.
shape : tuple of np.ints
The shape of the space's data array.
Raises Raises
------ ------
......
...@@ -32,12 +32,20 @@ class HPSpace(Space): ...@@ -32,12 +32,20 @@ class HPSpace(Space):
.. /__/ .. /__/
NIFTY subclass for HEALPix discretizations of the two-sphere [#]_. NIFTY subclass for HEALPix discretizations of the two-sphere [#]_.
Parameters Attributes
---------- ----------
nside : dim : np.int
Resolution parameter for the HEALPix discretization, resulting in Total number of dimensionality, i.e. the number of pixels.
``12*nside**2`` pixels. Must be positive. harmonic : bool
Specifies whether the space is a signal or harmonic space.
nside : int
The corresponding HEALPix pixelization. The total number of pixels
is 12*nside**2.
total_volume : np.float
The total volume of the space.
shape : tuple of np.ints
The shape of the space's data array.
Raises Raises
------ ------
......
...@@ -48,26 +48,6 @@ class RGSpace(Space): ...@@ -48,26 +48,6 @@ class RGSpace(Space):
NIFTY subclass for spaces of regular Cartesian grids. NIFTY subclass for spaces of regular Cartesian grids.
Parameters
----------
shape : {int, numpy.ndarray}
Number of grid points or numbers of gridpoints along each axis.
zerocenter : {bool, numpy.ndarray}, *optional*
Whether x==0 (or k==0, respectively) is located in the center of
the grid (or the center of each axis speparately) or not.
(default: False).
distances : {float, numpy.ndarray}, *optional*
Distance between two grid points along each axis
(default: None).
If distances==None:
if harmonic==True, all distances will be set to 1
if harmonic==False, the distance along each axis will be
set to the inverse of the number of points along that
axis.
harmonic : bool, *optional*
Whether the space represents a grid in position or harmonic space.
(default: False).
Attributes Attributes
---------- ----------
harmonic : bool harmonic : bool
...@@ -76,7 +56,15 @@ class RGSpace(Space): ...@@ -76,7 +56,15 @@ class RGSpace(Space):
Whether x==0 (or k==0, respectively) is located in the center of Whether x==0 (or k==0, respectively) is located in the center of
the grid (or the center of each axis speparately) or not. the grid (or the center of each axis speparately) or not.
distances : tuple of floats distances : tuple of floats
Distance between two grid points along the correpsonding axis. Distance between two grid points along the correponding axis.
dim : np.int
Total number of dimensionality, i.e. the number of pixels.
harmonic : bool
Specifies whether the space is a signal or harmonic space.
total_volume : np.float
The total volume of the space.
shape : tuple of np.ints
The shape of the space's data array.
""" """
...@@ -286,7 +274,7 @@ class RGSpace(Space): ...@@ -286,7 +274,7 @@ class RGSpace(Space):
@property @property
def zerocenter(self): def zerocenter(self):
"""Returns True if grid points lie symmetrically around zero """Returns True if grid points lie symmetrically around zero.
Returns Returns
------- -------
......
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