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

Change default behavior of AngularSeparation #1241

Open
ispivack opened this issue Apr 9, 2024 · 0 comments
Open

Change default behavior of AngularSeparation #1241

ispivack opened this issue Apr 9, 2024 · 0 comments
Labels
task A task to be completed.

Comments

@ispivack
Copy link

ispivack commented Apr 9, 2024

Description

Either the default behavior of equiv_orientations in AngularSeparation must be updated to include the degenerate identity quaternion (-1,0,0,0) or the function behavior should be updated to not force the user to supply the degenerate negative quaternions.

Motivation and Context

I believe there is some unintentional behavior in freud in AngularSeparation. AngularSeparation takes in a parameter called equiv_orientations, which allows you to give quaternions that map a shape to itself to account for shape symmetry.

However, if you don't give any value, this parameter defaults to (1,0,0,0), According to the documentation, you are meant to include the degenerate negative quaternions (-q for each q). If you explicitly give equiv_orientations = [(1,0,0,0),(-1,0,0,0)], the result is different.

I'm not marking this as a bug, because the documentation correctly describes the behavior, but the default behavior in not physically relevant.

@ispivack ispivack added the task A task to be completed. label Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task A task to be completed.
Projects
None yet
Development

No branches or pull requests

1 participant