Difference between revisions of "Op Finder"

(Code Snippets)
Line 12: Line 12:
 
}}
 
}}
 
   
 
   
Utility for browsing, learning about and running all available Ops
+
The Op Finder is a utility for browsing, learning about and running all available {{GitHub|org=imagej|groupId=imagej-ops|label=Ops}}. Because Ops are plugins and can be dynamically extended and specialized for particular inputs, it is not practical to have static documentation on a given Op. By using the Op Finder, you explore the actual list of Ops available in ''your'' installation. The purpose of this guide is to familiarize you with the basic capabilities of the Op Finder, to enable you to learn and experiment with Ops.
+
 
 
= Getting started =
 
= Getting started =
  
shift + L
+
There are two ways to start up the Op Finder:
 +
 
 +
# Using the shortcut: {{Key|Shift||L}}
 +
# Using the menu path: {{Bc|Plugins|Utilities|Find Ops...}}
 +
 
 +
= Parts of the Op Finder =
 +
 
 +
[[File:LabeledOpFinder.png]]
 +
 
 +
'''Labeled components'''
 +
# Search bar for [[#Filtering|filtering]] the list of Ops.
 +
# Toggle button to change between a [[#For Users|user]] and [[#For Developers|developer]] view.
 +
# Play button for [[#Running Ops|running the selected Op]].
 +
# Copy button to copy the selected cell contents.
 +
# Help button to open up the Wiki reference page in your browser.
 +
# Status area showing success/failure notifications e.g., for copying or running Ops.
 +
# Namespaces and Op types: these can be expanded to explore the tree-based organization of Ops.
 +
# Op implementation: the leaves of this tree tell us what parameter options are available for each Op type. We interpret this particular example as "There is an Add Op in the Math namespace, that operates on an image and a numeric value".
 +
# Progress area showing progress when performing lengthy operations, such as filtering the Ops.
 +
# Details pane toggle. Click this button to show/hide a pane containing additional information about the currently selected Op.
 +
 
 +
'''Additional features'''
 +
* Hover your mouse over any part of the Op Finder to get a descriptive tool-tip.
 +
* Double-click any cell to copy its contents to your clipboard.
  
 
= Views =
 
= Views =
 
   
 
   
== User ==
+
== For Users ==
  
== Developer ==
+
== For Developers ==
  
 
= Things to do =
 
= Things to do =
 +
 +
== Filtering ==
 +
 +
fuzzy, no namespaces
 +
 
== Running Ops ==
 
== Running Ops ==
 
How does the play button work?
 
How does the play button work?

Revision as of 13:50, 2 May 2016

Op Finder (ImageJ)
Author Mark Hiner
Maintainer Mark Hiner, Ctrueden
File net.imagej:op-finder
Source on GitHub
Initial release April 2016
Latest version April 2016
Development status beta
Category Plugins


The Op Finder is a utility for browsing, learning about and running all available Ops. Because Ops are plugins and can be dynamically extended and specialized for particular inputs, it is not practical to have static documentation on a given Op. By using the Op Finder, you explore the actual list of Ops available in your installation. The purpose of this guide is to familiarize you with the basic capabilities of the Op Finder, to enable you to learn and experiment with Ops.

Getting started

There are two ways to start up the Op Finder:

  1. Using the shortcut: Shift+L
  2. Using the menu path: Plugins › Utilities › Find Ops...

Parts of the Op Finder

LabeledOpFinder.png

Labeled components

  1. Search bar for filtering the list of Ops.
  2. Toggle button to change between a user and developer view.
  3. Play button for running the selected Op.
  4. Copy button to copy the selected cell contents.
  5. Help button to open up the Wiki reference page in your browser.
  6. Status area showing success/failure notifications e.g., for copying or running Ops.
  7. Namespaces and Op types: these can be expanded to explore the tree-based organization of Ops.
  8. Op implementation: the leaves of this tree tell us what parameter options are available for each Op type. We interpret this particular example as "There is an Add Op in the Math namespace, that operates on an image and a numeric value".
  9. Progress area showing progress when performing lengthy operations, such as filtering the Ops.
  10. Details pane toggle. Click this button to show/hide a pane containing additional information about the currently selected Op.

Additional features

  • Hover your mouse over any part of the Op Finder to get a descriptive tool-tip.
  • Double-click any cell to copy its contents to your clipboard.

Views

For Users

For Developers

Things to do

Filtering

fuzzy, no namespaces

Running Ops

How does the play button work?

Copy and Paste

Code Snippets

TODO take a code snippet and turn it into a script