Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
ift
NIFTy
Commits
9367b18c
Commit
9367b18c
authored
May 11, 2017
by
Natalia Porqueres
Browse files
Added docu for attributes in space classes
parent
41961dc0
Changes
3
Show whitespace changes
Inline
Side-by-side
nifty/spaces/gl_space/gl_space.py
View file @
9367b18c
...
...
@@ -39,12 +39,21 @@ class GLSpace(Space):
NIFTY subclass for Gauss-Legendre pixelizations [#]_ of the two-sphere.
Parame
te
r
s
Attribu
tes
----------
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
Number of latitudinal bins, or rings.
Number of latitudinal bins (or rings) that are used for this
pixelization.
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
------
...
...
nifty/spaces/hp_space/hp_space.py
View file @
9367b18c
...
...
@@ -33,11 +33,19 @@ class HPSpace(Space):
NIFTY subclass for HEALPix discretizations of the two-sphere [#]_.
Parame
te
r
s
Attribu
tes
----------
nside :
Resolution parameter for the HEALPix discretization, resulting in
``12*nside**2`` pixels. Must be positive.
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.
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
------
...
...
nifty/spaces/rg_space/rg_space.py
View file @
9367b18c
...
...
@@ -48,26 +48,6 @@ class RGSpace(Space):
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
----------
harmonic : bool
...
...
@@ -76,7 +56,15 @@ class RGSpace(Space):
Whether x==0 (or k==0, respectively) is located in the center of
the grid (or the center of each axis speparately) or not.
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):
@
property
def
zerocenter
(
self
):
"""Returns True if grid points lie symmetrically around zero
"""Returns True if grid points lie symmetrically around zero
.
Returns
-------
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment