Plugins - mipav

Plugins
http://mipav.cit.nih.gov
1

MIPAV Team
Matthew McAuliffe
William Gandler
Ruida Cheng
Evan McCreedy
Justin Senseney
Contractors
Nish Pandya, SSAI
Alexandra Bokinsky, Geometric Tools Inc.
2

Justin Senseney
Medical Image Processing,
Analysis & Visualization
&
Plugins
SenseneyJ@mail.nih.gov
Biomedical Imaging Research Services Section (BIRSS)
Imaging Sciences Laboratory
Division of Computational Bioscience
Center for Information Technology
(301) 594-5887
http://mipav.cit.nih.gov
3

Mipav Interface
•
Options exist
• How to manipulate
4

Plugins
•
PlugInAlgorithm – Develop new functionality and ability
to call functions already in MIPAV.
•
PlugInFile – Develop files readers to support unique file
formats.
•
PlugInGeneric – Plugins that do not require an open
image.
•
PlugInView – Develop new visualizations of datasets.
•
PlugIn – ImageJ plugin.
6

Plugins
•
To build a plugin, three files are typically used:
–
PlugInTest.class
• Interface between MIPAV and plugin.
–
PlugInDialogTest.class
• Creates dialog for input.
–
PlugInAlgorithmTest.class
• The actual algorithm.
7

Plugins - Location
•
Stored for each user:
–
Windows - C:\Users\{{user_name}}\mipav\plugins
–
Linux/Mac OS - /home/{{user_name}}/mipav/plugins
8

Plugins - Installing
9

Plugins – Installing
•
Installing a plugin (Plugins -> Install Plugin)
Copies files:
•
.class
•
.jar
•
.zip
into user directory.
HINT:
If something goes wrong, just copy the files yourself using locations on Slide 8.
10

Plugins – Installing (2)
11

Plugins - Executing
12

Plugins - Scripting
Execute plugin
13

Script Running Review
14

Uninstall Plugin
15

Plugin Lab
•
Install
• PlugInCT_MD – already in MIPAV
• MuscleSegmentation –
http://dcb.cit.nih.gov/~senseneyj/code/muscleSeg.html
• Bio-Formats - http://dcb.cit.nih.gov/~
senseneyj/code/bioformats.html
• ImageJ –
http://dcb.cit.nih.gov/~senseneyj/code/imagej.html
16

Plugins from
command line
• Mipav –p Plugin_Name
• Can be run headless
17

Break - Review
• Plugins
•
File
•
Generic
•
Algorithm
•
View
• Stored in user folder
• Install, Run, Uninstall
18

Development environment
•
Textpad: http://www.textpad.com/
•
Simple, few linked files
•
Want to learn Java
•
Eclipse: http://www.eclipse.org/
•
Many files, libraries
•
Source repository
•
Want to use Java
19

Download Eclipse
•
Download here:
http://www.eclipse.org/downloads/
20

“Install” Eclipse
21

Fix Eclipse
ecify Memory
22

Start Eclipse
23

Java Programs
•
Virtual machine = platform independent
•
JRE to execute
24

JRE Setting
25

Add JRE
26

Locate JRE
27

Locate JRE
28

Eclipse project
•
Mipav
•
Java project
•
Contains plugins
29

Make Mipav Project
30

Make Mipav Project
Specify JRE
31

Mipav Program
•
Execution environment needs to be replicated
32

Execution environment
•
Classpath
•
Libraries - jars
•
Associated class files
•
Memory – used by VM
•
Launching class file
33

•
Libraries
•
PDFbox
•
JPEG2000
•
ImageJ
•
Help files
•
Insight Toolkit wrappers
Jars
34

Add Jars
35

More Jars
36

More Jars: Help
37

More Jars: ITK
38

•
Object-oriented
•
Executable programs
•
In Mipav:
•
Read/write images
•
Apply filters
•
Run plugins!
Class files
39

External class folder
Select the
correct version
of Mipav
40

Click Finish!
Note class folder
and JRE
selection
41

MipavMain
42

Run Configuration
43

New Configuration
44

Select Main Type
45

-Xms (min), -Xmx (max)
Java Memory
46

Memory
47

Run Mipav
•
MipavMain is executed
•
Classpath is set
•
Memory allocated
•
Libraries are referenced
48

Mipav Launched
Version number
VM Memory
49

View JVM Info
50

JVM Info
JRE in mipav
Plugin folder in
workspace
51

Java Compiler
•
Source code:
•
*.java files
•
Text-editor readable
•
Platform independent byte-code:
•
*.class files
52

Get NewGeneric2
•
Download three files from
http://dcb.cit.nih.gov/~senseneyj/code/plugin.html
•
PlugInNewGeneric2.java
•
PlugInDialogNewGeneric2.java
•
PlugInAlgorithmNewGeneric2.java
53

Import NewGeneric2
•
In Eclipse: Press File->Import
54

Compile NewGeneric2
•
This is done for you, incrementally in Eclipse
•
Errors and warnings update with each change
55

Install NewGeneric2
•
Only install PlugInNewGeneric2.class
Why did this work?
56

Run NewGeneric2
•
Open an image, try it out
57

Look at NewGeneric2
•
Open Dialog, try to change the title “Generic Plugin”
58

Change NewGeneric2
•
Location:
59

Run NewGeneric2
•
See change:
60

NewGeneric Algorithm
•
Look at algorithm construction, extecution
61

MIPAV Documentation
•
CTRL-click on run algorithm, now try hovering:
62

Plugins - MIPAV API
Download from:
http://mipav.cit.nih.gov/documentation/api.zip
63

Plugins - MIPAV API
Attach here:
64

Plugins - MIPAV API
View here:
65

Modify Plugin Lab
10pt
•
Edit PlugInNewGeneric2:
•
Change text in plugin dialog.
10pt
•
Print out when algorithm has completed.
10pt
20pt
80pt
•
Increase kernel size.
•
Change 3D to 2.5D processing.
•
Add check box to allow user to select either 3D or
2.5D processing.
66

Plugins - Documentation
•
Plugin development documentation
http://mipav.cit.nih.gov/documentation/userguide/volume1/MIPAV_PlugIns.pdf
•
This presentation is posted at:
• http://dcb.cit.nih.gov/~senseneyj/code/plugin.html
•
Will also be posted here:
• http://mipav.cit.nih.gov/documentation/presentations/
•
Also see this wiki page:
• http://mipav.cit.nih.gov/pubwiki/index.php/Writing_MIPAV_plugins_without_MIPAV_sour
67

Summary
•
Plugins
–
Unique functionality using MIPAV API
•
Develop in Eclipse
•
Use MIPAV API
68

Visualization
Processing
Quantification File reader
Macros
File writer
69

http://mipav.cit.nih.gov
70