Skip to content
Blog post: How to develop ImageJ Java plugins and Jythons scripts simultaneously from your IDE
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images
src/main
.gitignore
README.md
_config.yml
pom.xml
run_jython_scripts_from_ide.iml

README.md

How to develop, deploy and run ImageJ/Fiji scripts and Java plugins within your IDE simultaneously

Did you ever work on a Jython script for ImageJ and in parallel on a Java based ImageJ Plugin? This is a bit annoying, right? After every change in the Java code, you need to deploy the jar file to your ImageJ/Fiji installation. Afterwards, you need to restart ImageJ, load the script, run it. Then you realise, that you just forgot to remove these 10 billion debug traces and the procedure starts from the beginning.

With ImageJ2, there is a way to edit Jython scripts and Java code in parallel within your IDE and run it together with a single click!

I guess the following will work with any IDE such as Eclipse or Intellij. I tested with Intellij 2017.01 with Python support installed.

The project we are talking about looks like this:

Image

Eclipse

For Python support in Eclipse install PyDev from the Eclipse Marketplace.

MyPlugin.java

This is a very minimal ImageJ2 plugin I'm using just to demonstrate that the plugin is executed and runs on the right image:

@Plugin(type = Command.class, menuPath = "Plugins>MyPlugin")
public class MyPlugin implements Command {
    @Parameter
    ImagePlus input;

    @Parameter
    ImageJ ij;

    @Override
    public void run() {
        ij.log().info("MyPlugin executed.");
        ij.log().info("Image: " + input.getTitle());
    }
}

MyModule.java

Furthermore, a minimal Java Class should allow us later to show the capabilities of the IDEs auto completion functionality:

public class MyModule {
    public void myMethod() {
        System.out.println("myMethod executed.");
    }
}

imagej_script.py

This is the actual ImageJ jython script. The first part executes myMethod of MyModule. The second part executes MyPlugin in ImageJ1 style.

# @ImagePlus input
# @ImageJ ij
from de.mpicbg.scf.scripting import MyModule

# work with classes and methods from java directory
MyModule().myMethod()

# execute a plugin
from ij import IJ;
input.show()
IJ.run(input, "MyPlugin", "")

When writing this script, I already saw that my IDE allows auto completion:

Image

AUTO COMPLETION! Isn't that already awesome?

Main.java

How do we run the Jython script from within the IDE? And how can we ensure that my classes like MyModule are compiled and available during runtime? The SciJava ScriptService is the answer. The whole main function which runs ImageJ, creates a test image and calls the script looks like this:

public class Main {
    public static void main(String... args) throws FileNotFoundException, ScriptException {
        // start ImageJ
        ImageJ ij = new ImageJ();
        ij.ui().showUI();

        // get some image to process
        Img<ShortType> testImage = ArrayImgs.shorts(new long[]{100, 100});
        ImagePlus imp = ImageJFunctions.wrap(testImage, "TestImage");

        // run the script, hand over image and imagej instances
        ij.script().run(new File("src/main/jython/imagej_script.py"), false, new Object[]{"input", imp, "ij", ij});

    }
}

The output together with the opening windows look like that:

Image

myMethod is executed, just like MyPlugin and the plugin accesses the right image. And all that just by running the main function. I'm not yet fully aware of all the awesome things I can do now from within my IDE. Awesome!

Feel free to try the procedure with your IDE. Checkout the full code.

Feedback welcome: rhaase AT mpi-cbg.de

Happy coding!

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.