21 Commits

Author SHA1 Message Date
2448d489ad update version number. 2024-01-24 12:20:27 +09:00
e84c50fcff update bio-formats version to 7.1.0. 2024-01-24 12:13:35 +09:00
4b56cfd9d8 update bio-formats version to 7.0.1. 2023-11-14 15:39:59 +09:00
82e1d3844c update bio-formats version to 7.0.0. 2023-08-22 14:05:18 +09:00
4c581052ab update bio-formats version to 6.14.0. 2023-07-13 13:50:25 +09:00
705e7f7e7d update bio-formats version to 6.12.0. 2023-04-20 12:25:50 +09:00
b00a67c5d0 update bio-formats version to 6.11.1. 2022-12-26 10:44:55 +09:00
e415ead1ec disable logging. 2022-10-14 12:10:10 +09:00
b8bfa77cc2 perform auto scalling if 16bit or gray scale thumbnail image. 2022-10-12 19:42:09 +09:00
0df492ff14 perform autoscaling if floating point thumbnail found. 2022-10-12 13:54:42 +09:00
4ea2dc7110 update version to 1.1.2. 2022-10-07 19:24:06 +09:00
a4bd4b0b96 catch undeclared exception in higher method. 2022-10-07 19:13:15 +09:00
dab69b174f format indent. 2022-10-05 18:03:46 +09:00
aa61113357 use ImageWriter to export to png image. 2022-10-05 16:00:29 +09:00
e43b688d7f update depending bio-formats version to 6.10.1. 2022-09-29 19:21:41 +09:00
6bd2bbc572 update example code for extracting thumbnail. 2022-09-29 19:03:57 +09:00
6d29af7f72 change access privileges to public for resize() method. 2022-09-29 19:02:49 +09:00
f81a1c2fbd select thumbnail series by "isThumbnailSeries" metadata. 2022-09-29 18:03:56 +09:00
847a81534b update version number. 2022-09-29 15:20:10 +09:00
8e3a599294 use source code indentation style to 4 spaces. 2022-09-29 15:13:33 +09:00
565832b018 update version to 1.1.0. 2022-09-29 15:12:45 +09:00
7 changed files with 441 additions and 305 deletions

9
.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,9 @@
{
"recommendations": [
"esbenp.prettier-vscode",
"mosapride.zenkaku",
"redhat.fabric8-analytics",
"streetsidesoftware.code-spell-checker",
"vscjava.vscode-java-pack"
]
}

18
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,18 @@
{
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": "explicit"
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
// Extensions - Code Spell Checker
"cSpell.ignoreWords": ["endianness", "noflat", "nopix", "omexml"],
"cSpell.words": ["bioformats", "imageinfo", "neurodata", "riken"],
// Extentions - Prettier
"prettier.printWidth": 120,
"prettier.singleQuote": true,
"prettier.tabWidth": 4,
"java.configuration.updateBuildConfiguration": "interactive",
"java.compile.nullAnalysis.mode": "automatic"
}

View File

