diff --git a/docs/guide/index.rst b/docs/guide/index.rst index 1dea6cd2..968ea0ec 100644 --- a/docs/guide/index.rst +++ b/docs/guide/index.rst @@ -4,4 +4,5 @@ Guide .. toctree:: :maxdepth: 1 + user_guide third_party diff --git a/docs/guide/user_guide.rst b/docs/guide/user_guide.rst new file mode 100644 index 00000000..15b44f44 --- /dev/null +++ b/docs/guide/user_guide.rst @@ -0,0 +1,38 @@ +User guide +========== + +Overview +-------- +``napari-matplotlib`` contains a number of different ``napari`` Widgets. Each +widget is designed to map one or more ``napari`` Layers on to a ``matplotlib`` plot. +As an example, the `~.HistogramWidget` is used to +map one or more Image layers on to a 1D histogram plot. + +The widgets split into two categories: + +Layer plotting +~~~~~~~~~~~~~~ +These widgets plot the data stored directly in napari layers. +Currently available are widgets to plot: + +- 1D histograms +- 2D scatter plots (switching to 2D histograms for a large number of points) +- 1D slice line plots + +To use these: + +1. Open the desired widget using the ``Plugins > napari-matplotlib`` menu in napari. +2. Select the required number of layers using the napari layers list in the bottom left-hand side of the window. + +Features plotting +~~~~~~~~~~~~~~~~~ +These widgets plot the data stored in the ``.features`` attribute of individual napari layers. +Currently available are: + +- 2D scatter plots of two features against each other. + +To use these: + +1. Open the desired widget using the ``Plugins > napari-matplotlib`` menu in napari. +2. Select a single layer that has a features table using the napari layers list in the bottom left-hand side of the window. +3. Use the drop down menu(s) under the Matplotlib figure to select the feature(s) to plot. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy