MacroFunction

Object
- Enum<MacroFunction>
- - acquifer.ij.MacroFunction

All Implemented Interfaces:

Serializable, Comparable<MacroFunction>
```
public enum MacroFunction
extends Enum<MacroFunction>
```
The object MacroFunction is used to describe a custom macro function, with its name, parameter names and parameters types.
This class contains the macro-functions for the IM03 and IM04 macro-extensions.
They can be called in the script editor by first loading the macro-extension ex: run("IM03 macro-extension") then calling Ext.nameOfTheMacroFunction.
To add new function simply add a new Enum member to the list of functions.
The enum also defines the code-completion to show in the script editor.
The difference between the 2 IM models is the version of the FilenameFilter passed to the method process(FilenameFilter, Object[]).
This is done internally in the descendant class of the BaseMAcroExtension class.

For metadata parsing, the 3rd argument is always ARG_STRING corresponding to the image name.
For functions returning a single string, no need to precise an output arg, the function returns it directly as a usual function. out = myFunction()

Output arguments
In the macro language, output arguments can be passed-in and will be populated by the macro-function, ie the value is returned in the passed-in variable As explained in the doc - output number are passed to the java method as a single element Double array - output string (if not using the simpler return mechanism above) are passed as single element String[]

Enum Constant Summary

Enum Constants
Enum Constant and Description
`IM_closeConnection`
`IM_getChannelIndex`
`IM_getLightExposure`
`IM_getLightPower`
`IM_getLoopIteration`
`IM_getPixelSize`
`IM_getPositionXY`
`IM_getPositionZ`
`IM_getSoftwareMode`
`IM_getTemperature`
`IM_getTimepoint`
`IM_getWellColumn`
`IM_getWellId`
`IM_getWellIdLowerCase`
`IM_getWellIndex`
`IM_getWellRow`
`IM_getWellRowLowerCase`
`IM_getWellSubPosition`
`IM_getZSlice`
`IM_openConnection`
`IM_runScript`
`IM_showMultiHyperStacksFromDirectory`
`IM_showSingleHyperStackFromDirectory`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`org.fife.ui.autocomplete.BasicCompletion`	`getCodeCompletion(org.fife.ui.autocomplete.CompletionProvider completionProvider)` Return the object necessary to have custom code completion.
`ij.macro.ExtensionDescriptor`	`getExtensionDescriptor(ij.macro.MacroExtension handler)` Return ExtensionDescriptor, the object needed to add custom macro-functions.
`static boolean`	`isConnected()` Check whether a connection to the IM was established with openConnection.
`static int[]`	`objectToIntArray(Object[] inArray)` Convert an Object[] actually containing Double to an int[].
`abstract String`	`process(acquifer.core.im.FilenameFilter filenameFilter, Object[] args)` This is the function called when the macro-function is actually called (ie MacroExtension.handleExtension(functionName), it is implemented for each enum/macro-function.
`static MacroFunction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MacroFunction[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - IM_getWellId
```
public static final MacroFunction IM_getWellId
```
  - IM_getWellIdLowerCase
```
public static final MacroFunction IM_getWellIdLowerCase
```
  - IM_getWellRow
```
public static final MacroFunction IM_getWellRow
```
  - IM_getWellRowLowerCase
```
public static final MacroFunction IM_getWellRowLowerCase
```
  - IM_getWellColumn
```
public static final MacroFunction IM_getWellColumn
```
  - IM_getWellSubPosition
```
public static final MacroFunction IM_getWellSubPosition
```
  - IM_getWellIndex
```
public static final MacroFunction IM_getWellIndex
```
  - IM_getPositionXY
```
public static final MacroFunction IM_getPositionXY
```
  - IM_getPositionZ
```
public static final MacroFunction IM_getPositionZ
```
  - IM_getZSlice
```
public static final MacroFunction IM_getZSlice
```
  - IM_getLightPower
```
public static final MacroFunction IM_getLightPower
```
  - IM_getLightExposure
```
public static final MacroFunction IM_getLightExposure
```
  - IM_getChannelIndex
```
public static final MacroFunction IM_getChannelIndex
```
  - IM_getPixelSize
```
public static final MacroFunction IM_getPixelSize
```
  - IM_getTimepoint
```
public static final MacroFunction IM_getTimepoint
```
  - IM_getLoopIteration
```
public static final MacroFunction IM_getLoopIteration
```
  - IM_getTemperature
```
public static final MacroFunction IM_getTemperature
```
  - IM_showMultiHyperStacksFromDirectory
```
public static final MacroFunction IM_showMultiHyperStacksFromDirectory
```
  - IM_showSingleHyperStackFromDirectory
```
public static final MacroFunction IM_showSingleHyperStackFromDirectory
```
  - IM_openConnection
```
public static final MacroFunction IM_openConnection
```
  - IM_closeConnection
```
public static final MacroFunction IM_closeConnection
```
  - IM_getSoftwareMode
```
public static final MacroFunction IM_getSoftwareMode
```
  - IM_runScript
```
public static final MacroFunction IM_runScript
```
- Method Detail
  - values
```
public static MacroFunction[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MacroFunction c : MacroFunction.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MacroFunction valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - objectToIntArray
```
public static int[] objectToIntArray(Object[] inArray)
```
    Convert an Object[] actually containing Double to an int[].
  - isConnected
```
public static boolean isConnected()
```
    Check whether a connection to the IM was established with openConnection.
    If false, show an error message.
  - process
```
public abstract String process(acquifer.core.im.FilenameFilter filenameFilter,
                               Object[] args)
```
    This is the function called when the macro-function is actually called (ie MacroExtension.handleExtension(functionName), it is implemented for each enum/macro-function.
    The MacroExtension mechanism imposes a number of constraints.
    For instance, input/output numbers are passed as Double (use casting).
    
    Parameters:
    
    args - this array contains the input(s) variables which can be of type String, double or array. The actual types is recovered by casting.
    This array will also contains output variables if needed (just populate the array in place).
    String output are directly returned, for other types, directly populate the array args and return null.
  - getExtensionDescriptor
```
public ij.macro.ExtensionDescriptor getExtensionDescriptor(ij.macro.MacroExtension handler)
```
    Return ExtensionDescriptor, the object needed to add custom macro-functions.
    This method should be called by the class implementing the custom macro-functions.
  - getCodeCompletion
```
public org.fife.ui.autocomplete.BasicCompletion getCodeCompletion(org.fife.ui.autocomplete.CompletionProvider completionProvider)
```
    Return the object necessary to have custom code completion.
    This method is called from the class responsible for code-completion.

Enum MacroFunction

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

IM_getWellId

IM_getWellIdLowerCase

IM_getWellRow

IM_getWellRowLowerCase

IM_getWellColumn

IM_getWellSubPosition

IM_getWellIndex

IM_getPositionXY

IM_getPositionZ

IM_getZSlice

IM_getLightPower

IM_getLightExposure

IM_getChannelIndex

IM_getPixelSize

IM_getTimepoint

IM_getLoopIteration

IM_getTemperature

IM_showMultiHyperStacksFromDirectory

IM_showSingleHyperStackFromDirectory

IM_openConnection

IM_closeConnection

IM_getSoftwareMode

IM_runScript

Method Detail

values

valueOf

objectToIntArray

isConnected

process

getExtensionDescriptor

getCodeCompletion