acquifer.ij

Class BaseMacroExtensions

Object

acquifer.ij.BaseMacroExtensions

All Implemented Interfaces:

ij.macro.MacroExtension, Runnable, org.scijava.command.Command, org.scijava.plugin.SciJavaPlugin

Direct Known Subclasses:

MacroExtensions, MacroExtensions

public class BaseMacroExtensions
extends Object
implements org.scijava.command.Command, ij.macro.MacroExtension

Implements ImageJ macro functions mapping to acquifer java functions, thanks to the MacroExtension mechanism.

The functions are available in the macro language by doing
run("Acquifer IM04 macro extensions"); for IM04 datasets
run("Acquifer IM03 macro extensions"); for IM03 datasets

which defines the variable Ext, which allows then
Ext.getLightPower(imageName, lightPower)

There can only be only one macro extension loaded at a time, therefore this class contains all interesting acquifer functions (metadata and tcpip for instance).
In the functions below, number are returned as double arrays anyway, therefore some extra effort to populate the first item of the array everytime.
Documentation: MacroExtensions.txt
Example: Java example

Field Summary

Fields inherited from interface ij.macro.MacroExtension

ARG_ARRAY, ARG_NUMBER, ARG_OPTIONAL, ARG_OUTPUT, ARG_STRING

Constructor Summary

Constructors

Constructor and Description
BaseMacroExtensions(acquifer.core.im.FilenameFilter filenameFilter) Descendant classes should call a custom constructor with the FilenameFilter class adapted to the IM model.

Method Summary

Modifier and Type	Method and Description
ij.macro.ExtensionDescriptor[]	getExtensionFunctions() Return the list of ExtensionDescriptor to make available custom macro-commands.
String	handleExtension(String functionName, Object[] args) Handle call to the macro-functions.
void	run()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseMacroExtensions

public BaseMacroExtensions(acquifer.core.im.FilenameFilter filenameFilter)

Descendant classes should call a custom constructor with the FilenameFilter class adapted to the IM model.

Method Detail

run

public void run()

Specified by:

run in interface Runnable

getExtensionFunctions

public ij.macro.ExtensionDescriptor[] getExtensionFunctions()

Return the list of ExtensionDescriptor to make available custom macro-commands.
Needed to have a functional macro-extension.

Specified by:

getExtensionFunctions in interface ij.macro.MacroExtension

handleExtension

public String handleExtension(String functionName,
                              Object[] args)

Handle call to the macro-functions.
It simply forwards to the right process function of the corresponding MacroFunction.

Specified by:

handleExtension in interface ij.macro.MacroExtension

Parameters:

functionName - as declared in ExtensionDescriptor

args - the arguments provided by the macro function, which can be output arguments too. These output arguments are actually passed as single-element array (ex: single Double[])