Skip to content

Built in Input\Output plugins

Alessandro Bria edited this page Sep 3, 2018 · 8 revisions

TeraStitcher comes along with a set of image file format plugins that enable both 2D and 3D image I/O. The following plugins can be selected using the user inputs --imin_plugin and --imout_plugin for input and output, respectively. Some plugins support only input operations. Some plugins may need configuration parameters. You can input these by --imin_plugin_params and --imout_plugin_params for input and output, respectively. You can display a description of all available plugins, their configuration parameters and additional parameters required by some of their operations by running TeraStitcher with the command line option --pluginsinfo.


tiff2D

2D image-based I/O plugin that uses the libtiff library to read/write 2D tiffs.

Supported image format extentions are:

  • TIFF
  • TIF

Accepted configuration parameters:

  • none

tiff3D

3D image-based I/O plugin that uses the libtiff library to read/write multipage tiffs.

Supported image format extentions are:

  • TIFF
  • TIF

Accepted configuration parameters:

  • none

IMS_HDF5

3D image-based I/O plugin that uses the HDF5 library to o implement the format used by Imaris.

Accepted configuration parameters:

  • resolution=<integer>: the resolution to be read
  • timepoint=<integer>: the timepoint to be read
  • channel=<integer>: the channel to be read

dcimg

3D image-based I/O plugin that implements the format used by Hamamatsu cameras.

Accepted configuration parameters:

  • resolution=<integer>: the resolution to be read
  • timepoint=<integer>: the timepoint to be read
  • channel=<integer>: the channel to be read

opencv2D

available with the source code, not included in the precompiled binaries.

2D image-based I/O plugin that uses the OpenCV library to read/write 2D image files.

Supported image format extentions are:

  • BMP
  • DIB
  • JPEG
  • JPG
  • JPE
  • PNG
  • PBM
  • PGM
  • PPM
  • SR
  • RAS
  • TIFF
  • TIF

Accepted configuration parameters:

  • none

exampleplugin2D

available with the source code, not included in the precompiled binaries.

A dummy 2D image-based I/O plugin to demonstrate the extensibility of TeraStitcher I/O (see Write an IO plugin:example).

Supported image formats:

  • none

Accepted configuration parameters:

  • astring: example parameter to pass a string
  • aninteger: example parameter to pass an integer