pyxem / kikuchipy

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns
https://kikuchipy.org
GNU General Public License v3.0
78 stars 30 forks source link

Add description of how to navigate RGBA images to the kikuchipy documentation #653

Closed AndreasBugten closed 11 months ago

AndreasBugten commented 11 months ago

Description of the change

In the kikuchipy documentation it is not described how one can navigate in RGBA images. The description can be added to the "Any image" part in the tutorial "Visualizing patterns" (https://kikuchipy.org/en/stable/tutorials/visualizing_patterns.html#Any-image).

Progress of the PR

For reviewers

hakonanes commented 11 months ago

Thanks for this suggestion, @AndreasBugten. Can you remove the test.txt file and add the suggestion to the appropriate part of the relevant tutorial: https://github.com/pyxem/kikuchipy/blob/develop/doc/tutorials/visualizing_patterns.ipynb?

hakonanes commented 11 months ago

The change looks good, @AndreasBugten! https://kikuchipy--653.org.readthedocs.build/en/653/tutorials/visualizing_patterns.html#Any-image

To clarify that the two new maps come from two different plotting commands, I'll split the cells into two after CrystalMap.plot() is called.

I'll also add you as a contributor. Is it OK if I add NTNU as your affiliation and your ORCID, like this?

https://github.com/pyxem/kikuchipy/blob/3e0c8c0d2593a030e274c2fa1a5816e2253925ba/.zenodo.json#L4-L6

AndreasBugten commented 11 months ago

That is ok, @hakonanes! Thank you very much.

hakonanes commented 11 months ago

Andreas V. Bugten or just Andreas Bugten?

AndreasBugten commented 11 months ago

Andreas V. Bugten is good. Thank you.

hakonanes commented 11 months ago

Thank you for your first contribution to kikuchipy, @AndreasBugten! I'm hoping for more...