Difference between revisions of "Scripting"

(Running scripts in headless mode: Fix case)
(Add a "getting started" section)
Line 1: Line 1:
 +
ImageJ allows you to write scripts in several different languages.
 +
 +
= Getting started =
 +
 +
* Press `[` to open the [[Script Editor]].
 +
* Optionally, choose a template from the ''Templates'' menu to get you started.
 +
* Otherwise, choose your language from the ''Language'' menu.
 +
* Grab code snippets for common tasks from the [[Scripting toolbox]].
 +
* See [[Scripting comparisons]] for a side-by-side comparison of scripting languages.
 +
* See [[Category:Scripting]] for a list of all scripting-related pages on this wiki.
 +
 
= Using an interpreter =
 
= Using an interpreter =
  

Revision as of 10:03, 24 April 2014

ImageJ allows you to write scripts in several different languages.

Getting started

  • Press `[` to open the Script Editor.
  • Optionally, choose a template from the Templates menu to get you started.
  • Otherwise, choose your language from the Language menu.
  • Grab code snippets for common tasks from the Scripting toolbox.
  • See Scripting comparisons for a side-by-side comparison of scripting languages.
  • See for a list of all scripting-related pages on this wiki.

Using an interpreter

All scripting languages use the same basic interpreter, with the following common features.

General key bindings

  • up arrow: bring the previously typed command.
  • down arrow: bring the next typed command.
  • enter or return: execute the contents of the prompt.

Multiline editing and keybidings

You can enlarge the prompt by dragging the middle bar.

  • shift + enter: create a new line within the prompt.
  • shift + up arrow: move to the line above within the prompt.
  • shift + down arrow: id, down.

Selecting and executing text from the screen

On selecting text, a popup offers to:

  • copy
  • execute
  • save to a new file

Using the script editor

You can create, edit and run scripts using Fiji's script editor. For details, please see the Script Editor documentation.

Creating scripts and using "refresh scripts"

On startup, ImageJ will run all "refresh scripts" plugins, one for each supported language. This will result in all scripts present within the plugins folders to be added to the menus.

To run a script, just select it from the plugins menus.

If you edit a script that is already placed in the menus, you don't need to do anything else: just save the text file and run it again by selecting it from the menus.

If you add a new script and ImageJ is running, just go to Plugins - Scripting and run the appropriate Refresh * Scripts for the language.

For the script to appear in the Plugin menus, it needs to terminate in the appropriate file extension. For example, ".js" for javascript, ".py" for jython, ".rb" for jruby, ".clj" for clojure, and ".bs" for beanshell script. The script must also contain a '_' (underscore) in the name. The extension will be stripped and any underscores will be turned into spaces before the script is added to the menus.

Running scripts in headless mode

See the Headless page for instructions on executing scripts headlessly.