Add List of Examples

[CSSFrancis]

Is your feature request related to a problem? Please describe.

I think that while the complete workflows are nice examples of how to do certain things in pyxem, it would be good to add in shorter examples for how to do small functions in hyperspy.

Describe the solution you'd like

I propose that we break the examples into:

1. Preprocessing Data

   • Centering the zero beam
   • Finding peaks
   • Calibrating from a standard
   • Azimuthal Integration
   • Real Space Alignment

2. Visualization

   • Move Template matching Euler angle reference frame #925 here or into user guide
   • Plotting clustering results on navigation (using new Polygons Marker)
   • Showing diffraction peaks (using new Points Marker)
   • Visualizing peaks shift (using Points Marker and Scalar Mappable)
   • Visualizing Orientation Mapping results on signal/navigation (
   • Setting the navigator before plotting

[hakonanes]

Good idea. I suggest to restrict the examples to short recipes for common tasks in pyxem. I find the lengths of the Matplotlib examples a good reference when adding them to the kikuchipy docs and the orix docs.

I find that examples lower the bar for adding snippets to the docs. A common pattern I've used is to add snippets I myself use regularly in a workflow or someone posts in an issue or PR. We might not have the time to add them as functionality to the API, or they might not be ready for that yet. But by adding them to the examples gallery, they are there for people to see and use. And we can later on easily add them to the API.