@ -1,39 +1,48 @@
# BioFormatsImageInfo # BioFormatsImageInfo
Metadata extraction tool based on Bio-Formats Metadata extraction tool based on Bio-Formats
### make package ## make package
```shell ```shell
mvn package mvn package
``` ```
### run ## run
```shell ```shell
./target/dist/bin/bioformats-imageinfo "[path to image file]" ./target/dist/bin/bioformats-imageinfo "[path to image file]"
``` ```
### run by jar ### run by jar
```shell ```shell
java -jar ./target/dist/lib/bioformats-imageinfo-1.0.0.jar "[path to image file]" java -jar ./target/dist/lib/bioformats-imageinfo-1.2.2.jar "[path to image file]"
``` ```
### run by fat jar ### run by fat jar
```shell ```shell
java -jar ./target/bioformats-imageinfo-1.0.0-jar-with-dependencies.jar "[path to image file]" java -jar ./target/bioformats-imageinfo-1.2.2-jar-with-dependencies.jar "[path to image file]"
``` ```
### library usage ## library usage
```java ```java
import java.util.LinkedHashMap; import java.util.LinkedHashMap;
import java.util.Map; import java.util.Map;
import jp.riken.neurodata.tools.BioFormatsImageInfo; import jp.riken.neurodata.tools.BioFormatsImageInfo;
import jp.riken.neurodata.tools.BioFormatsException; import jp.riken.neurodata.tools.BioFormatsImageException;
import jp.riken.neurodata.tools.BioFormatsImageThumbnail;
String path = "[path to image file]"; String path = "[path to image file]";
String format = ""; String format = "";
Map<String, Object> metadata = new LinkedHashMap<String, Object>(); Map<String, Object> metadata = new LinkedHashMap<String, Object>();
Map<String, Object> thumbnail = new LinkedHashMap<String, Object>();
try { try {
format = BioFormatsImageInfo.readMetadata(path, metadata); format = BioFormatsImageInfo.readMetadata(path, metadata);
BioFormatsImageThumbnail.readThumbnail(path, thumbnail);
} catch (BioFormatsImageException e) { } catch (BioFormatsImageException e) {
// error occurred // error occurred
e.printStackTrace(); e.printStackTrace();

111
pom.xml
View File

@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>jp.riken.neurodata.tools.BioFormatsImageInfo</groupId> <groupId>jp.riken.neurodata.tools.BioFormatsImageInfo</groupId>
<artifactId>bioformats-imageinfo</artifactId> <artifactId>bioformats-imageinfo</artifactId>
<version>1.0.0</version> <version>1.2.2</version>
<name>bioformats-imageinfo</name> <name>bioformats-imageinfo</name>
<url>https://neurodata.riken.jp</url> <url>https://neurodata.riken.jp</url>
<properties> <properties>
<bio-formats.version>6.10.0</bio-formats.version> <bio-formats.version>7.1.0</bio-formats.version>
<bioformats-imageinfo.mainClass>jp.riken.neurodata.tools.BioFormatsImageInfo</bioformats-imageinfo.mainClass> <bioformats-imageinfo.mainClass>jp.riken.neurodata.tools.BioFormatsImageInfo</bioformats-imageinfo.mainClass>
<maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.source>1.8</maven.compiler.source>
@ -27,14 +27,39 @@
<artifactId>bio-formats-tools</artifactId> <artifactId>bio-formats-tools</artifactId>
<version>${bio-formats.version}</version> <version>${bio-formats.version}</version>
</dependency> </dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-nop</artifactId>
<version>2.0.9</version>
</dependency>
</dependencies> </dependencies>
<build> <build>
<plugins> <plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.4.1</version>
<executions>
<execution>
<id>enforce-maven</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<requireMavenVersion>
<version>3.2.5</version>
</requireMavenVersion>
</rules>
</configuration>
</execution>
</executions>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId> <artifactId>maven-dependency-plugin</artifactId>
<version>3.3.0</version> <version>3.6.1</version>
<executions> <executions>
<execution> <execution>
<id>copy-dependencies</id> <id>copy-dependencies</id>
@ -44,59 +69,35 @@
</goals> </goals>
<configuration> <configuration>
<overWriteIfNewer>true</overWriteIfNewer> <overWriteIfNewer>true</overWriteIfNewer>
</configuration> </configuration>
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId> <artifactId>maven-jar-plugin</artifactId>
<version>3.2.2</version> <version>3.3.0</version>
<configuration> <configuration>
<archive> <archive>
<manifest> <manifest>
<addClasspath>true</addClasspath> <addClasspath>true</addClasspath>
<mainClass>${bioformats-imageinfo.mainClass}</mainClass> <mainClass>${bioformats-imageinfo.mainClass}</mainClass>
</manifest> </manifest>
</archive> </archive>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.4.1</version>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
<archive>
<manifest>
<mainClass>${bioformats-imageinfo.mainClass}</mainClass>
</manifest>
</archive>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin> <plugin>
<groupId>org.codehaus.mojo</groupId> <groupId>org.codehaus.mojo</groupId>
<artifactId>appassembler-maven-plugin</artifactId> <artifactId>appassembler-maven-plugin</artifactId>
<version>1.10</version> <version>2.1.0</version>
<configuration> <configuration>
<assembleDirectory>${project.build.directory}/dist</assembleDirectory> <assembleDirectory>${project.build.directory}/dist</assembleDirectory>
<repositoryLayout>flat</repositoryLayout> <repositoryLayout>flat</repositoryLayout>
<repositoryName>lib</repositoryName> <repositoryName>lib</repositoryName>
<programs> <programs>
<program> <program>
<mainClass>${bioformats-imageinfo.mainClass}</mainClass> <mainClass>${bioformats-imageinfo.mainClass}</mainClass>
<id>${project.name}</id> <id>${project.name}</id>
</program> </program>
</programs> </programs>
</configuration> </configuration>
@ -109,10 +110,37 @@
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.6.0</version>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
<archive>
<manifest>
<mainClass>${bioformats-imageinfo.mainClass}</mainClass>
</manifest>
</archive>
<descriptors>
<descriptor>src/main/assembly/assembly.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin> <plugin>
<groupId>org.owasp</groupId> <groupId>org.owasp</groupId>
<artifactId>dependency-check-maven</artifactId> <artifactId>dependency-check-maven</artifactId>
<version>7.1.1</version> <version>9.0.9</version>
<executions> <executions>
<execution> <execution>
<goals> <goals>
@ -128,15 +156,18 @@
<pluginRepository> <pluginRepository>
<id>central</id> <id>central</id>
<name>Central Repository</name> <name>Central Repository</name>
<url>https://repo.maven.apache.org/maven2</url> <!-- <url>https://repo.maven.apache.org/maven2</url> -->
<url>https://repo1.maven.org/maven2/</url>
<layout>default</layout> <layout>default</layout>
</pluginRepository> </pluginRepository>
</pluginRepositories> </pluginRepositories>
<repositories> <repositories>
<repository> <repository>
<id>central</id> <id>central</id>
<name>Central Repository</name> <name>Central Repository</name>
<url>https://repo.maven.apache.org/maven2</url> <!-- <url>https://repo.maven.apache.org/maven2</url> -->
<url>https://repo1.maven.org/maven2/</url>
</repository> </repository>
<repository> <repository>
<id>ome</id> <id>ome</id>

View File

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
<id>bin</id>
<formats>
<format>tar.gz</format>
<format>tar.bz2</format>
<format>zip</format>
</formats>
<fileSets>
<fileSet>
<directory>target/dist/bin</directory>
<outputDirectory>bin</outputDirectory>
<excludes>
<exclude>*.bat</exclude>
</excludes>
<directoryMode>0755</directoryMode>
<fileMode>0755</fileMode>
</fileSet>
<fileSet>
<directory>target/dist/bin</directory>
<outputDirectory>bin</outputDirectory>
<includes>
<include>*.bat</include>
</includes>
<directoryMode>0755</directoryMode>
<fileMode>0644</fileMode>
</fileSet>
</fileSets>
<dependencySets>
<dependencySet>
<outputDirectory>lib</outputDirectory>
</dependencySet>
</dependencySets>
</assembly>

View File

@ -24,257 +24,259 @@ import loci.formats.tools.ImageInfo;
public class BioFormatsImageInfo { public class BioFormatsImageInfo {
protected static Map<String, Object> readImages(final IFormatReader reader) throws FormatException, IOException { protected static Map<String, Object> readImages(final IFormatReader reader) throws FormatException, IOException {
final Map<String, Object> metadata = new LinkedHashMap<String, Object>(); final Map<String, Object> metadata = new LinkedHashMap<String, Object>();
// read basic metadata // read basic metadata
final int seriesCount = reader.getSeriesCount(); final int seriesCount = reader.getSeriesCount();
final MetadataStore ms = reader.getMetadataStore(); final MetadataStore ms = reader.getMetadataStore();
final MetadataRetrieve mr = ms instanceof MetadataRetrieve ? (MetadataRetrieve) ms : null; final MetadataRetrieve mr = ms instanceof MetadataRetrieve ? (MetadataRetrieve) ms : null;
for (int j = 0; j < seriesCount; j++) { for (int j = 0; j < seriesCount; j++) {
// read basic metadata for series #j // read basic metadata for series #j
reader.setSeries(j); reader.setSeries(j);
final Map<String, Object> seriesMetadata = new LinkedHashMap<String, Object>(); final Map<String, Object> seriesMetadata = new LinkedHashMap<String, Object>();
final int imageCount = reader.getImageCount(); final int imageCount = reader.getImageCount();
final int resolutionCount = reader.getResolutionCount(); final int resolutionCount = reader.getResolutionCount();
final String seriesName = mr == null ? null : mr.getImageName(j); final String seriesName = mr == null ? null : mr.getImageName(j);
if (seriesName != null) { if (seriesName != null) {
seriesMetadata.put("name", seriesName); seriesMetadata.put("name", seriesName);
} }
// resolutions // resolutions
if (resolutionCount > 1) { if (resolutionCount > 1) {
final Map<String, Object> resolutionsMetadata = new LinkedHashMap<String, Object>(); final Map<String, Object> resolutionsMetadata = new LinkedHashMap<String, Object>();
for (int i = 0; i < resolutionCount; i++) { for (int i = 0; i < resolutionCount; i++) {
reader.setResolution(i); reader.setResolution(i);
resolutionsMetadata.put(String.format("resolution[%d]", i), resolutionsMetadata.put(String.format("resolution[%d]", i),
makeRectangle(reader.getSizeX(), reader.getSizeY())); makeRectangle(reader.getSizeX(), reader.getSizeY()));
}
seriesMetadata.put("resolutions", resolutionsMetadata);
reader.setResolution(0);
}
seriesMetadata.put("imageCount", imageCount);
seriesMetadata.put("RGB", new Object[] { reader.isRGB(), reader.getRGBChannelCount() });
seriesMetadata.put("interleaved", reader.isInterleaved());
// indexed
{
final List<Object> indexed = new ArrayList<Object>();
indexed.add(reader.isIndexed());
indexed.add(String.format("%b color", !reader.isFalseColor()));
final byte[][] table8 = reader.get8BitLookupTable();
if (table8 != null) {
indexed.add(
String.format("8-bit LUT: %d x %s", table8.length,
table8[0] == null ? "null" : "" + table8[0].length));
}
final short[][] table16 = reader.get16BitLookupTable();
if (table16 != null) {
indexed.add(String.format("16-bit LUT: %d x %s", table16.length,
table16[0] == null ? "null" : "" + table16[0].length));
}
seriesMetadata.put("indexed", indexed);
}
seriesMetadata.put("sizeX", reader.getSizeX());
seriesMetadata.put("sizeY", reader.getSizeY());
final int sizeZ = reader.getSizeZ();
seriesMetadata.put("sizeZ", makeDimension(sizeZ, sizeZ, reader.getModuloZ()));
seriesMetadata.put("sizeC",
makeDimension(reader.getSizeC(), reader.getEffectiveSizeC(), reader.getModuloC()));
final int sizeT = reader.getSizeT();
seriesMetadata.put("sizeT", makeDimension(sizeT, sizeT, reader.getModuloT()));
seriesMetadata.put("tileSize", makeRectangle(reader.getOptimalTileWidth(), reader.getOptimalTileHeight()));
seriesMetadata.put("thumbnailSize", makeRectangle(reader.getThumbSizeX(), reader.getThumbSizeY()));
seriesMetadata.put("endianness", reader.isLittleEndian() ? "little" : "big");
seriesMetadata.put("dimensionOrder",
new String[] { reader.getDimensionOrder(), reader.isOrderCertain() ? "certain" : "uncertain" });
seriesMetadata.put("pixelType", FormatTools.getPixelTypeString(reader.getPixelType()));
seriesMetadata.put("validBitsPerPixel", reader.getBitsPerPixel());
seriesMetadata.put("metadataComplete", reader.isMetadataComplete());
seriesMetadata.put("thumbnailSeries", reader.isThumbnailSeries());
// plane
{
final int[] indices;
if (imageCount > 6) {
int q = imageCount / 2;
indices = new int[] { 0, q - 2, q - 1, q, q + 1, q + 2, imageCount - 1 };
} else if (imageCount > 2) {
indices = new int[] { 0, imageCount / 2, imageCount - 1 };
} else if (imageCount > 1) {
indices = new int[] { 0, 1 };
} else {
indices = new int[] { 0 };
}
final int[][] zct = new int[indices.length][];
final int[] indices2 = new int[indices.length];
for (int i = 0; i < indices.length; i++) {
zct[i] = reader.getZCTCoords(indices[i]);
indices2[i] = reader.getIndex(zct[i][0], zct[i][1], zct[i][2]);
final Map<String, Object> planeMetadata = new LinkedHashMap<String, Object>();
planeMetadata.put("Z", zct[i][0]);
planeMetadata.put("C", zct[i][1]);
planeMetadata.put("T", zct[i][2]);
if (indices[i] != indices2[i]) {
planeMetadata.put("[mismatch]", indices2[i]);
}
seriesMetadata.put(String.format("plane[%d]", indices[i]), planeMetadata);
}
}
metadata.put(String.format("series[%d]", j), seriesMetadata);
} }
seriesMetadata.put("resolutions", resolutionsMetadata);
reader.setResolution(0);
}
seriesMetadata.put("imageCount", imageCount); return metadata;
seriesMetadata.put("RGB", new Object[] { reader.isRGB(), reader.getRGBChannelCount() }); }
seriesMetadata.put("interleaved", reader.isInterleaved());
// indexed protected static Map<String, Object> readAnnotations(final IFormatReader reader) {
{ final Map<String, Object> metadata = new LinkedHashMap<String, Object>();
final List<Object> indexed = new ArrayList<Object>(); // global metadata
indexed.add(reader.isIndexed()); final Hashtable<String, Object> globalMetadata = reader.getGlobalMetadata();
indexed.add(String.format("%b color", !reader.isFalseColor())); for (String key : MetadataTools.keys(globalMetadata)) {
final byte[][] table8 = reader.get8BitLookupTable(); metadata.put(key, globalMetadata.get(key));
if (table8 != null) {
indexed.add(
String.format("8-bit LUT: %d x %s", table8.length, table8[0] == null ? "null" : "" + table8[0].length));
} }
final short[][] table16 = reader.get16BitLookupTable(); // original metadata
if (table16 != null) { final int seriesCount = reader.getSeriesCount();
indexed.add(String.format("16-bit LUT: %d x %s", table16.length, for (int j = 0; j < seriesCount; j++) {
table16[0] == null ? "null" : "" + table16[0].length)); reader.setSeries(j);
final Hashtable<String, Object> seriesMetadata = reader.getSeriesMetadata();
if (!seriesMetadata.isEmpty()) {
final Map<String, Object> originalMetadata = new LinkedHashMap<String, Object>();
final String[] keys = MetadataTools.keys(seriesMetadata);
for (int i = 0; i < keys.length; i++) {
originalMetadata.put(keys[i], seriesMetadata.get(keys[i]));
}
metadata.put(String.format("series[%d]", j), originalMetadata);
}
} }
seriesMetadata.put("indexed", indexed);
}
seriesMetadata.put("sizeX", reader.getSizeX()); return metadata;
seriesMetadata.put("sizeY", reader.getSizeY()); }
final int sizeZ = reader.getSizeZ();
seriesMetadata.put("sizeZ", makeDimension(sizeZ, sizeZ, reader.getModuloZ()));
seriesMetadata.put("sizeC", makeDimension(reader.getSizeC(), reader.getEffectiveSizeC(), reader.getModuloC()));
final int sizeT = reader.getSizeT();
seriesMetadata.put("sizeT", makeDimension(sizeT, sizeT, reader.getModuloT()));
seriesMetadata.put("tileSize", makeRectangle(reader.getOptimalTileWidth(), reader.getOptimalTileHeight()));
seriesMetadata.put("thumbnailSize", makeRectangle(reader.getThumbSizeX(), reader.getThumbSizeY()));
seriesMetadata.put("endianness", reader.isLittleEndian() ? "little" : "big");
seriesMetadata.put("dimensionOrder",
new String[] { reader.getDimensionOrder(), reader.isOrderCertain() ? "certain" : "uncertain" });
seriesMetadata.put("pixelType", FormatTools.getPixelTypeString(reader.getPixelType()));
seriesMetadata.put("validBitsPerPixel", reader.getBitsPerPixel());
seriesMetadata.put("metadataComplete", reader.isMetadataComplete());
seriesMetadata.put("thumbnailSeries", reader.isThumbnailSeries());
// plane protected static Object makeDimension(final int size, final int effSize, final Modulo modulo) {
{ final int mLength = modulo.length();
final int[] indices; if (size == effSize && mLength == 1) {
if (imageCount > 6) { return size;
int q = imageCount / 2;
indices = new int[] { 0, q - 2, q - 1, q, q + 1, q + 2, imageCount - 1 };
} else if (imageCount > 2) {
indices = new int[] { 0, imageCount / 2, imageCount - 1 };
} else if (imageCount > 1) {
indices = new int[] { 0, 1 };
} else {
indices = new int[] { 0 };
} }
final int[][] zct = new int[indices.length][]; final List<Object> ret = new ArrayList<Object>();
final int[] indices2 = new int[indices.length]; ret.add(size);
for (int i = 0; i < indices.length; i++) { if (size != effSize) {
zct[i] = reader.getZCTCoords(indices[i]); ret.add(String.format("(effectively %d)", effSize));
indices2[i] = reader.getIndex(zct[i][0], zct[i][1], zct[i][2]);
final Map<String, Object> planeMetadata = new LinkedHashMap<String, Object>();
planeMetadata.put("Z", zct[i][0]);
planeMetadata.put("C", zct[i][1]);
planeMetadata.put("T", zct[i][2]);
if (indices[i] != indices2[i]) {
planeMetadata.put("[mismatch]", indices2[i]);
}
seriesMetadata.put(String.format("plane[%d]", indices[i]), planeMetadata);
} }
} if (mLength != 1) {
metadata.put(String.format("series[%d]", j), seriesMetadata); ret.add(String.format("(%d %s x %d %s)", size / mLength, modulo.parentType, mLength, modulo.type));
}
return metadata;
}
protected static Map<String, Object> readAnnotations(final IFormatReader reader) {
final Map<String, Object> metadata = new LinkedHashMap<String, Object>();
// global metadata
final Hashtable<String, Object> globalMetadata = reader.getGlobalMetadata();
for (String key : MetadataTools.keys(globalMetadata)) {
metadata.put(key, globalMetadata.get(key));
}
// original metadata
final int seriesCount = reader.getSeriesCount();
for (int j = 0; j < seriesCount; j++) {
reader.setSeries(j);
final Hashtable<String, Object> seriesMagedata = reader.getSeriesMetadata();
if (!seriesMagedata.isEmpty()) {
final Map<String, Object> seriesMetadata = new LinkedHashMap<String, Object>();
final String[] keys = MetadataTools.keys(seriesMagedata);
for (int i = 0; i < keys.length; i++) {
seriesMetadata.put(keys[i], seriesMagedata.get(keys[i]));
} }
metadata.put(String.format("series[%d]", j), seriesMetadata);
} return ret;
} }
return metadata; protected static Map<String, Object> makeRectangle(final int width, final int height) {
} final Map<String, Object> ret = new LinkedHashMap<String, Object>();
ret.put("width", width);
ret.put("height", height);
protected static Object makeDimension(final int size, final int effSize, final Modulo modulo) { return ret;
final int mLength = modulo.length();
if (size == effSize && mLength == 1) {
return size;
}
final List<Object> ret = new ArrayList<Object>();
ret.add(size);
if (size != effSize) {
ret.add(String.format("(effectively %d)", effSize));
}
if (mLength != 1) {
ret.add(String.format("(%d %s x %d %s)", size / mLength, modulo.parentType, mLength, modulo.type));
} }
return ret; protected static String getJsonString(final Map<String, Object> map) {
} final ObjectMapper mapper = new ObjectMapper();
String json = null;
protected static Map<String, Object> makeRectangle(final int width, final int height) {
final Map<String, Object> ret = new LinkedHashMap<String, Object>();
ret.put("width", width);
ret.put("height", height);
return ret;
}
protected static String getJsonString(final Map<String, Object> map) {
final ObjectMapper mapper = new ObjectMapper();
String json = null;
try {
// json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(map);
json = mapper.writeValueAsString(map);
} catch (final Throwable e) {
// return "null" if conversion error occured
json = "null";
}
return json;
}
public static String readMetadata(final String path, final Map<String, Object> metadata)
throws BioFormatsImageException {
if (FilenameUtils.getExtension(path).toLowerCase().equals("zip")) {
// ignore if file is zip archive
throw new BioFormatsImageException("Zip is not supported");
}
String format = "";
final ImageInfo info = new ImageInfo();
final IFormatReader reader = new ImageReader();
try {
// info.parseArgs(new String[] { path, "-nopix", "-noflat", "-omexml" });
info.parseArgs(new String[] { path, "-nopix", "-noflat" });
info.setReader(reader);
info.mapLocation();
info.configureReaderPreInit();
// initialize reader
reader.setId(path);
format = reader.getFormat();
info.configureReaderPostInit();
info.checkWarnings();
// info.printOMEXML();
// info.readCoreMetadata();
metadata.put("images", readImages(reader));
info.initPreMinMaxValues();
reader.setSeries(0);
reader.setResolution(0);
// info.printGlobalMetadata();
// info.printOriginalMetadata();
final Map<String, Object> annotations = readAnnotations(reader);
if (!annotations.isEmpty()) {
metadata.put("annotations", annotations);
}
} catch (final Throwable e) {
throw new BioFormatsImageException(e);
} finally {
if (reader != null) {
try { try {
reader.close(); // json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(map);
} catch (final IOException e) { json = mapper.writeValueAsString(map);
throw new BioFormatsImageException(e); } catch (final Throwable e) {
// return "null" if conversion error occurred
json = "null";
} }
}
return json;
} }
return format; public static String readMetadata(final String path, final Map<String, Object> metadata)
} throws BioFormatsImageException {
if (FilenameUtils.getExtension(path).toLowerCase().equals("zip")) {
// ignore if file is zip archive
throw new BioFormatsImageException("Zip is not supported");
}
String format = "";
final ImageInfo info = new ImageInfo();
final IFormatReader reader = new ImageReader();
try {
// info.parseArgs(new String[] { path, "-nopix", "-noflat", "-omexml" });
info.parseArgs(new String[] { path, "-nopix", "-noflat" });
info.setReader(reader);
info.mapLocation();
info.configureReaderPreInit();
// -- Main method -- // initialize reader
public static void main(final String[] args) { reader.setId(path);
boolean status = true; format = reader.getFormat();
String message = ""; info.configureReaderPostInit();
String format = ""; info.checkWarnings();
final Map<String, Object> metadata = new LinkedHashMap<String, Object>(); // info.printOMEXML();
final Map<String, Object> thumbnail = new LinkedHashMap<String, Object>(); // info.readCoreMetadata();
if (args.length != 1) { metadata.put("images", readImages(reader));
status = false; info.initPreMinMaxValues();
message = "filename argument required"; reader.setSeries(0);
} else { reader.setResolution(0);
final String path = args[0]; // info.printGlobalMetadata();
try { // info.printOriginalMetadata();
DebugTools.enableLogging("ERROR"); final Map<String, Object> annotations = readAnnotations(reader);
format = readMetadata(path, metadata); if (!annotations.isEmpty()) {
BioFormatsImageThumbnail.readThumbnail(path, thumbnail); metadata.put("annotations", annotations);
} catch (BioFormatsImageException e) { }
status = false; } catch (final Throwable e) {
message = e.getMessage(); throw new BioFormatsImageException(e);
metadata.clear(); } finally {
thumbnail.clear(); if (reader != null) {
} try {
reader.close();
} catch (final IOException e) {
throw new BioFormatsImageException(e);
}
}
}
return format;
} }
final Map<String, Object> results = new LinkedHashMap<String, Object>(); // -- Main method --
results.put("status", status); public static void main(final String[] args) {
results.put("message", message); boolean status = true;
results.put("format", format); String message = "";
results.put("thumbnail", thumbnail.isEmpty() ? null : thumbnail); String format = "";
results.put("metadata", metadata.isEmpty() ? null : metadata); final Map<String, Object> metadata = new LinkedHashMap<String, Object>();
System.out.println(getJsonString(results)); final Map<String, Object> thumbnail = new LinkedHashMap<String, Object>();
if (args.length != 1) {
status = false;
message = "filename argument required";
} else {
final String path = args[0];
try {
DebugTools.enableLogging("OFF");
format = readMetadata(path, metadata);
BioFormatsImageThumbnail.readThumbnail(path, thumbnail);
} catch (Throwable t) {
status = false;
message = t.getMessage();
metadata.clear();
thumbnail.clear();
}
}
if (!status) { final Map<String, Object> results = new LinkedHashMap<String, Object>();
System.exit(1); results.put("status", status);
results.put("message", message);
results.put("format", format);
results.put("metadata", metadata.isEmpty() ? null : metadata);
results.put("thumbnail", thumbnail.isEmpty() ? null : thumbnail);
System.out.println(getJsonString(results));
if (!status) {
System.exit(1);
}
} }
}
} }

