|
| 1 | +User guide |
| 2 | +========== |
| 3 | + |
| 4 | +Overview |
| 5 | +-------- |
| 6 | +``napari-matplotlib`` contains a number of different ``napari`` Widgets. Each |
| 7 | +widget is designed to map one or more ``napari`` Layers on to a ``matplotlib`` plot. |
| 8 | +As an example, the `~.HistogramWidget` is used to |
| 9 | +map one or more Image layers on to a 1D histogram plot. |
| 10 | + |
| 11 | +The widgets split into two categories: |
| 12 | + |
| 13 | +Layer plotting |
| 14 | +~~~~~~~~~~~~~~ |
| 15 | +These widgets plot the data stored directly in napari layers. |
| 16 | +Currently available are widgets to plot: |
| 17 | + |
| 18 | +- 1D histograms |
| 19 | +- 2D scatter plots (switching to 2D histograms for a large number of points) |
| 20 | +- 1D slice line plots |
| 21 | + |
| 22 | +To use these: |
| 23 | + |
| 24 | +1. Open the desired widget using the ``Plugins > napari-matplotlib`` menu in napari. |
| 25 | +2. Select the required number of layers using the napari layers list in the bottom left-hand side of the window. |
| 26 | + |
| 27 | +Features plotting |
| 28 | +~~~~~~~~~~~~~~~~~ |
| 29 | +These widgets plot the data stored in the ``.features`` attribute of individual napari layers. |
| 30 | +Currently available are: |
| 31 | + |
| 32 | +- 2D scatter plots of two features against each other. |
| 33 | + |
| 34 | +To use these: |
| 35 | + |
| 36 | +1. Open the desired widget using the ``Plugins > napari-matplotlib`` menu in napari. |
| 37 | +2. Select a single layer that has a features table using the napari layers list in the bottom left-hand side of the window. |
| 38 | +3. Use the drop down menu(s) under the Matplotlib figure to select the feature(s) to plot. |