/*
* #%L
* OME Bio-Formats package for reading and converting biological file formats.
* %%
* Copyright (C) 2005 - 2015 Open Microscopy Environment:
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* - University of Dundee
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/gpl-2.0.html>.
* #L%
*/
package loci.formats.in;
import java.io.IOException;
import loci.common.DateTools;
import loci.common.RandomAccessInputStream;
import loci.common.xml.BaseHandler;
import loci.common.xml.XMLTools;
import loci.formats.CoreMetadata;
import loci.formats.FormatException;
import loci.formats.FormatReader;
import loci.formats.FormatTools;
import loci.formats.MetadataTools;
import loci.formats.meta.MetadataStore;
import ome.xml.model.primitives.Timestamp;
import ome.units.quantity.Time;
import ome.units.UNITS;
import org.xml.sax.Attributes;
/**
* IvisionReader is the file format reader for IVision (.IPM) files.
*
* @author Melissa Linkert melissa at glencoesoftware.com
*/
public class IvisionReader extends FormatReader {
// -- Constants --
public static final String DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
// -- Fields --
private boolean color16;
private boolean squareRoot;
private byte[] lut;
private long imageOffset;
private String binX, binY;
private String creationDate;
private String exposureTime;
private String gain, offset;
private String deltaT;
private Double magnification;
private Double lensNA, refractiveIndex;
private String wavelength;
private boolean hasPaddingByte = false;
// -- Constructor --
/** Constructs a new Ivision reader. */
public IvisionReader() {
super("IVision", "ipm");
suffixSufficient = false;
suffixNecessary = false;
domains = new String[] {FormatTools.UNKNOWN_DOMAIN};
}
// -- IFormatReader API methods --
/* @see loci.formats.IFormatReader#isThisType(RandomAccessInputStream) */
@Override
public boolean isThisType(RandomAccessInputStream stream) throws IOException {
final int blockCheckLen = 4096;
if (!FormatTools.validStream(stream, blockCheckLen, true)) return false;
String version = stream.readString(3);
try {
Double.parseDouble(version);
return version.indexOf(".") != -1 && version.indexOf("-") == -1;
}
catch (NumberFormatException e) { }
return false;
}
/**
* @see loci.formats.IFormatReader#openBytes(int, byte[], int, int, int, int)
*/
@Override
public byte[] openBytes(int no, byte[] buf, int x, int y, int w, int h)
throws FormatException, IOException
{
FormatTools.checkPlaneParameters(this, no, buf.length, x, y, w, h);
int planeSize = getSizeX() * getSizeY() * getSizeC();
if (color16) planeSize = 2 * (planeSize / 3);
else if (squareRoot) planeSize *= 2;
else if (hasPaddingByte) {
planeSize += getSizeX() * getSizeY();
}
else planeSize *= FormatTools.getBytesPerPixel(getPixelType());
in.seek(imageOffset + planeSize * no);
if (color16) {
// TODO
throw new FormatException("16-bit color iVision files are not supported");
}
else if (squareRoot) {
// TODO
throw new FormatException("Square-root iVision files are not supported");
}
else if (hasPaddingByte) {
int next = 0;
in.skipBytes(y * getSizeX() * getSizeC());
for (int row=0; row<h; row++) {
in.skipBytes(x * getSizeC());
for (int col=0; col<w; col++) {
in.skipBytes(1);
in.read(buf, next, getSizeC());
next += getSizeC();
}
in.skipBytes(getSizeC() * (getSizeX() - w - x));
}
}
else readPlane(in, x, y, w, h, buf);
return buf;
}
/* @see loci.formats.IFormatReader#close(boolean) */
@Override
public void close(boolean fileOnly) throws IOException {
super.close(fileOnly);
if (!fileOnly) {
color16 = false;
squareRoot = false;
lut = null;
imageOffset = 0;
binX = binY = null;
creationDate = null;
exposureTime = null;
gain = offset = null;
deltaT = null;
magnification = null;
lensNA = refractiveIndex = null;
wavelength = null;
hasPaddingByte = false;
}
}
// -- Internal FormatReader API methods --
/* @see loci.formats.FormatReader#initFile(String) */
@Override
protected void initFile(String id) throws FormatException, IOException {
super.initFile(id);
in = new RandomAccessInputStream(id);
LOGGER.info("Populating metadata");
String version = in.readString(4);
addGlobalMeta("Version", version);
int fileFormat = in.read();
int dataType = in.read();
CoreMetadata m = core.get(0);
m.sizeC = 1;
switch (dataType) {
case 0:
m.pixelType = FormatTools.UINT8;
break;
case 1:
m.pixelType = FormatTools.INT16;
break;
case 2:
m.pixelType = FormatTools.INT32;
break;
case 3:
m.pixelType = FormatTools.FLOAT;
break;
case 4:
m.pixelType = FormatTools.UINT8;
m.sizeC = 3;
color16 = true;
break;
case 5:
m.pixelType = FormatTools.UINT8;
m.sizeC = 3;
hasPaddingByte = true;
break;
case 6:
m.pixelType = FormatTools.UINT16;
break;
case 7:
m.pixelType = FormatTools.FLOAT;
squareRoot = true;
break;
case 8:
m.pixelType = FormatTools.UINT16;
m.sizeC = 3;
break;
}
m.sizeX = in.readInt();
m.sizeY = in.readInt();
in.skipBytes(6);
m.sizeZ = in.readShort();
in.skipBytes(50);
m.sizeT = 1;
if (getSizeX() > 1 && getSizeY() > 1) {
lut = new byte[2048];
in.read(lut);
}
imageOffset = in.getFilePointer();
if (getMetadataOptions().getMetadataLevel() != MetadataLevel.MINIMUM) {
in.skipBytes(getSizeZ() * getSizeC() * getSizeT() * getSizeX() *
getSizeY() * FormatTools.getBytesPerPixel(getPixelType()));
// look for block of XML data
LOGGER.info("Looking for XML metadata");
in.findString(false, "<?xml");
if (in.getFilePointer() < in.length()) {
in.seek(in.getFilePointer() - 5);
String xml = in.readString((int) (in.length() - in.getFilePointer()));
xml = xml.substring(xml.indexOf("<"), xml.lastIndexOf("plist>") + 6);
IvisionHandler handler = new IvisionHandler();
try {
XMLTools.parseXML(xml, handler);
}
catch (IOException e) {
LOGGER.debug("", e);
}
}
else LOGGER.debug("XML metadata not found");
}
LOGGER.info("Populating core metadata");
m.rgb = getSizeC() > 1;
m.dimensionOrder = "XYCZT";
m.littleEndian = false;
m.interleaved = true;
m.indexed = false;
m.imageCount = getSizeZ() * getSizeT();
LOGGER.info("Populating MetadataStore");
MetadataStore store = makeFilterMetadata();
MetadataTools.populatePixels(store, this, true);
if (creationDate != null) {
String date = DateTools.formatDate(creationDate, DATE_FORMAT);
if (date != null) {
store.setImageAcquisitionDate(new Timestamp(date), 0);
}
}
if (getMetadataOptions().getMetadataLevel() != MetadataLevel.MINIMUM) {
String instrumentID = MetadataTools.createLSID("Instrument", 0);
store.setInstrumentID(instrumentID, 0);
store.setImageInstrumentRef(instrumentID, 0);
if (deltaT != null) {
Double increment = 0d;
try {
increment = new Double(deltaT);
}
catch (NumberFormatException e) {
LOGGER.debug("Failed to parse time increment", e);
}
if (increment != null) {
store.setPixelsTimeIncrement(new Time(increment, UNITS.S), 0);
}
}
String objectiveID = MetadataTools.createLSID("Objective", 0, 0);
store.setObjectiveID(objectiveID, 0, 0);
store.setObjectiveSettingsID(objectiveID, 0);
store.setObjectiveCorrection(getCorrection("Other"), 0, 0);
store.setObjectiveImmersion(getImmersion("Other"), 0, 0);
if (lensNA != null) store.setObjectiveLensNA(lensNA, 0, 0);
if (magnification != null) {
store.setObjectiveNominalMagnification(magnification, 0, 0);
}
if (refractiveIndex != null) {
store.setObjectiveSettingsRefractiveIndex(refractiveIndex, 0);
}
String detectorID = MetadataTools.createLSID("Detector", 0, 0);
store.setDetectorID(detectorID, 0, 0);
store.setDetectorSettingsID(detectorID, 0, 0);
store.setDetectorType(getDetectorType("Other"), 0, 0);
store.setDetectorSettingsBinning(getBinning(binX + "x" + binY), 0, 0);
if (gain != null) {
try {
store.setDetectorSettingsGain(new Double(gain), 0, 0);
}
catch (NumberFormatException e) {
LOGGER.debug("Failed to parse detector gain", e);
}
}
}
}
// -- Helper class --
class IvisionHandler extends BaseHandler {
// -- Fields --
private String key, value;
private String currentElement;
// -- DefaultHandler API methods --
@Override
public void endElement(String uri, String localName, String qName) {
addGlobalMeta(key, value);
if ("iplab:Bin_X".equals(key)) binX = value;
else if ("iplab:Bin_Y".equals(key)) binY = value;
else if ("iplab:Capture_Date".equals(key)) creationDate = value;
else if ("iplab:Exposure".equals(key)) exposureTime = value;
else if ("iplab:Gain".equals(key)) gain = value;
else if ("iplab:Offset".equals(key)) offset = value;
else if ("iplab:Interval_T".equals(key)) deltaT = value;
else if ("iplab:Objective_Mag".equals(key)) {
try {
magnification = new Double(value);
}
catch (NumberFormatException e) { }
}
else if ("iplab:Objective_NA".equals(key)) {
try {
lensNA = new Double(value);
}
catch (NumberFormatException e) { }
}
else if ("iplab:Objective_RI".equals(key)) {
try {
refractiveIndex = new Double(value);
}
catch (NumberFormatException e) { }
}
else if ("iplab:Wavelength".equals(key)) wavelength = value;
}
@Override
public void characters(char[] ch, int start, int length) {
String v = new String(ch, start, length).trim();
if (v.length() > 0) {
if ("key".equals(currentElement)) {
key = v;
}
else value = v;
}
}
@Override
public void startElement(String uri, String localName, String qName,
Attributes attributes)
{
currentElement = qName;
}
}
}