Installation: Difference between revisions

From MiToBo
Jump to navigationJump to search
No edit summary
 
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== General remarks ==
There are two common ways to work with MiToBo:
There are two common ways to work with MiToBo:
<ul>
<ul>
<li> just using the operators included in MiToBo for improving your work and easing image processing tasks
<li> just using the operators included in MiToBo for improving your work and easing image processing tasks, e.g., via ImageJ or Fiji
<li> using the MiToBo API to write operators, plugins and other image analysis applications on your own
<li> using the MiToBo API to write operators, plugins and other image analysis applications on your own
</ul>
</ul>
Irrespective of which way you intend to go the first thing to is always to download the binary zip file containing the current release of MiToBo.<br> The actual installation instructions differ in some parts depending on which way you choose.<br> Below we will first provide some notes regarding the binary zipfile, and then outline more details about the installation steps required
The functionality of MiToBo is best used from within ImageJ or Fiji. In case that you aim to use MiToBo for your own development, you need to download the binaries explicitly. The actual installation instructions differ in some parts depending on which way of using MiToBo you have in mind.<br> Below we will first outline more details about the installation steps required for simply using MiToBo's operators in ImageJ and Fiji, and then provide some notes regarding the binary zip file. Finally we will present some details for using MiToBo's API with your own code.
for simply using MiToBo's operators. Finally we will present some details for using MiToBo's API.


== The [[downloads|MiToBo Binaries zip]] ==
<br>
== Using MiToBo with Fiji ==
Since release 1.5 MiToBo features a Fiji update site and the easiest way to use MiToBo's operators and plugins is to enable the update site in your Fiji installation. <br> The MiToBo update site is<br>


