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

Slider: Naming Slice #148

Closed
ax3l opened this issue Feb 28, 2017 · 6 comments
Closed

Slider: Naming Slice #148

ax3l opened this issue Feb 28, 2017 · 6 comments

Comments

@ax3l
Copy link
Member

ax3l commented Feb 28, 2017

With "slice direction" in the OpenPMDTimeSeries.slider we actually mean the slice normal, don't we? Should we rename it, I find the term direction to be quite arbitrary in the widget (because a plane would need at least to base vectors pointing somewhere in the plane to span a slice).

@RemiLehe
Copy link
Member

Yes, it is indeed the slice normal.
One option would be to replace "Slice direction" by "Slice along:". The idea is that when the user wants an x-z slice, then he has to slice the data along y.

Would this be a good solution?

@RemiLehe
Copy link
Member

RemiLehe commented Mar 1, 2017

Actually, please disregard my latest comment: in the end, I think "Slice along" is just as confusing as "Slice direction:".
So, I agree that "Slice perpendicular to" or "Slice orthogononal to" is clearer but it is also a bit too long for the GUI:
screen shot 2017-03-01 at 8 28 29 am

Instead what, do you think of "Slicing through:" (a bit less clear, but also much shorter). Any other suggestion otherwise?

@ax3l
Copy link
Member Author

ax3l commented Mar 1, 2017

Wuhu, yeas that's why I thought make it short and explicit with "slice normal:" specifying the normal of the slice :)

I would also rename "Coord" to "comp." or "component" since it's not necessarily along the same and can be confusing.

@RemiLehe
Copy link
Member

RemiLehe commented Mar 1, 2017

OK, "Slice normal:" works. I'll prepare a PR for this.

Regarding changing "coord" to "comp.", the problem is that the get_field API uses "coord" (which is probably a badly chosen name, but we now have to stick to it for backwards compatibility). Of course, we can use a different name in the GUI and the API, but I would rather not. What do you think?

@ax3l
Copy link
Member Author

ax3l commented Mar 1, 2017 via email

@ax3l ax3l closed this as completed Mar 3, 2017
@ax3l
Copy link
Member Author

ax3l commented Mar 3, 2017

closed via #149

soerenjalas referenced this issue in soerenjalas/openPMD-viewer Sep 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants