README.md

scifio-bf-compat

SCIFIO plug-in allowing the use Bio-Formats readers.

Usage

Short version: Add the following dependencies to your project:

• io.scif:scifio
  • to use SCIFIO
• io.scif:scifio-bf-compat
  • to enable Bio-Formats support within SCIFIO
• ome:formats-bsd
  • optional, for open formats supported by Bio-Formats
• ome:formats-gpl
  • optional, for proprietary formats supported by Bio-Formats

To ensure version compatibility, you should import or extend net.imagej:pom-imagej, which manages the Bill of Materials. Doing this allows you to declare the above dependencies without explicitly specifying their respective versions.

Be aware that the first three components above are licensed under BSD-2, whereas ome:formats-gpl is licensed under the GPL, which might affect your project's licensing.

Details: Add the following blocks to your Maven POM:

<dependencyManagement>
  <dependencies>
    <!-- NB: Inherit the SCIFIO version management. -->
    <dependency>
      <groupId>net.imagej</groupId>
      <artifactId>pom-imagej</artifactId>
      <version>5.12.0</version>
    </dependency>
  </dependencies>
</dependencyManagement>
...
<dependencies>
  ...
  <dependency>
    <groupId>io.scif</groupId>
    <artifactId>scifio</artifactId>
  </dependency>
  <dependency>
    <groupId>io.scif</groupId>
    <artifactId>scifio-bf-compat</artifactId>
    <scope>runtime</scope>
  </dependency>
  <!-- The formats-bsd component adds support for open formats. -->
  <dependency>
    <groupId>ome</groupId>
    <artifactId>formats-bsd</artifactId>
    <scope>runtime</scope>
  </dependency>
  <!-- The formats-gpl component adds support for proprietary formats. -->
  <dependency>
    <groupId>ome</groupId>
    <artifactId>formats-gpl</artifactId>
    <scope>runtime</scope>
  </dependency>
  ...
</dependencies>
...
<repositories>
  <repository>
    <id>imagej.public</id>
    <url>https://maven.scijava.org/content/groups/public</url>
  </repository>
</repositories>

See the Bio-Formats supported formats table for a full breakdown of which file formats are supported by ome:formats-bsd vs. ome:formats-gpl.