bio formats matlab

• Bio-Formats 6.3.1 documentation »
• User Information »

MATLAB is a high-level language and interactive environment that facilitates rapid development of algorithms for performing computationally intensive tasks.

Calling Bio-Formats from MATLAB is fairly straightforward, since MATLAB has built-in interoperability with Java. We have created a toolbox for reading and writing image files. Note the minimum recommended MATLAB version is R2017b.

It is possible to run Bio-Formats 6 on earlier MATLAB versions using a JVM version 8 or greater although using a different JVM than the one shipped with MATLAB can affect other functionalities. Please refer to the MATLAB Answers for more information.

Installation ¶

Download the MATLAB toolbox from the Bio-Formats downloads page . Unzip bfmatlab.zip and add the unzipped bfmatlab folder to your MATLAB path.

Please see Using Bio-Formats in MATLAB for usage instructions. If you intend to extend the existing .m files, please also see the developer page for more information on how to use Bio-Formats in general.

Performance ¶

In our tests (MATLAB R14 vs. java 1.6.0_20), the script executes at approximately half the speed of our showinf command line tool , due to overhead from copying arrays.

Troubleshooting ¶

If you encounter an error trying to open JPEG-2000 data in MATLAB but the file will open e.g. in Fiji using Bio-Formats, it may be due to conflicting versions of JAI ImageIO in different JARs. As discussed on the component page, JAI ImageIO is no longer maintained and you will likely need to remove the conflicting JAR(s) as a workaround.

Upgrading ¶

To use a newer version of Bio-Formats, overwrite the content of the bfmatlab folder with the newer version of the toolbox and restart MATLAB.

Alternative scripts ¶

Several other groups have developed their own MATLAB scripts that use Bio-Formats, including the following:

• https://github.com/pramukta/bf-tools
• imread for multiple life science image file formats

Bio-Formats

Page contents.

• Installation
• Performance
• Troubleshooting
• Alternative scripts

Previous topic

Quick search.

• Show Source
• Show on GitHub
• Edit on GitHub

Skip to content. | Skip to navigation

• Accessibility

© 2000-2024 University of Dundee & Open Microscopy Environment. Creative Commons Attribution 4.0 International License

OME source code is available under the GNU General public license or through commercial license from Glencoe Software

Navigation Menu

Search code, repositories, users, issues, pull requests..., provide feedback.

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly.

To see all available qualifiers, see our documentation .

• Notifications

Bio-Formats is a Java library for reading and writing data in life sciences image file formats. It is developed by the Open Microscopy Environment. Bio-Formats is released under the GNU General Public License (GPL); commercial licenses are available from Glencoe Software.

ome/bioformats

Folders and files, repository files navigation, bio-formats.

Bio-Formats is a standalone Java library for reading and writing life sciences image file formats. It is capable of parsing both pixels and metadata for a large number of formats, as well as writing to several formats.

If you are having an issue with Bio-Formats and need support, please see the support page .

Bio-Formats' primary purpose is to convert proprietary microscopy data into an open standard called the OME data model, particularly into the OME-TIFF file format. See About Bio-Formats for further information.

Supported formats

Bio-Formats supports more than a hundred file formats .

Many software packages use Bio-Formats to read and write microscopy formats.

For developers

You can use Bio-Formats to easily support these formats in your software .

More information

For more information, see the Bio-Formats web site .

Pull request testing

We welcome pull requests from anyone, but ask that you please verify the following before submitting a pull request:

• verify that the branch merges cleanly into develop
• verify that the branch compiles with the clean jars tools Ant targets
• verify that the branch compiles using Maven
• verify that the branch does not use syntax or API specific to Java 1.8+
• run the unit tests ( ant test ) and correct any failures
• test at least one file in each affected format, using the showinf command
• internal developers only: run the data tests against directories corresponding to the affected format(s)
• make sure that your commits contain the correct authorship information and, if necessary, a signed-off-by line
• make sure that the commit messages or pull request comment contains sufficient information for the reviewer(s) to understand what problem was fixed and how to test it

Code of conduct

Security policy, releases 10, contributors 88.

• PostScript 35.6%
• MATLAB 0.8%
• JavaScript 0.1%
• Python 0.1%

ImageJ Docs

• User Guides
• Keyboard Shortcuts
• Tips and Tricks
• Troubleshooting
• Frequently Asked Questions
• Raspberry Pi

Bio-Formats

• Video formats
• Olympus VSI
• Principles of Scientific Imaging
• Annotating Images
• Colocalization
• Color Image Processing
• Deconvolution
• Image Intensity Processing
• Particle Analysis
• Registration
• Segmentation
• Stack-slice Manipulations
• T-functions
• Visualization
• Z-functions
• List of Extensions
• List of Update Sites
• Following an Update Site
• Creating an Update Site
• Terms of Service
• Automatic Upload
• Uploading to Core Sites
• Update Sites FAQ
• Batch Processing
• Scripting Basics
• Script Editor
• Using Javadoc
• Auto Import
• Running Headlessly
• Scripting Comparisons
• BeanShell Scripting
• Groovy Scripting
• ImageJ Macro
• Lisp (Clojure)
• Ruby (JRuby)
• Scala Scripting
• Architecture

