Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Possible mistake in documentation regarding storage scheme of SO(3) samples #249

Open
PhilippMisofCH opened this issue Dec 2, 2024 · 1 comment
Assignees

Comments

@PhilippMisofCH
Copy link

The documentation of the sampling.so3_samples.f_shape function claims that the storage scheme is $\beta, \alpha, \gamma$

Importantly, the convention adopted for storage of f is :math:`[\beta, \alpha,
\gamma]`, for Euler angles :math:`(\alpha, \beta, \gamma)` following the

but it returns (gamma, beta, alpha) as far as I see,
return _ngamma(N), _nbeta(L, sampling), _nalpha(L, sampling)

which also seems to be consistent with the rest of the library. Is this a mistake in the documentation or did I misunderstand something?

Thanks in advance for the clarification!

@matt-graham
Copy link
Collaborator

Hi @PhilippMisofCH, thanks for flagging this, agreed this looks like a mistake in the documentation (or if not something that needs clarifying!).

@CosmoMatt it looks like the ordering in the returned shape was permuted in 0339538 as part of #134 but the docstring wasn't updated then. Assuming the correct fix is therefore to update the docstring to be consistent the ordering now asssumed in the code?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants