Installation: Difference between revisions

From MiToBo
Jump to navigationJump to search
No edit summary
 
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Linux ==
== General remarks ==


... comming soon!
There are two common ways to work with MiToBo:
<ul>
<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
</ul>
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.


== Windows ==
<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>


After downloading and extracting the [[downloads|MiToBo Binaries zip]] you will find the following structure in the ''MiToBo-bin'' directory
[http://sites.imagej.net/MiToBo http://sites.imagej.net/MiToBo]


* docs - includes the MiToBo manual
To enable the site in your Fiji installation refer to the [http://fiji.sc/How_to_follow_a_3rd_party_update_site Fiji documentation].
 
'''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
 
* 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.
<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>
 
<br>
 
== Using MiToBo with ImageJ ==
 
'''Important Note:''' These instructions refer to ImageJ 1 only, instructions for ImageJ 2.0 will follow soon.
 
<br>
 
=== Linux ===
 
Using MiToBo with a [[Installation/Linux|Linux operating system]].
 
<br>
 
=== Windows ===
 
Using MiToBo with a [[Installation/Windows|Windows operating system]].
 
<br>
 
== The [[downloads|MiToBo Binary]] Zip File ==
 
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
* lib - includes nesessary libaries for Linux and Windows
* licences - includes MiToBo license and licences for other software used by MiToBo
* licences - includes MiToBo license and licences for other software used by MiToBo
* macros - includes the MiToBo macro toolset
* macros - includes the MiToBo macro toolset
* plugins - includes MiToBo jar and other jars used by MiToBo
* plugins - includes MiToBo jar and other jars used by MiToBo
* oprunner.sh and run.sh - scripts for Linux OS
* 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)
For installing MiToBo into an existing ImageJ installation perform the following steps:
* ''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 (''C:\Program Files\ImageJ\plugins'' for example)
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 [[downloads|requires]] explicite versions of some jars, other versions may not work probably!)<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/>
:* update ImageJ configuration file ''../ImageJ/ImageJ.cfg'' an add the following line<br/><br/>'''-Djava.library.path="C:\Programme\ImageJ\libwin32" -cp "C:\Programme\ImageJ\ij.jar" ij.ImageJ'''<br\><br/>('''Notice:''' The ImageJ directory path depends on your ImageJ installation)<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.