ITK Plugins

What it is
----------

This project aims to provide plugins wrapping functionality in ITK for
popular applications such as Slicer and ParaView.

How it works
------------

ITK filters are described in a compact JSON file. Source code for
plugins is generated automatically with utility programs in this
project. The approach was inspired from the SimpleITK project
(www.simpleitk.org).

Who's responsible for this?
---------------------------

Cory Quammen
cquammen@cs.unc.edu
Department of Computer Science
UNC Chapel Hill

Funding provided by:

ARRA - Adding Deconvolution Algorithms to ITK
Award No: A10-1515-002
Sponsor Award No: HHSN276201000581P
Awarding Agency: National Library of Medicine

Acknowledgements
----------------

The ITK Plugins project uses the JSON description files in the
SimpleITK project.

Build Instructions
------------------

ITKPlugins can be configured to build plugins for either Slicer4 or
ParaView. Currently, only one or the other can be built in the same
build directory, not both.

Mac OS X - ParaView3 plugins
--------------------------

1. Clone, configure, and build ParaView (3.98.1 or higher is required)

 git clone --recursive git://paraview.org/ParaView.git
 mkdir ParaView-build
 cd ParaView-build
 cmake ../ParaView
 make
 cd ..

2. Clone SimpleITK (0.6.1 or higher is required)

 git clone git://itk.org/SimpleITK.git

3. Clone, configure, and build ITK (4.3.1 or higher is required)

 git clone git://itk.org/ITK.git
 mkdir ITK-build
 cd ITK-build
 cmake ../ITK -DBUILD_EXAMPLES:BOOL=OFF -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=OFF -DModule_ITKVtkGlue:BOOL=ON -DVTK_DIR:PATH=../ParaView-build/VTK
 make
 cd ..

4. Clone, configure, and build ITKPlugins

 git clone git://github.com/cquammen/ITKPlugins.git
 mkdir ITKPlugins-build
 cd ITKPlugins-build
 cmake ../ITKPlugins -DBUILD_PARAVIEW3_PLUGINS:BOOL=ON -DSimpleITK_SOURCE_DIR:PATH=../SimpleITK -DParaView_DIR:PATH=../ParaView-build
 make
 cd ..

Mac OS X - Slicer4 plugins
--------------------------

1. Clone, configure, and build Slicer 4

 git clone git://github.com/Slicer/Slicer.git
 cd Slicer
 git svn init http://svn.slicer.org/Slicer4/trunk
 git update-ref refs/remotes/git-svn refs/remotes/origin/master
 git checkout master
 git svn rebase

 cd ..
 mkdir Slicer4-SuperBuild
 cd Slicer4-SuperBuild
 cmake -DQT_QMAKE_EXECUTABLE:FILEPATH=/path/to/QtSDK-1.2/Desktop/Qt/474/gcc/bin/qmake ../Slicer4
 make
 cd ..

2. Clone SimpleITK (0.6.1 or higher is required)

 git clone git://itk.org/SimpleITK.git

3. Clone, configure, and build ITKPlugins

 git clone git://github.com/cquammen/ITKPlugins.git
 mkdir ITKPlugins-build
 cd ITKPlugins-build
 cmake ../ITKPlugins -DBUILD_PARAVIEW3_PLUGINS:BOOL=ON -DSimpleITK_SOURCE_DIR:PATH=../SimpleITK -DParaView_DIR:PATH=../ParaView-build
 make
 cd ..


Windows - ParaView3 plugins
---------------------------

You must use Visual Studio 2008 or higher.

1. Install an implementation of stdint.h in

C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\include

You can download one from http://msinttypes.googlecode.com/svn/trunk/stdint.h

2. Be sure to install Microsoft Visual Studio 2008 Service Pack 1 if it has not been installed already.
You can do so here: http://www.microsoft.com/en-us/download/details.aspx?id=23691

3. Clone, configure, and build ParaView

 git clone --recursive git://paraview.org/ParaView.git

Configure with CMake. Make sure BUILD_SHARED=ON.

4. Clone SimpleITK

 git clone git://itk.org/SimpleITK.git

5. Clone, configure, and build ITK with the following CMake configuration settings:

 BUILD_EXAMPLES=OFF
 BUILD_SHARED_LIBS=OFF
 BUILD_TESTING=OFF
 Module_ITKVtkGlue=ON
 VTK_DIR=<path to VTK directory in the ParaView build directory created in step 3>

6. Clone, configure, and build ITKPlugins with the following CMake configuration settings:

 git clone git://github.com/cquammen/ITKPlugins.git

  BUILD_PARAVIEW3_PLUGINS=ON
  SimpleITK_SOURCE_DIR=<path to SimpleITK *source* directory>
  ParaView_DIR=<path to ParaView *build* directory>

Note that the SimpleITK_SOURCE_DIR should point to the SimpleITK source directory and the
ParaView_DIR should point to the ParaView build directory.

Windows - Slicer4 plugins
-------------------------

TODO