Skip to content

Commit 15b004f

Browse files
The9CatCopilot
andauthored
Update pyEXP/BasisWrappers.cc
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 4ce5ee3 commit 15b004f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

pyEXP/BasisWrappers.cc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,6 +1347,18 @@ void BasisFactoryClasses(py::module &m)
13471347
where coef_vector and coef_covariance_matrix are numpy.ndarray.
13481348
Each coef_covariance_matrix is of shape (angular_dimension, angular_dimension).
13491349
1350+
Shape and Indexing
1351+
------------------
1352+
- Coefficient vectors are returned in the real basis, with separate cosine and sine
1353+
components for m>0. The total angular dimension is (lmax+1)^2, corresponding to
1354+
all (l, m) pairs with -l ≤ m ≤ l for each l = 0, ..., lmax.
1355+
- Each covariance matrix is of shape (nmax, nmax), where nmax is the number of basis
1356+
functions (typically (lmax+1)^2).
1357+
- The ordering of harmonic indices within the outer list is such that for each l from
1358+
0 to lmax, m runs from -l to l, with cosine and sine components for m>0 stored
1359+
separately (e.g., [Y_{l,0}, Y_{l,1}^{cos}, Y_{l,1}^{sin}, ..., Y_{l,l}^{cos}, Y_{l,l}^{sin}]).
1360+
This allows consumers to unambiguously map (l, m) to positions in the coefficient vector
1361+
and covariance matrix.
13501362
See also
13511363
--------
13521364
getCovarSamples : get counts and mass in each partition

0 commit comments

Comments
 (0)