Download and extract the [[downloads|MiToBo Binaries zip]]. You will find the following structure of directories:
[http://sites.imagej.net/MiToBo http://sites.imagej.net/MiToBo]
* docs - includes the MiToBo manual
* lib - includes nesessary libaries for Linux and Windows
* licences - includes MiToBo license and licences for other software used by MiToBo
* macros - includes the MiToBo macro toolset
* native - sources and Makefiles to build MiToBo's native libraries
* plugins - includes MiToBo jar and other jars used by MiToBo
* ''oprunner.sh'' - shell script to run MiToBo operators from commandline (Linux only)
* ''run.sh'' - shell script to run ImageJ with MiToBo (Linux only)


== Linux ==
To enable the site in your Fiji installation refer to the [http://fiji.sc/How_to_follow_a_3rd_party_update_site Fiji documentation].


=== Use MiToBo as shipped ===
'''Important notices:'''<br>
<ul>
<li> Occasionally MiToBo '''operators crash when run from within Fiji'''. The reason for this behaviour are most of the time '''conflicting jar archives''' delivered with the Fiji distribution.<br> We figured out that particularly the jar file


You can use MiToBo right away using the ''run.sh'' and ''oprunner.sh'' scripts.
* jars/bio-formats/formats-common-5.1.x.jar
If an '''UnsatisfiedLinkError''' occurs, please read the '''Native libraries''' section below.


=== Use MiToBo with an existing ImageJ installation ===
often causes such trouble. Thus, if you encounter problems running MiToBo operators, please try to locally delete or uninstall the abovementioned jar archive from your local Fiji installation and then re-run the MiToBo operator.
<li> For some of our operators special issues exist and require special treatment:
<ul>
<li> [[Applications/CellBoundaryExtractor2D| CellBoundaryExtractor2D]]: there are version conflicts with regard to the '''JGraphT library''' used by this operator and also by default included in every Fiji distribution; please refer to installation instructions on the [[Applications/CellBoundaryExtractor2D|webpage of the operator]] for a workaround
</ul>
</ul>


To use MiToBo with an existing ImageJ installation perform the following steps:
<br>


# copy the ''Mi_To_Bo.jar'' in plugins/ of the MiToBo zip-file to your ImageJ/plugins/ directory
== Using MiToBo with ImageJ ==
# copy all jars in plugins/jars/ of the MiToBo zip-file to your ImageJ/plugins/jars/ <span style="text-decoration: underline;">except</span> the ij.jar and jars already existing in your ImageJ/plugins/jars/ directory<br/>('''Notice:''' MiToBo requires explicite versions of some jars, other versions may not work probably, see [[downloads|requirements]].)
# copy the ''MiToBo_Runner.txt'' from the macros/toolsets/ directory in the MiToBo zip-file to your ImageJ/macros/toolsets/ directory
# Make the native libraries in lib/ of the MiToBo zip-file available to java (see the '''Native libraries''' section below)


You can still use the ''run.sh'' and ''oprunner.sh'' scripts if you copy the to your ImageJ/ directory.
'''Important Note:''' These instructions refer to ImageJ 1 only, instructions for ImageJ 2.0 will follow soon.


Since release $0.9.6$ \mitobo supports the ImageJ toolbar, i.e.~offers a configuration file for fast
<br>
access of its plugins via a toolbar button. To add the \mitobo toolset to ImageJ, \mitobo is shipped
with a macro configuration file. It can be found in the zip archives and is called
{\tt MiToBo\_Tools.txt}. Simply copy the file into the folder {\tt macros/toolsets} of your ImageJ
installation and run ImageJ. Then you can select the \mitobo toolset from the list of available
sets by clicking on the arrows button on the right side of the ImageJ standard toolbar.
Selecting {\tt 'MiToBo\_Tools'} will add a button with the \mitobo logo to the toolbar allowing
for direct access to all \mitobo plugins (Fig.~\ref{fig:toolbar}).


=== Native libraries ===
=== Linux ===


Some operators of MiToBo use native code via the Java Native Interface (JNI).
Using MiToBo with a [[Installation/Linux|Linux operating system]].
The lib/ directory in the zip-file provides JNI-libraries for 32- (lib/lib32) and 64-Bit (lib/lib64) systems,
but for several reasons an '''UnsatisfiedLinkError''' might occur when you run MiToBo operators that depend on native code. UnsatisfiedLinkErrors are thrown if the native library required is not available or cannot be loaded for other reasons.
In the following solutions to the different reasons are described.


==== Troubleshooting ====
<br>
* '''Library paths not configured:'''
:The path to the native libraries must be available to any java application which uses MiToBo operators that depend on these libraries.
:The ''run.sh'' and ''oprunner.sh'' scripts both add the lib/lib32 or lib/lib64 directory depending on your architecture to the LD_LIBRARY_PATH, thus you do not have to configure the LD_LIBRARY_PATH manually.
:If you run ImageJ with MiToBo or the OpRunner in another way, the directories of native libraries can be passed to java in any of the following two ways:
:* The LD_LIBRARY_PATH environment variable must contain the path to the native libraries used
:* The java-call has to be augmented with an option to tell where native libraries reside:
  java -Djava.library.path=/path/to/libs1:/path/to/libs2[:...] ...
::  For example, you can run ImageJ with MiToBo on a 32-Bit system with the unzipped MiToBo structure, but not the ''run.sh'' script, with the following command (the /usr/lib is also provided here as it is assumed to contain the CGAL libraries - see next problem):
  java -Djava.library.path=lib/lib32:/usr/lib -cp plugins/jars/ij.jar ij.ImageJ
:Configuring the LD_LIBRARY_PATH and running java with the -Djava.library.path option are equivalent and thus only the LD_LIBRARY_PATH is referred in the following.


* '''CGAL libraries not installed:'''
=== Windows ===
: Any MiToBo operator using Snake Active Contours is based on a Snake datatype that is backed by the CGAL (Computational Geometry Algorithms Library) libraries [http://www.cgal.org/]. The library ''libJNI_Cgal_Polygon2D.so'' shipped with MiToBo defines the interface to these libraries and thus requires that the CGAL libraries are installed on your system.
:Make sure that the path to the CGAL libraries is specified in your LD_LIBRARY_PATH.


* '''Building of MiToBo's native libraries:'''
Using MiToBo with a [[Installation/Windows|Windows operating system]].
: You might have installed a different version of libraries compiled with a different compiler than the libraries used to build the libraries shipped with MiToBo. Therefore MiToBo's native libraries might not work and an '''UnsatisfiedLinkError''' is thrown. Then you have to compile MiToBo's native libraries yourself:
:# Go to the native/ directory in MiToBo's directory structure
:# Edit ''Makefile.rules'' if necessary (defaults are predefined):
::* The path to your java installation which includes the JNI-header files
::* The path to the CGAL libraries
::* The path to the CGAL headers
:# Run ''make install'', which will build MiToBo's native libraries for your architecture and move them into the lib/lib32 or lib/lib64 directory. This will overwrite the libraries in lib/lib32 and lib/


== Windows ==
<br>


<br/>'''Notice:''' The ImageJ directory path depends on your ImageJ installation. Following, we assume that the ImageJ home directory is set up to ''C:\Program Files\ImageJ\''.<br\><br/>
== The [[downloads|MiToBo Binary]] Zip File ==


For installing MiToBo into an existing ImageJ installation perform the following steps:
To get the current release of MiToBo download and extract the [[downloads|MiToBo Binary zip file]].<br> You will find the following structure of directories and files:
* lib - includes nesessary libaries for Linux and Windows
* licences - includes MiToBo license and licences for other software used by MiToBo
* macros - includes the MiToBo macro toolset
* plugins - includes MiToBo jar and other jars used by MiToBo
* testimages - some sample images
* ''MiToBo-Guide-1.0.pdf'' - the user and programmer guide for MiToBo
* ''oprunner.sh'' - shell script to run MiToBo operators from commandline (Linux only)
* ''run.sh'' - shell script to run ImageJ with MiToBo (Linux only)
* ''README'' - with basic information


# go to the '''MiToBo-bin\plugins\''' directory
== Using MiToBo's APIs ==
#* copy the ''Mi_To_Bo.jar'' to your ''..\ImageJ\plugins\'' directory
To use the API of MiToBo and benefit from MiToBo's functionality in your own code you just need to make the jar archive to be found in the zip file available on your classpath. In addition, make sure that all jar archives MiToBo depends on and which are listed on the [[downloads|Download page]] are also in your classpath.<br> Note that the jars are also included in the MiToBo's binary zip file, thus, you don't need to download them manually.
#* copy all jars to your ''..\ImageJ\plugins\jars\'' directory <span style="text-decoration: underline;">except</span> the ij.jar and jars already existing<br/>('''Notice:''' MiToBo requires explicite versions of some jars, other versions may not work probably, see [[downloads|requirements]].)<br/><br/>
# go to the '''MiToBo-bin\lib\''' directory
#* copy the ''libwin32'' directory to your ''..\ImageJ\'' directory<br/><br/>
# go to the '''MiToBo-bin\macros\toolsets\''' directory
#* copy the ''MiToBo_Runner.txt'' to your ''..\ImageJ\macros\toolsets\'' directory<br/><br/>
# configurate your ImageJ startup<br/><br/>
:* edit ImageJ configuration file ''..\ImageJ\ImageJ.cfg'' and add the library path<br/><br/>'''-Djava.library.path="C:\Program Files\ImageJ\libwin32"'''<br/><br/>Example of an ImageJ.cfg file:
    C:\Program Files\ImageJ\
    C:\Program Files\Java\jre6\bin\javaw.exe
    -Djava.library.path="C:\Program Files\ImageJ\libwin32" -cp "C:\Program Files\ImageJ\ij.jar" ij.ImageJ
<br/>
:* as an alternative you can start ImageJ from command line
::* open your Windows command line
::* move to the ''..\ImageJ\'' directoy
::* type the following command:
  java -Djava.library.path="C:\Program Files\ImageJ\libwin32" -cp "C:\Program Files\ImageJ\ij.jar" ij.ImageJ

Latest revision as of 12:35, 22 January 2019

General remarks

There are two common ways to work with MiToBo:

  • just using the operators included in MiToBo for improving your work and easing image processing tasks, e.g., via ImageJ or Fiji
  • using the MiToBo API to write operators, plugins and other image analysis applications on your own

The functionality of MiToBo is best used from within ImageJ or Fiji. In case that you aim to use MiToBo for your own development, you need to download the binaries explicitly. The actual installation instructions differ in some parts depending on which way of using MiToBo you have in mind.
Below we will first outline more details about the installation steps required for simply using MiToBo's operators in ImageJ and Fiji, and then provide some notes regarding the binary zip file. Finally we will present some details for using MiToBo's API with your own code.


Using MiToBo with Fiji

Since release 1.5 MiToBo features a Fiji update site and the easiest way to use MiToBo's operators and plugins is to enable the update site in your Fiji installation.
The MiToBo update site is

http://sites.imagej.net/MiToBo

To enable the site in your Fiji installation refer to the Fiji documentation.

Important notices:

  • Occasionally MiToBo operators crash when run from within Fiji. The reason for this behaviour are most of the time conflicting jar archives delivered with the Fiji distribution.
    We figured out that particularly the jar file
    • jars/bio-formats/formats-common-5.1.x.jar
    often causes such trouble. Thus, if you encounter problems running MiToBo operators, please try to locally delete or uninstall the abovementioned jar archive from your local Fiji installation and then re-run the MiToBo operator.
  • For some of our operators special issues exist and require special treatment:
    • CellBoundaryExtractor2D: there are version conflicts with regard to the JGraphT library used by this operator and also by default included in every Fiji distribution; please refer to installation instructions on the webpage of the operator for a workaround


Using MiToBo with ImageJ

Important Note: These instructions refer to ImageJ 1 only, instructions for ImageJ 2.0 will follow soon.


Linux

Using MiToBo with a Linux operating system.


Windows

Using MiToBo with a Windows operating system.


The MiToBo Binary Zip File

To get the current release of MiToBo download and extract the MiToBo Binary zip file.
You will find the following structure of directories and files:

  • lib - includes nesessary libaries for Linux and Windows
  • licences - includes MiToBo license and licences for other software used by MiToBo
  • macros - includes the MiToBo macro toolset
  • plugins - includes MiToBo jar and other jars used by MiToBo
  • testimages - some sample images
  • MiToBo-Guide-1.0.pdf - the user and programmer guide for MiToBo
  • oprunner.sh - shell script to run MiToBo operators from commandline (Linux only)
  • run.sh - shell script to run ImageJ with MiToBo (Linux only)
  • README - with basic information

Using MiToBo's APIs

To use the API of MiToBo and benefit from MiToBo's functionality in your own code you just need to make the jar archive to be found in the zip file available on your classpath. In addition, make sure that all jar archives MiToBo depends on and which are listed on the Download page are also in your classpath.
Note that the jars are also included in the MiToBo's binary zip file, thus, you don't need to download them manually.