Skip to content

Instantly share code, notes, and snippets.

@GenevieveBuckley
Created January 9, 2018 06:10
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save GenevieveBuckley/2685f2469b9d82c4a3779799a6a23912 to your computer and use it in GitHub Desktop.
Save GenevieveBuckley/2685f2469b9d82c4a3779799a6a23912 to your computer and use it in GitHub Desktop.
Summary of available ImageJ parameters. https://imagej.net/Script_Parameters
/*
IMAGEJ PARAMETER NOTATION
https://imagej.net/Script_Parameters
Parameter declarations begin with #@ or //@. Each such line contains a single parameter declaration and nothing else.
//@type variableName // will declare an input of the indicated type, assigned to the specified name.
//@output type outputName // will declare the variable of the specified name as an output parameter with the given type.
*/
/*
CREATE DATASETS OR IMAGEPLUS FROM CURRENTLY OPEN IMAGES
If there is more than open currently open image, a dialog box will appear
with a dropdown list so you can assign the correct image to the right variables.
For more information on Datasets see:
http://javadoc.scijava.org/ImageJ/net/imagej/Dataset.html
Note: Datasets wrap the ImgPlus object type, not the older ImagePlus type.
For more information on ImagePlus objects, see:
https://imagej.nih.gov/ij/developer/api/ij/ImagePlus.html
*/
// @Dataset inputData
// @Dataset inputMoreData
// @OUTPUT Dataset outputData
// @ImagePlus inputData
// @ImagePlus inputMoreData
// @OUTPUT ImagePlus outputData
/* USER INPUT - LAUNCHES FILE PICKER GUI */
// @File (label="Choose a file") inputFile
// @File (label="Choose a directory", style="directory") inputDirectory
// @File (label="Choose file to save as", style="save") saveFile
/* USER INPUT - LAUNCHES DATE PICKER DIALOG */
// @Date (label="Pick a date") dateVariable
/* USER INPUT - LAUNCHES COLOR PICKER GUI */
// @ColorRGB (label="Pick a color") colorPickerVariable
/*
USER INPUT - STRING/CHARACTER INPUT
Optional arguments:
label="Message to display to user"
description="Mouseover hover text appears here"
style="text" // available styles: "text", "field", "text area", or "password"
*/
// @char (label="Enter a character") charVariable
// @Character (label="Enter a character") characterVariable
// @String (label="Enter a string") stringVariable
/*
USER INPUT - BOOLEAN INPUT
Produces a checkbox widget for user input of boolean variables.
*/
// @boolean (label="Enter a boolean") booleanVariable
// @Boolean (label="Enter a boolean") booleanVariable
/*
USER INPUT - NUMERIC VARIABLES
Optional arguments in parenthesis:
label="Some message to display to the user"
value=defaultValue // default value should have the same numeric type as the parameter.
sytle="slider" // available styles for numeric inputs are "slider", "spinner", or "scroll bar".
Example:
//@Float (label="Enter a floating point number", value=2.3, style="scroll bar") floatVariable
*/
// @int (label="Enter integer type input") integerVariable
// @Integer (label="Enter integer type input") integerVariable
// @float (label="Enter float type input") floatVariable
// @Float (label="Enter float type input") floatVariable
// @long (label="Enter long type input") longVariable
// @Long (label="Enter long type input") longVariable
// @short (label="Enter short type input") shortVariable
// @Short (label="Enter short type input") shortVariable
// @byte (label="Enter byte type input") byteVariable
// @Byte (label="Enter byte type input") byteVariable
// @BigInteger (label="Enter BigInteger type input") bigIntegerVariable
// @BigDecimal (label="Enter BigDecimal type input") bigDecimalVariable
/*
IMAGEJ OPS
Where to find help with the ImageJ Ops:
https://imagej.net/ImageJ_Ops
https://nbviewer.jupyter.org/github/imagej/tutorials/blob/master/notebooks/1_-_Using_ImageJ/2_-_Introduction_to_ImageJ_Ops.ipynb
http://javadoc.scijava.org/ImageJ/net/imagej/ops/package-summary.html
https://github.com/imagej/imagej-ops
*/
// @OpService ops
/*
OTHER IMAGEJ SERVICES
*/
// @OpService ops
// @DatasetService ds
// @DisplayService display
// @DatasetIOService ds
// @UIService ui
// @PluginService plugin
// @LogService log
// @StatusService status
// @MenuService menu
// @PlatformService platform
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment