-
Notifications
You must be signed in to change notification settings - Fork 270
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
Adding an example notebook no how to convert hex geometry to square and back #767
Adding an example notebook no how to convert hex geometry to square and back #767
Conversation
Codecov Report
@@ Coverage Diff @@
## master #767 +/- ##
=======================================
Coverage 70.95% 70.95%
=======================================
Files 198 198
Lines 10691 10691
=======================================
Hits 7586 7586
Misses 3105 3105
Continue to review full report at Codecov.
|
Nice. I didn't even know this was in there. I don't quite understand why manually indexing the buffer is neccessary in the first place. |
@mackaiver I am not sure to understand why it's done this way either actually... but it is necessary for the user to be able to convert back to hexagonal. |
My idea was to give the user a more fine-grained control over the uniqueness of the entries in the buffer (up to not using the buffer at all). |
Yeah guess using |
Perhaps a small 2 line example of converting forward and back should be added to the docstring as well, if it's confusing to use (that way people don't have to go looking in all the notebooks) |
Alright, I added example code in the docstring. I also tried to use cam_id as default key but it would mean changing the default key of the square geometry from "LSTCam_square" back to simply "LSTCam" which would be a bad thing overall imo. |
It was not clear for me at first how to convert back from square to hexagonal geometry using the key (and the hidden buffer).
So I modified a bit the docstring of the conversion function and made an example notebook.