View File

@ -4,7 +4,6 @@ import java.awt.Color;
import java.awt.Graphics2D; import java.awt.Graphics2D;
import java.awt.Image; import java.awt.Image;
import java.awt.image.BufferedImage; import java.awt.image.BufferedImage;
import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream; import java.io.ByteArrayOutputStream;
import java.io.File; import java.io.File;
import java.io.FileOutputStream; import java.io.FileOutputStream;
@ -23,15 +22,16 @@ import javax.imageio.stream.ImageOutputStream;
import loci.common.DebugTools; import loci.common.DebugTools;
import loci.formats.FormatException; import loci.formats.FormatException;
import loci.formats.ImageReader; import loci.formats.ImageReader;
import loci.formats.gui.AWTImageTools;
import loci.formats.gui.BufferedImageReader; import loci.formats.gui.BufferedImageReader;
public class BioFormatsImageThumbnail { public class BioFormatsImageThumbnail {
protected static final float JPEG_QUORITY = 0.85f; protected static final float JPEG_QUALITY = 0.85f;
protected static final int BACKGROUND_COLOR = 0x000000; protected static final int BACKGROUND_COLOR = 0x000000;
protected static final double MAXIMUM_SCALE = 2.0; protected static final double MAXIMUM_SCALE = 2.0;
protected static BufferedImage resize(final BufferedImage image, final int width, final int height) { public static BufferedImage resize(final BufferedImage image, final int width, final int height) {
final boolean hasAlpha = image.getColorModel().hasAlpha(); final boolean hasAlpha = image.getColorModel().hasAlpha();
final int imageWidth = image.getWidth(); final int imageWidth = image.getWidth();
final int imageHeight = image.getHeight(); final int imageHeight = image.getHeight();
@ -39,14 +39,14 @@ public class BioFormatsImageThumbnail {
final double scaleHeight = (double) height / (double) imageHeight; final double scaleHeight = (double) height / (double) imageHeight;
double scale = Math.min(scaleWidth, scaleHeight); double scale = Math.min(scaleWidth, scaleHeight);
if (scale > MAXIMUM_SCALE) { if (scale > MAXIMUM_SCALE) {
// limit scalling size to maximum scale // limit scaling size to maximum scale
scale = MAXIMUM_SCALE; scale = MAXIMUM_SCALE;
} }
int resizeWidth = imageWidth; int resizeWidth = imageWidth;
int resizeHeight = imageHeight; int resizeHeight = imageHeight;
Image resizeImage = image; Image resizeImage = image;
if (scale != 1.0) { if (scale != 1.0) {
// resize image if dimension is larger than maximum dimention. // resize image if dimension is different with requested dimension.
resizeWidth = (int) (scale * (double) imageWidth); resizeWidth = (int) (scale * (double) imageWidth);
resizeHeight = (int) (scale * (double) imageHeight); resizeHeight = (int) (scale * (double) imageHeight);
resizeImage = image.getScaledInstance(resizeWidth, resizeHeight, Image.SCALE_AREA_AVERAGING); resizeImage = image.getScaledInstance(resizeWidth, resizeHeight, Image.SCALE_AREA_AVERAGING);
@ -86,16 +86,18 @@ public class BioFormatsImageThumbnail {
protected static byte[] getJpegByteArray(final BufferedImage image, final float quality, final int matColor) protected static byte[] getJpegByteArray(final BufferedImage image, final float quality, final int matColor)
throws BioFormatsImageException { throws BioFormatsImageException {
byte[] ret = null; byte[] ret = null;
try (final ByteArrayOutputStream baos = new ByteArrayOutputStream(); try (final ByteArrayOutputStream bos = new ByteArrayOutputStream();
final ImageOutputStream ios = ImageIO.createImageOutputStream(baos);) { final ImageOutputStream ios = ImageIO.createImageOutputStream(bos);) {
final ImageWriter writer = ImageIO.getImageWritersByFormatName("jpeg").next(); final ImageWriter writer = ImageIO.getImageWritersByFormatName("jpeg").next();
final ImageWriteParam param = writer.getDefaultWriteParam(); final ImageWriteParam param = writer.getDefaultWriteParam();
param.setCompressionMode(ImageWriteParam.MODE_EXPLICIT); if (param.canWriteCompressed()) {
param.setCompressionQuality(quality); param.setCompressionMode(ImageWriteParam.MODE_EXPLICIT);
param.setCompressionQuality(quality);
}
writer.setOutput(ios); writer.setOutput(ios);
writer.write(null, new IIOImage(removeAlphaChannel(image, matColor), null, null), param); writer.write(null, new IIOImage(removeAlphaChannel(image, matColor), null, null), param);
writer.dispose(); writer.dispose();
ret = baos.toByteArray(); ret = bos.toByteArray();
} catch (final IOException e) { } catch (final IOException e) {
throw new BioFormatsImageException(e); throw new BioFormatsImageException(e);
} }
@ -105,13 +107,18 @@ public class BioFormatsImageThumbnail {
protected static byte[] getPngByteArray(final BufferedImage image) throws BioFormatsImageException { protected static byte[] getPngByteArray(final BufferedImage image) throws BioFormatsImageException {
byte[] ret = null; byte[] ret = null;
try (ByteArrayOutputStream baos = new ByteArrayOutputStream(); try (final ByteArrayOutputStream bos = new ByteArrayOutputStream();
BufferedOutputStream bos = new BufferedOutputStream(baos);) { final ImageOutputStream ios = ImageIO.createImageOutputStream(bos);) {
image.flush(); final ImageWriter writer = ImageIO.getImageWritersByFormatName("png").next();
ImageIO.write(image, "png", bos); final ImageWriteParam param = writer.getDefaultWriteParam();
bos.flush(); if (param.canWriteCompressed()) {
bos.close(); param.setCompressionMode(ImageWriteParam.MODE_EXPLICIT);
ret = baos.toByteArray(); param.setCompressionQuality(0.0f);
}
writer.setOutput(ios);
writer.write(null, new IIOImage(image, null, null), param);
writer.dispose();
ret = bos.toByteArray();
} catch (final IOException e) { } catch (final IOException e) {
throw new BioFormatsImageException(e); throw new BioFormatsImageException(e);
} }
@ -126,11 +133,14 @@ public class BioFormatsImageThumbnail {
bytes = getPngByteArray(image); bytes = getPngByteArray(image);
break; break;
case "image/jpeg": case "image/jpeg":
bytes = getJpegByteArray(image, JPEG_QUORITY, BACKGROUND_COLOR); bytes = getJpegByteArray(image, JPEG_QUALITY, BACKGROUND_COLOR);
break; break;
default: default:
throw new BioFormatsImageException("Unsupported image format: " + mimeType); throw new BioFormatsImageException("Unsupported image format: " + mimeType);
} }
if (bytes.length == 0) {
throw new BioFormatsImageException("Failed to convert to " + mimeType + " format");
}
final String dataUri = "data:" + mimeType + ";base64," + Base64.getEncoder().encodeToString(bytes); final String dataUri = "data:" + mimeType + ";base64," + Base64.getEncoder().encodeToString(bytes);
return dataUri; return dataUri;
@ -147,22 +157,42 @@ public class BioFormatsImageThumbnail {
reader.setId(path); reader.setId(path);
} catch (FormatException | IOException e) { } catch (FormatException | IOException e) {
throw new BioFormatsImageException("unsupported file: " + path); throw new BioFormatsImageException("unsupported file: " + path);
} catch (Throwable t) {
throw new BioFormatsImageException(t);
} }
try { try {
final int series = 0; int series = 0;
final int no = 0; final int seriesCount = reader.getSeriesCount();
// System.out.println("series count: " + reader.getSeriesCount()); for (int i = 0; i < seriesCount; i++) {
reader.setSeries(i);
if (reader.isThumbnailSeries()) {
series = i;
break;
}
}
reader.setSeries(series);
final int z = reader.getSizeZ() / 2; // middle of slices
final int t = reader.getSizeT() / 2; // middle of frames
final int c = 0; // first channel
final int no = reader.getIndex(z, c, t);
// System.out.println("series count: " + seriesCount);
// System.out.println("image count: " + reader.getImageCount()); // System.out.println("image count: " + reader.getImageCount());
// System.out.println("resolution: " + reader.getResolutionCount()); // System.out.println("resolution: " + reader.getResolutionCount());
reader.setSeries(series); // System.out.println("thumbnail series: " + series);
ret = reader.openThumbImage(no); ret = reader.openThumbImage(no);
} catch (final Throwable e) { final boolean is16bit = reader.getBitsPerPixel() > 8;
for (Throwable t = e; t != null; t = t.getCause()) { final boolean isGrayScale = ret.getSampleModel().getNumBands() == 1;
if (t instanceof OutOfMemoryError) { if (is16bit || isGrayScale) {
// perform auto scaling if 16bit or gray scale thumbnail image.
ret = AWTImageTools.autoscale(ret);
}
} catch (final Throwable t) {
for (Throwable e = t; e != null; e = e.getCause()) {
if (e instanceof OutOfMemoryError) {
throw new BioFormatsImageException("out of memory"); throw new BioFormatsImageException("out of memory");
} }
} }
throw new BioFormatsImageException(e); throw new BioFormatsImageException(t);
} finally { } finally {
try { try {
reader.close(); reader.close();
@ -213,7 +243,7 @@ public class BioFormatsImageThumbnail {
thumbnail.put("height", height); thumbnail.put("height", height);
thumbnail.put("mimeType", mimeType); thumbnail.put("mimeType", mimeType);
thumbnail.put("url", dataUri); thumbnail.put("url", dataUri);
} catch (final BioFormatsImageException e) { } catch (final Throwable t) {
// ignore // ignore
ret = false; ret = false;
} }
@ -221,22 +251,23 @@ public class BioFormatsImageThumbnail {
return ret; return ret;
} }
public static void main(final String[] args) throws BioFormatsImageException { public static void main(final String[] args) {
if (args.length != 1) { if (args.length != 1) {
System.out.println("filename argument required"); System.out.println("filename argument required");
System.exit(1); System.exit(1);
} }
final String path = args[0]; final String path = args[0];
try { try {
DebugTools.enableLogging("ERROR"); DebugTools.enableLogging("OFF");
BufferedImage image = getImageFromBioFormatsFile(path); BufferedImage image = getImageFromBioFormatsFile(path);
final String format = image.getColorModel().hasAlpha() ? "png" : "jpeg"; final String format = image.getColorModel().hasAlpha() ? "png" : "jpeg";
// image = resize(image, 160, 160); // image = resize(image, 160, 160);
final String dataUri = getDataUri(image, "image/" + format); final String dataUri = getDataUri(image, "image/" + format);
// System.out.println(dataUri); System.out.println(dataUri);
saveFile(dataUri, "/var/tmp/thumbnail." + format); // saveFile(dataUri, "/var/tmp/thumbnail." + format);
} catch (final BioFormatsImageException e) { } catch (final Throwable t) {
System.out.println(e.getMessage()); // t.printStackTrace();
System.out.println(t.getMessage());
System.exit(1); System.exit(1);
} }
} }