Skip to content

Commit 4ce5ee3

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

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

pyEXP/BasisWrappers.cc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1331,19 +1331,21 @@ void BasisFactoryClasses(py::module &m)
13311331
py::arg("mass"), py::arg("pos"))
13321332
.def("getCoefCovariance", &BasisClasses::BiorthBasis::getCoefCovariance,
13331333
R"(
1334-
Return the coefficient vectors and covariance matrices for a partition
1335-
of the accumulated particles. The number of partitions is set by the
1336-
configuration parameters 'sampT' and defaults to 100.
1334+
Return the coefficient vectors and covariance matrices for each partition
1335+
of the accumulated particles. The number of partitions is set by the
1336+
configuration parameter 'sampT' (default: 100).
13371337
1338-
Parameters
1339-
----------
1340-
None
1338+
The coefficients are returned in the [specify: real basis (separate cos/sin for m>0; total angular dimension (lmax+1)^2) or complex triangular packing (l,m≥0; angular dimension (lmax+1)(lmax+2)/2)].
1339+
Each coefficient vector has shape (angular_dimension,), and each covariance matrix has shape (angular_dimension, angular_dimension).
1340+
The ordering of harmonic indices within the coefficient vector and covariance matrix is [specify: e.g., for real basis, (l, m) ordered with m from -l to l for each l from 0 to lmax; for complex packing, (l, m) with m from 0 to l for each l from 0 to lmax].
1341+
This allows consumers to unambiguously map (l, m) to positions in the arrays.
13411342
13421343
Returns
13431344
-------
13441345
arrays: list[list[tuple[np.ndarray, np.ndarray]]]
1345-
Each element is a tuple (coef_vector, coef_covariance_matrix),
1346-
where coef_vector and coef_covariance_matrix are numpy.ndarray.
1346+
Each element is a tuple (coef_vector, coef_covariance_matrix),
1347+
where coef_vector and coef_covariance_matrix are numpy.ndarray.
1348+
Each coef_covariance_matrix is of shape (angular_dimension, angular_dimension).
13471349
13481350
See also
13491351
--------

0 commit comments

Comments
 (0)