Compare commits

..

No commits in common. "master" and "v1.1.2" have entirely different histories.

7 changed files with 65 additions and 190 deletions

View File

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

18
.vscode/settings.json vendored
View File

@ -1,18 +0,0 @@
{
"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,40 +1,27 @@
# 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 "[OPTION]" "[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.2.4.jar "[OPTION]" "[path to image file]" java -jar ./target/dist/lib/bioformats-imageinfo-1.1.2.jar "[path to image file]"
``` ```
### run by fat jar ### run by fat jar
```shell ```shell
java -jar ./target/bioformats-imageinfo-1.2.4-jar-with-dependencies.jar "[OPTION]" "[path to image file]" java -jar ./target/bioformats-imageinfo-1.1.2-jar-with-dependencies.jar "[path to image file]"
``` ```
### OPTION ### library usage
```shell
-M output metadata
-T output thumbnail
```
## library usage
```java ```java
import java.util.LinkedHashMap; import java.util.LinkedHashMap;
import java.util.Map; import java.util.Map;

98
pom.xml
View File

@ -1,17 +1,15 @@
<?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" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
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">
<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.2.4</version> <version>1.1.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>7.3.0</bio-formats.version> <bio-formats.version>6.10.1</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,39 +25,14 @@
<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.5.0</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.6.1</version> <version>3.3.0</version>
<executions> <executions>
<execution> <execution>
<id>copy-dependencies</id> <id>copy-dependencies</id>
@ -76,7 +49,7 @@
<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.4.1</version> <version>3.2.2</version>
<configuration> <configuration>
<archive> <archive>
<manifest> <manifest>
@ -86,10 +59,34 @@
</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>2.1.0</version> <version>1.10</version>
<configuration> <configuration>
<assembleDirectory>${project.build.directory}/dist</assembleDirectory> <assembleDirectory>${project.build.directory}/dist</assembleDirectory>
<repositoryLayout>flat</repositoryLayout> <repositoryLayout>flat</repositoryLayout>
@ -110,37 +107,10 @@
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.7.1</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>9.0.9</version> <version>7.1.1</version>
<executions> <executions>
<execution> <execution>
<goals> <goals>
@ -156,8 +126,7 @@
<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>
@ -166,8 +135,7 @@
<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

@ -1,36 +0,0 @@
<?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

@ -142,14 +142,14 @@ public class BioFormatsImageInfo {
final int seriesCount = reader.getSeriesCount(); final int seriesCount = reader.getSeriesCount();
for (int j = 0; j < seriesCount; j++) { for (int j = 0; j < seriesCount; j++) {
reader.setSeries(j); reader.setSeries(j);
final Hashtable<String, Object> seriesMetadata = reader.getSeriesMetadata(); final Hashtable<String, Object> seriesMagedata = reader.getSeriesMetadata();
if (!seriesMetadata.isEmpty()) { if (!seriesMagedata.isEmpty()) {
final Map<String, Object> originalMetadata = new LinkedHashMap<String, Object>(); final Map<String, Object> seriesMetadata = new LinkedHashMap<String, Object>();
final String[] keys = MetadataTools.keys(seriesMetadata); final String[] keys = MetadataTools.keys(seriesMagedata);
for (int i = 0; i < keys.length; i++) { for (int i = 0; i < keys.length; i++) {
originalMetadata.put(keys[i], seriesMetadata.get(keys[i])); seriesMetadata.put(keys[i], seriesMagedata.get(keys[i]));
} }
metadata.put(String.format("series[%d]", j), originalMetadata); metadata.put(String.format("series[%d]", j), seriesMetadata);
} }
} }
@ -188,7 +188,7 @@ public class BioFormatsImageInfo {
// json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(map); // json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(map);
json = mapper.writeValueAsString(map); json = mapper.writeValueAsString(map);
} catch (final Throwable e) { } catch (final Throwable e) {
// return "null" if conversion error occurred // return "null" if conversion error occured
json = "null"; json = "null";
} }
@ -248,34 +248,17 @@ public class BioFormatsImageInfo {
boolean status = true; boolean status = true;
String message = ""; String message = "";
String format = ""; String format = "";
boolean metadataON = true;
boolean thumbnailON = true;
String path = "";
final Map<String, Object> metadata = new LinkedHashMap<String, Object>(); final Map<String, Object> metadata = new LinkedHashMap<String, Object>();
final Map<String, Object> thumbnail = new LinkedHashMap<String, Object>(); final Map<String, Object> thumbnail = new LinkedHashMap<String, Object>();
if (args.length == 1) { if (args.length != 1) {
path = args[0];
} else if (args.length == 2) {
if (args[0].startsWith("-")) {
metadataON = args[0].toUpperCase().contains("M");
thumbnailON = args[0].toUpperCase().contains("T");
}
path = args[1];
} else {
status = false; status = false;
message = "invalid parameters"; message = "filename argument required";
message += "\nUsage ./target/dist/bin/bioformats-imageinfo \"[OPTION]\" \"[path to image file]\""; } else {
message += "\n-M output metadata\n-T output thumbnail"; final String path = args[0];
}
if (status) {
try { try {
DebugTools.enableLogging("OFF"); DebugTools.enableLogging("OFF");
if (metadataON) {
format = readMetadata(path, metadata); format = readMetadata(path, metadata);
}
if (thumbnailON) {
BioFormatsImageThumbnail.readThumbnail(path, thumbnail); BioFormatsImageThumbnail.readThumbnail(path, thumbnail);
}
} catch (Throwable t) { } catch (Throwable t) {
status = false; status = false;
message = t.getMessage(); message = t.getMessage();

View File

@ -27,7 +27,7 @@ import loci.formats.gui.BufferedImageReader;
public class BioFormatsImageThumbnail { public class BioFormatsImageThumbnail {
protected static final float JPEG_QUALITY = 0.85f; protected static final float JPEG_QUORITY = 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;
@ -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 scaling size to maximum scale // limit scalling 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 different with requested dimension. // resize image if dimension is different with requrested 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,8 +86,8 @@ 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 bos = new ByteArrayOutputStream(); try (final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final ImageOutputStream ios = ImageIO.createImageOutputStream(bos);) { final ImageOutputStream ios = ImageIO.createImageOutputStream(baos);) {
final ImageWriter writer = ImageIO.getImageWritersByFormatName("jpeg").next(); final ImageWriter writer = ImageIO.getImageWritersByFormatName("jpeg").next();
final ImageWriteParam param = writer.getDefaultWriteParam(); final ImageWriteParam param = writer.getDefaultWriteParam();
if (param.canWriteCompressed()) { if (param.canWriteCompressed()) {
@ -97,7 +97,7 @@ public class BioFormatsImageThumbnail {
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 = bos.toByteArray(); ret = baos.toByteArray();
} catch (final IOException e) { } catch (final IOException e) {
throw new BioFormatsImageException(e); throw new BioFormatsImageException(e);
} }
@ -107,8 +107,8 @@ 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 (final ByteArrayOutputStream bos = new ByteArrayOutputStream(); try (final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final ImageOutputStream ios = ImageIO.createImageOutputStream(bos);) { final ImageOutputStream ios = ImageIO.createImageOutputStream(baos);) {
final ImageWriter writer = ImageIO.getImageWritersByFormatName("png").next(); final ImageWriter writer = ImageIO.getImageWritersByFormatName("png").next();
final ImageWriteParam param = writer.getDefaultWriteParam(); final ImageWriteParam param = writer.getDefaultWriteParam();
if (param.canWriteCompressed()) { if (param.canWriteCompressed()) {
@ -118,7 +118,7 @@ public class BioFormatsImageThumbnail {
writer.setOutput(ios); writer.setOutput(ios);
writer.write(null, new IIOImage(image, null, null), param); writer.write(null, new IIOImage(image, null, null), param);
writer.dispose(); writer.dispose();
ret = bos.toByteArray(); ret = baos.toByteArray();
} catch (final IOException e) { } catch (final IOException e) {
throw new BioFormatsImageException(e); throw new BioFormatsImageException(e);
} }
@ -133,7 +133,7 @@ public class BioFormatsImageThumbnail {
bytes = getPngByteArray(image); bytes = getPngByteArray(image);
break; break;
case "image/jpeg": case "image/jpeg":
bytes = getJpegByteArray(image, JPEG_QUALITY, BACKGROUND_COLOR); bytes = getJpegByteArray(image, JPEG_QUORITY, BACKGROUND_COLOR);
break; break;
default: default:
throw new BioFormatsImageException("Unsupported image format: " + mimeType); throw new BioFormatsImageException("Unsupported image format: " + mimeType);
@ -178,12 +178,12 @@ public class BioFormatsImageThumbnail {
// System.out.println("series count: " + seriesCount); // 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());
// System.out.println("thumbnail series: " + series); // System.out.println("thubmail series: " + series);
ret = reader.openThumbImage(no); ret = reader.openThumbImage(no);
final boolean is16bit = reader.getBitsPerPixel() > 8; final boolean is16bit = reader.getBitsPerPixel() > 8;
final boolean isGrayScale = ret.getSampleModel().getNumBands() == 1; final boolean isGrayScale = ret.getSampleModel().getNumBands() == 1;
if (is16bit || isGrayScale) { if (is16bit || isGrayScale) {
// perform auto scaling if 16bit or gray scale thumbnail image. // perform auto scalling if 16bit or gray scale thumbnail image.
ret = AWTImageTools.autoscale(ret); ret = AWTImageTools.autoscale(ret);
} }
} catch (final Throwable t) { } catch (final Throwable t) {