← back to the tutorial

Plugins: running, previewing, plotting

The words of this tutorial, step by step. The text lives in src/smappy/tutorial/topics/; the directions it follows are in src/smappy/tutorial/STYLE.md.

What a plugin is

1. card: Plugins: running, previewing, plotting

Every analysis in SMAPpy is a plugin: a form of settings and a Run button. They all work the same way, and this is that way.

A plugin measures the selection: what passes the current layer's filter, inside the ROI if one is drawn.

spoken: Every analysis in SMAPpy is a plugin, and they all work the same way. This tutorial shows that way.

Finding one

2. The Analysis tab lists its plugins as sections, by what they do: drift, measuring, processing.

3. Type in find to narrow the list.

4. Right-click a title to rename it, duplicate it with other settings, or remove it; + pins another plugin to the tab.

Settings

5. Opening a section shows its settings. Hold the mouse over a label to see what it does; more holds the rest.

Preview and live

6. Draw a line across the structure. The profile along it is the structure's cross-section, here fitted with a Gaussian.

7. Preview does the work and draws it, without changing anything.

8. The profile and its fit: the width of the line, with its uncertainty.

9. With live ticked, the figure follows the line while it is moved: a measurement you can aim.

10. Moved further along, the same line measured again, at once.

Run and Text

11. Run does the same and keeps the result: the numbers appear below, Text opens them in full, Plot draws the figures again.

Several at once

12. The arrow on a title opens the plugin in a window of its own, so several can stay open side by side.

13. The same plugin, with the same settings, now beside the picture. Close it to put it back in the tab.

What is kept

14. A plugin that changes the table, like a drift correction, can be undone, and is written into the file's history. History shows it.

Next

15. card: What to remember

- Find a plugin in its tab, with find, or in the Plugins menu.
- Preview shows the work without changing anything; live follows the ROI.
- Run keeps the result; Text and Plot show it again.
- What changes the table can be undone, and is kept in the history.

spoken: That is how every plugin works. Next: the measuring plugins, and how to read what they find.