Source code

• Project management
• Coding style
• IntelliJ IDEA
• Command Line
• Writing plugins
• Contributing to a plugin
• Development lifecycle
• Building a POM
• Hands-on debugging
• Adding new ops
• Adding new formats
• Using native libraries
• Tips for developers
• Tips for C++ developers
• ImageJ 1.x plugins
• Git in Eclipse (EGit)
• Git mini howto
• Git workshop
• Git conflicts
• Git topic branches
• Git reflogs
• Git submodules
• How to pinpoint regressions
• How to publish a git repository
• How to extract a subproject
• Contributors
• Organizations
• Contributing to Fiji
• Public domain
• Advanced Editing
• Source Code
• Math Expressions
• Reporting Issues
• Mailing Lists
• Presentations
• Conferences
• ImageJ Common
• ImageJ Legacy
• Getting Started
• Accessibles
• Introductory Workshop
• Advanced Workshop
• ImgLib2 images in MATLAB
• Developing ImgLib2
• ImgLib2 Discussion

Vital statistics

Page contents.

• Save as animated gif
• Bio‑Formats
• FIBSEM importer
• LSM Toolbox
• OlympusImageJPlugin
• Extract Images From PDF...
• TIA .ser folder export
• Vaa3d Reader
• Vaa3d Writer
• Wavefront .OBJ ...

Import data from many life sciences file formats, and export to several open formats.

See LOCI’s Bio-Formats site for a historical narrative of the project.

Documentation

What follows is a brief overview of the available plugins. You will find them all under the “Bio-Formats” submenu of Plugins. See the Bio-Formats website for additional information about Bio-Formats in general.

See especially the Using Bio-Formats page for detailed instructions.

Bio-Formats Importer

The Bio-Formats Importer is a plugin for reading data into Fiji. It can open many dozens of proprietary life sciences formats, and standardize their acquisition metadata into a common OME data model . It will also extract and set basic metadata values such as spatial calibration if they are available in the file.

Often, you will not need to worry about this plugin to import your data, because Bio-Formats is largely integrated with the File › Open command of Fiji. However, for certain file formats, you may wish to explicitly activate the Bio-Formats Importer to override the default behavior of Fiji. For example, by default Fiji uses some built-in logic to open TIFF files, but this logic may fail with certain TIFFs. The Bio-Formats Importer plugin may be able to import such TIFFs successfully.

Bio-Formats Exporter

The Bio-Formats Exporter is a plugin for exporting data to disk.

It can save to the open OME-TIFF file format, as well as several movie formats (e.g., QuickTime, AVI) and graphics formats (e.g., PNG, JPEG).

• Animated PNG (*.png)
• Audio Video Interleave (*.avi)
• CellH5 File Format (*.ch5)
• Encausupated PostScript (*.eps, *.epsi)
• Image Cytometry Standard (*.ids, *.ics)
• Java source code (*.java)
• JPEG (*.jpg, *.jpeg, *.jpe)
• JPEG-2000 (*.jp2)
• OME-TIFF (*.ome.tif, *.ome.tiff, *.ome.tf2, *.ome.tf8, *.ome.btf)
• OME-XML (*.ome, *.ome.xml)
• QuickTime (*.mov)
• Tagged Image File Format (TIFF) (*.tif, *.tiff, *.tf2, *.tf8, *.btf)
• Vaa3d (*.v3draw)
• Woolz (*.wlz)

For OME-TIFF and TIFF formats, the file extensions *.tif and *.tiff are associated with the standard 32-bit TIFF, which has a 4GB size limit. On the other hand, the file extensions *.tf2 , *.tf8 , and *.btf are automatically associated with the 64-bit BigTIFF format , which can store much bigger data.

Bio-Formats Remote Importer

The Bio-Formats Remote Importer is a plugin for importing data from a remote URL.

It is likely to be less robust than working with files on disk, so when possible we recommend downloading your data to disk and using the regular Bio-Formats Importer instead.

Bio-Formats Windowless Importer

The Bio-Formats Windowless Importer is a version of the Bio-Formats Importer plugin that runs with the last used settings to avoid popping up any additional dialogs beyond the file chooser. If you find that you always use the same import settings, you may wish to use the windowless importer to save time.

Bio-Formats Macro Extensions

The Bio-Formats plugins come with a set of macro extensions to enable additional functionality from macros. The Bio-Formats Macro Extensions plugin prints out the available commands to the ImageJ log window, along with instructions for using them.

Stack Slicer

The Stack Slicer plugin is a helper plugin used by the Bio-Formats Importer . It can also be used standalone to split a stack across channels, focal planes or time points.

Bio-Formats Plugins Configuration

