Difference between revisions of "ImageJ1-ImageJ2 cheat sheet"

(Created page with "This page summarizes translation of basic operations of ImageJ1 and ImageJ2 API. Based on the work of Robert Hasse, Scientific Computing Facility, MPI CBG Dresden. {| class="...")
 
(Fix credit)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page summarizes translation of basic operations of ImageJ1 and ImageJ2 API. Based on the work of Robert Hasse, Scientific Computing Facility, MPI CBG Dresden.
+
This page summarizes translation of basic operations of ImageJ1 and ImageJ2 API. Based on the work of {{Person|Haesleinhuepf}}, Scientific Computing Facility, MPI-CBG Dresden.
  
 
{| class="wikitable"
 
{| class="wikitable"
! style="text-align:left;"| Item
+
! style="text-align:left;"| Task
 
! ImageJ1
 
! ImageJ1
 
! ImageJ2
 
! ImageJ2
 
|-
 
|-
 
|Starting ImageJ
 
|Starting ImageJ
|<source lang="java">ij.ImageJ</source>
+
|<source lang="java">new ij.ImageJ();</source>
|<source lang="java">ImageJ ij = new net.imagej.ImageJ();
+
|<source lang="java">
ij.ui().showUI();</source>
+
ImageJ ij = new net.imagej.ImageJ();
 +
ij.ui().showUI();
 +
</source>
 
|-
 
|-
 
|Show images
 
|Show images
|<source lang="java">imagePlus.show()</source>
+
|<code>imp</code> is an <code>ImagePlus</code> object
|<source lang="java">ij.ui().show(testImg);</source>
+
<source lang="java">imp.show()</source>
<source lang="java">ImageJFunctions.show(testImg);</source>
+
|
<source lang="java">ImageJFunctions.wrap(testImg,"testImg").show();</source>
+
<source lang="java">ij.ui().show(imp);</source>
 +
<source lang="java">ImageJFunctions.show(imp);</source>
 +
<source lang="java">ImageJFunctions.wrap(imp,"Image").show();</source>
 +
|-
 +
|Retrieve an active image object
 +
|<source lang="java">ImagePlus imp = IJ.getImage();</source>
 +
|Script parameter (the same for <code>Dataset</code>, <code>ImagePlus</code>, etc.):
 +
<source lang="java">#@ Img image</source>
 +
In Java code:
 +
<source lang="java">
 +
@Parameter
 +
private Img image;
 +
</source>
 +
Using <code>ImageDisplayService</code>:
 +
<source lang="java">Dataset image = ij.imageDisplay().getActiveDataset();</source>
 +
|-
 +
|Open an image file
 +
|<code>IJ.openImage()</code> returns an <code>ImagePlus</code> object without showing.
 +
<source lang="java">
 +
ImagePlus imp = IJ.openImage(urlOrFilePath);
 +
imp.show();
 +
</source>
 +
<code>IJ.open()</code> automatically shows the image without returning <code>ImagePlus</code>.
 +
<source lang="java">
 +
IJ.open(urlOrFilePath);
 +
ImagePlus imp = IJ.getImage();
 +
</source>
 +
|Using <code>IOService</code>:
 +
<source lang="java">Object image = ij.io().open(urlOrFilePath);</source>
 +
Using <code>DatasetIOService</code> (for type safety):
 +
<source lang="java">Dataset image = ij.scifio().datasetIO().open(urlOrFilePath);</source>
 +
|-
 +
|Save an image file
 +
|<source lang="java">IJ.saveasTiff(imp, "/path/to/image.tif")</source>
 +
|Using <code>IOService</code>:
 +
<source lang="java">ij.io().save(dataset, "/path/to/image.tif");</source>
 +
Using <code>DatasetIOService</code>:
 +
<source lang="java">ij.scifio().datasetIO().save(dataset, "/path/to/image.tif");</source>
 
|-
 
|-
 
|Convert image types
 
|Convert image types
|<source lang="java">ImagePlus imp = ImageJFunctions.wrap(img,"Title");</source>
+
|Convert from ImageJ2 Img object to ImageJ1 <code>ImagePlus</code> object: <source lang="java">ImagePlus imp = ImageJFunctions.wrap(img,"Title");</source>
|<source lang="java">Img<T> realImg = ImageJFunctions.wrapReal(imp);<source>
+
|Convert from ImageJ1 <code>ImagePlus</code> object to ImgLib2 <code>Img</code> object: <source lang="java">Img<T> realImg = ImageJFunctions.wrapReal(imp);</source>
 
<source lang="java">Img<FloatType> floatImg = ImageJFunctions.convertFloat(imp);</source>
 
<source lang="java">Img<FloatType> floatImg = ImageJFunctions.convertFloat(imp);</source>
 
<source lang="java">Img<FloatType> realImg2 = ImageJFunctions.wrap(imp);</source>
 
<source lang="java">Img<FloatType> realImg2 = ImageJFunctions.wrap(imp);</source>
 +
|-
 +
|Show regions
 +
|<source lang="java">imagePlus.setRoi(roi)</source>
 +
|<source lang="java">Img<BitType> mask; // = ...
 +
ImagePlus maskImp =ImageJFunctions.wrap(mask, "mask");
 +
// threshold the mask to get an ROI
 +
ImageProcessor imageProcessor = maskImp.getProcessor();
 +
imageProcessor.setThreshold(128,128,ImageProcessor NO_LUT_UPDATE);
 +
Roi roi = new ThresholdToSelection().convert(imageProcessor);
 +
imagePlus.setRoi(roi);</source>
 +
|-
 +
|Run plugins
 +
|<source lang="java">IJ.run(imagePlus,"Normalisation","");</source>
 +
|<source lang="java">
 +
ij.command().run(ImageNormalizerIJ2Plugin.class, true, "input", img, "ij", ij);
 +
</source>
 +
|-
 +
|Define plugins
 +
|<source lang="java">
 +
public class ImageNormalizerPlugin implements PluginFilter {
 +
  ...
 +
}
 +
</source>
 +
In <code>resources/plugins.config</code>:
 +
<source>
 +
Plugins>Filtering, "Normalisation", NormalizerPlugin
 +
</source>
 +
|<source lang="java">
 +
@Plugin(type = Command.class, menuPath = "Plugins>Normalization")
 +
public class ImageNormalizerIJ2Plugin implements Command {
 +
  ...
 +
}
 +
</source>
 
|}
 
|}
  
Line 30: Line 102:
  
 
https://github.com/mpicbg-scicomp/ij2course-images/blob/master/slides/ij_legacy_cheetsheet.pdf
 
https://github.com/mpicbg-scicomp/ij2course-images/blob/master/slides/ij_legacy_cheetsheet.pdf
 +
 +
 +
[[Category:Tutorials]]
 +
[[Category:Development]]

Latest revision as of 08:44, 21 November 2018

This page summarizes translation of basic operations of ImageJ1 and ImageJ2 API. Based on the work of Robert Haase, Scientific Computing Facility, MPI-CBG Dresden.

Task ImageJ1 ImageJ2
Starting ImageJ
new ij.ImageJ();
ImageJ ij = new net.imagej.ImageJ();
ij.ui().showUI();
Show images imp is an ImagePlus object
imp.show()
ij.ui().show(imp);
ImageJFunctions.show(imp);
ImageJFunctions.wrap(imp,"Image").show();
Retrieve an active image object
ImagePlus imp = IJ.getImage();
Script parameter (the same for Dataset, ImagePlus, etc.):
#@ Img image

In Java code:

@Parameter
private Img image;

Using ImageDisplayService:

Dataset image = ij.imageDisplay().getActiveDataset();
Open an image file IJ.openImage() returns an ImagePlus object without showing.
ImagePlus imp = IJ.openImage(urlOrFilePath);
imp.show();

IJ.open() automatically shows the image without returning ImagePlus.

IJ.open(urlOrFilePath);
ImagePlus imp = IJ.getImage();
Using IOService:
Object image = ij.io().open(urlOrFilePath);

Using DatasetIOService (for type safety):

Dataset image = ij.scifio().datasetIO().open(urlOrFilePath);
Save an image file
IJ.saveasTiff(imp, "/path/to/image.tif")
Using IOService:
ij.io().save(dataset, "/path/to/image.tif");

Using DatasetIOService:

ij.scifio().datasetIO().save(dataset, "/path/to/image.tif");
Convert image types Convert from ImageJ2 Img object to ImageJ1 ImagePlus object:
ImagePlus imp = ImageJFunctions.wrap(img,"Title");
Convert from ImageJ1 ImagePlus object to ImgLib2 Img object:
Img<T> realImg = ImageJFunctions.wrapReal(imp);
Img<FloatType> floatImg = ImageJFunctions.convertFloat(imp);
Img<FloatType> realImg2 = ImageJFunctions.wrap(imp);
Show regions
imagePlus.setRoi(roi)
Img<BitType> mask; // = ...
ImagePlus maskImp =ImageJFunctions.wrap(mask, "mask");
// threshold the mask to get an ROI
ImageProcessor imageProcessor = maskImp.getProcessor();
imageProcessor.setThreshold(128,128,ImageProcessor NO_LUT_UPDATE);
Roi roi = new ThresholdToSelection().convert(imageProcessor);
imagePlus.setRoi(roi);
Run plugins
IJ.run(imagePlus,"Normalisation","");
ij.command().run(ImageNormalizerIJ2Plugin.class, true, "input", img, "ij", ij);
Define plugins
public class ImageNormalizerPlugin implements PluginFilter {
  ...
}

In resources/plugins.config:

Plugins>Filtering, "Normalisation", NormalizerPlugin
@Plugin(type = Command.class, menuPath = "Plugins>Normalization")
public class ImageNormalizerIJ2Plugin implements Command {
  ...
}


See also

https://github.com/mpicbg-scicomp/ij2course-images/blob/master/slides/ij_legacy_cheetsheet.pdf