Commit 388334ea authored by Natalia Porqueres's avatar Natalia Porqueres
Browse files

worked in parallel on same branch with Reimar.

parents 9367b18c d8f33788
Pipeline #12284 passed with stage
in 6 minutes and 8 seconds
...@@ -37,7 +37,7 @@ class LMSpace(Space): ...@@ -37,7 +37,7 @@ class LMSpace(Space):
NIFTY subclass for spherical harmonics components, for representations NIFTY subclass for spherical harmonics components, for representations
of fields on the two-sphere. of fields on the two-sphere.
Parameters Attributes
---------- ----------
lmax : int lmax : int
The maximal :math:`l` value of any spherical harmonics The maximal :math:`l` value of any spherical harmonics
...@@ -45,6 +45,14 @@ class LMSpace(Space): ...@@ -45,6 +45,14 @@ class LMSpace(Space):
mmax : int mmax : int
The maximal :math:`m` value of any spherical harmonic The maximal :math:`m` value of any spherical harmonic
:math:`Y_{lm}` that is represented in this Space. :math:`Y_{lm}` that is represented in this Space.
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.
See Also See Also
-------- --------
......
...@@ -25,16 +25,15 @@ from d2o.config import configuration as d2o_config ...@@ -25,16 +25,15 @@ from d2o.config import configuration as d2o_config
class PowerIndices(object): class PowerIndices(object):
def __init__(self, domain, distribution_strategy, """Computes helpful quantities to deal with power spectra.
logarithmic=False, nbin=None, binbounds=None):
""" Given the shape and the density of a underlying rectangular grid this
Returns an instance of the PowerIndices class. Given the shape and class provides the user
the density of a underlying rectangular grid it provides the user
with the pindex, kindex, rho and pundex. The indices are binned with the pindex, kindex, rho and pundex. The indices are binned
according to the supplied parameter scheme. If wanted, computed according to the supplied parameter scheme. If wanted, computed
results are stored for future reuse. results are stored for future reuse.
Parameters Attributes
---------- ----------
shape : tuple, list, ndarray shape : tuple, list, ndarray
Array-like object which specifies the shape of the underlying Array-like object which specifies the shape of the underlying
...@@ -51,6 +50,8 @@ class PowerIndices(object): ...@@ -51,6 +50,8 @@ class PowerIndices(object):
Array-like inner boundaries of the used bins of the default Array-like inner boundaries of the used bins of the default
indices. indices.
""" """
def __init__(self, domain, distribution_strategy,
logarithmic=False, nbin=None, binbounds=None):
self.domain = domain self.domain = domain
self.distribution_strategy = distribution_strategy self.distribution_strategy = distribution_strategy
......
...@@ -54,14 +54,24 @@ class PowerSpace(Space): ...@@ -54,14 +54,24 @@ class PowerSpace(Space):
Attributes Attributes
---------- ----------
pindex : distributed_data_object pindex : distributed_data_object
TODO add description This holds the information which pixel of the harmonic partner gets
mapped to which power bin
kindex : numpy.ndarray kindex : numpy.ndarray
TODO add description Sorted array of all k-modes.
pundex : numpy.ndarray pundex : numpy.ndarray
TODO add description Flat index of the first occurence of a k-vector with length==kindex[n]
in the k_array.
rho : numpy.ndarray rho : numpy.ndarray
The amount of k-modes that get mapped to one power bin is given by The amount of k-modes that get mapped to one power bin is given by
rho. rho.
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.
Notes Notes
...@@ -216,7 +226,7 @@ class PowerSpace(Space): ...@@ -216,7 +226,7 @@ class PowerSpace(Space):
@property @property
def pindex(self): def pindex(self):
""" A distributed_data_objects having the shape of the harmonic partner """ A distributed_data_object having the shape of the harmonic partner
space containing the indices of the power bin a pixel belongs to. space containing the indices of the power bin a pixel belongs to.
""" """
return self._pindex return self._pindex
......
Supports Markdown
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