The Bio-Formats Plugins Configuration dialog is a useful way to configure the behavior of each file format. You can see a list of supported file formats on the Formats tab, toggle each format on or off (which is useful, for example, if your file is being detected as the wrong format), and toggle whether each format bypasses the importer options dialog using the “Windowless” checkbox. You can also configure any specific options for each format—for example, for QuickTime, you can toggle between Apple’s QTJava library or Bio-Formats’s built-in support.

In addition, you can see a list of available helper libraries used by Bio-Formats on the Libraries tab.

Bio-Formats Plugins Shortcut Window

The Bio-Formats Plugins Shortcut Window is a small window with a quick-launch button for each plugin. You can also drag and drop files onto the shortcut window to open them quickly using the Bio-Formats Importer plugin.

Update Bio-Formats Plugins

The Update Bio-Formats Plugins command will check online for updates to the Bio-Formats Plugins. In the case of Fiji, we recommend that you do not use this method of update, but instead use the ImageJ Updater .

Calling Bio-Formats from the command line

You can invoke Bio-Formats from the command line using the ImageJ Launcher :

• Use the Macro Recorder to record the line of macro code that runs Bio-Formats that way you want.
• Click “Create” to pop up the Script Editor , edit as desired, then save the macro as a .ijm macro file.
• Run the macro from the command line; e.g.:

Leave off the -batch flag if you want ImageJ to remain open afterward.

Note that you cannot use the –headless option because Bio-Formats does not work in headless mode, even when running as a macro. (You will see VerifyError on the console if you try.)

Here is an example macro created in such a fashion:

Bio-Formats has a high-level scripting interface, accessible by Java and all scripting languages supported by Fiji (but not the ImageJ macro language). Java example:

If needed, import options can be set:

Daily builds

The daily builds are not yet released and should be considered beta in quality. There may be new bugs. In particular, you should avoid exporting data using the Bio-Formats Exporter because the files it writes might not be readable later by release versions of Bio-Formats or other OME-compliant tools.

Fiji ships release versions of Bio-Formats. However, given the long time frame between releases, you can update to the latest code by toggling the Bio-Formats update site, which includes the latest bug-fixes.

When reporting a bug, the developers may ask you to test with the Bio-Formats update site enabled.

To enable the Bio-Formats update site:

• Launch the updater: Update from the Help menu.
• Click the Manage update sites button.

• Click the Apply changes button.
• Restart Fiji when prompted.

The Bio-Formats source code is on GitHub .

Reporting bugs

To report a bug in Bio-Formats, please see reporting a bug in Bio-Formats .

Publication

doi:10.1083/jcb.201004104

• Design: HTML5 UP

• MATLAB Answers
• File Exchange
• AI Chat Playground
• Discussions
• Communities
• Treasure Hunt
• Community Advisors
• Virtual Badges
• Trial software

You are now following this question

• You will see updates in your followed content feed .
• You may receive emails, depending on your communication preferences .

Bio formats in Matlab - Bfopen - string for filename

Direct link to this question

https://www.mathworks.com/matlabcentral/answers/623563-bio-formats-in-matlab-bfopen-string-for-filename

   0 Comments Show -2 older comments Hide -2 older comments

Sign in to comment.

Sign in to answer this question.

Accepted Answer

Direct link to this answer

https://www.mathworks.com/matlabcentral/answers/623563-bio-formats-in-matlab-bfopen-string-for-filename#answer_522253

   4 Comments Show 2 older comments Hide 2 older comments

Direct link to this comment

https://www.mathworks.com/matlabcentral/answers/623563-bio-formats-in-matlab-bfopen-string-for-filename#comment_1080923

https://www.mathworks.com/matlabcentral/answers/623563-bio-formats-in-matlab-bfopen-string-for-filename#comment_1080928

https://www.mathworks.com/matlabcentral/answers/623563-bio-formats-in-matlab-bfopen-string-for-filename#comment_1080983

https://www.mathworks.com/matlabcentral/answers/623563-bio-formats-in-matlab-bfopen-string-for-filename#comment_1081098

More Answers (1)

https://www.mathworks.com/matlabcentral/answers/623563-bio-formats-in-matlab-bfopen-string-for-filename#answer_522238

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

An Error Occurred

Unable to complete the action because of changes made to the page. Reload the page to see its updated state.

Select a Web Site

Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .

You can also select a web site from the following list

How to Get Best Site Performance

Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.

• América Latina (Español)
• Canada (English)
• United States (English)
• Belgium (English)
• Denmark (English)
• Deutschland (Deutsch)
• España (Español)
• Finland (English)
• France (Français)
• Ireland (English)
• Italia (Italiano)
• Luxembourg (English)
• Netherlands (English)
• Norway (English)
• Österreich (Deutsch)
• Portugal (English)
• Sweden (English)
• United Kingdom (English)

Asia Pacific

• Australia (English)
• India (English)
• New Zealand (English)
• 简体中文 Chinese
• 日本 Japanese (日本語)
• 한국 Korean (한국어)

Contact your local office