Writing MIPAV plugins without MIPAV source code

From MIPAV
Revision as of 18:49, 11 March 2010 by Senseneyj (Talk | contribs)

Jump to: navigation, search

You can use Eclipse to develop plugins for MIPAV without access to the MIPAV source code.

Requirements

First, you'll need to download the following software. Note that Java may already be installed on your system. Find out what version of Java you have here.

Installation

Installation should be completed in the following order.

Installing Java

Java installation simply requires following the prompts.

Installing Eclipse

Open the downloaded zip file. Unzip the entire contents to a convenient folder, such as C:\Program Files\

Installing MIPAV

Mipav installation is also quickly completed by following the prompts. Note where you installed MIPAV, by default this is in the folder C:\Program Files\mipav

Building the Eclipse project

Steps for building MIPAV.
Step Text Picture
1 Start Eclipse. A dialog will ask you where the default workspace is located. Note the location it specifies and then click OK. With Eclipse started, click File, then New, then Java Project.
New Project.jpg
2 Name your project mipav-plugin. Ensure that the button next to "Create seperate folders for source and class files" is checked. Click the Next button.

On the Source tab, change the Default output folder tab to "mipav-plugin/classes"

Java Settings.jpg
3 On the libraries tab, click "Add External Class Folder" where you'll want to navigate to where you installed MIPAV. Select the corresponding folder.
External class folder.jpg
4 Also on the libraries tab, click Add External JARs and then add all the files from the following directories:
  • mipav/lib/*
  • mipav/lib/jaxp/*
  • mipav/help/mipav_help.jar
  • mipav/InsightToolkit/lib/InsightToolkit/InsightToolkit.jar


AllLibraries.jpg
External JARS.jpg

Click Finish when complete. A new project called mipav-plugin should appear. You're now ready to run MIPAV.

Running MIPAV with a sample plugin within Eclipse

Running MIPAV.
Step Text Picture
1 To make sure you've set everything up correctly, we'll try to run MIPAV inside of Eclipse. Navigate to Run, then Run Configurations... on the control panel. On the dialog box that opens, highlight Java Application, and then click the New Launch Configuration on the left. Fill out the Name and Project fields with the phrase "mipav-plugin" To fill in the Main Class, click the Search... button. Search for the name "MipavMain" If found, great! Otherwise go to troubleshooting.
MipavMain.jpg
2 Click on the arguments tab. In the VM arguments box, put the following phrase "-Xms800M -Xmx800" This specifies how many megabytes Java has available to run MIPAV. If your computer has more or less, feel free to adjust the numbers accordingly.
VmArg.jpg
3 When finished, click Run. If MIPAV starts, you're ready to start developing plugins. If not, go to troubleshooting.
Splash.png

Importing the plugin

For now download these three files to a convenient location:

Import these files into Eclipse using the dialog from File->Import.

Import.jpg
Import2.jpg

Installing the plugin

Table of nVidia cards verified to work with MIPAV's volume rendering tools.
Step Text Picture
1 Start MIPAV using the method shown in Running MIPAV within Eclipse. If that's already set up, press the green play button as shown. Once MIPAV starts, navigate to Plugins->Install Plugin. Once you press the Browse button, find the folder where the mipav-plugin project resides. This should be inside of the default workspace folder you noted earlier. Once found, go to click on the mipav-plugin/classes folder. You should see the following classes:
  • PlugInDialogNewGeneric2.class
  • PlugInAlgorithmNewGeneric2.class
  • PlugInNewGeneric2.class
OpenPlugin.jpg
2 Select PlugInNewGeneric2.class and then press Open, and then OK. Now open an image using MIPAV. You can now click on Plugs->Algorithms->PlugInNewGeneric2.
PluginOpen.jpg
3 This plugin opens a blank dialog box with working OK and Cancel buttons.
PluginDialog.jpg