All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.jmatio.io.MatFileIncrementalWriter Maven / Gradle / Ivy

Go to download

MatFileRW - Read and write .mat files

There is a newer version: 3.1.1
Show newest version
/*
 * Code licensed under new-style BSD (see LICENSE).
 * All code up to tags/original: Copyright (c) 2006, Wojciech Gradkowski
 * All code after tags/original: Copyright (c) 2015, DiffPlug
 */
package com.jmatio.io;

import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.WritableByteChannel;
import java.util.Collection;
import java.util.Set;
import java.util.TreeSet;
import java.util.zip.DataFormatException;
import java.util.zip.Deflater;
import java.util.zip.DeflaterOutputStream;

import com.jmatio.common.MatDataTypes;
import com.jmatio.types.MLArray;
import com.jmatio.types.MLCell;
import com.jmatio.types.MLChar;
import com.jmatio.types.MLNumericArray;
import com.jmatio.types.MLSparse;
import com.jmatio.types.MLStructure;

/**
 * MAT-file Incremental writer.
 * 
 * An updated writer which allows adding variables incrementally
 * for the life of the writer.  This is necessary to allow large
 * variables to be written without having to hold onto then longer
 * than is necessary.
 * 
 * The writer internally maintains a list of the variable names
 * it has written so far, and will throw an exception if the same
 * variable name is submitted more than once to the same reader.
 * 
 * Usage:
 * 

 * //1. First create example arrays
 * double[] src = new double[] { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 };
 * MLDouble mlDouble = new MLDouble( "double_arr", src, 3 );
 * MLChar mlChar = new MLChar( "char_arr", "I am dummy" );
 *         
 * //2. write arrays to file
 * MatFileIncrementalWriter writer = new MatFileIncrementalWriter( new File("mat_file.mat"));
 * writer.write(mlDouble);
 * writer.write(mlChar);
 * 
 * writer.close();
 * 
 * 

 * 
 * this is "equal" to Matlab commands:
 * 

 * >> double_arr = [ 1 2; 3 4; 5 6];
 * >> char_arr = 'I am dummy';
 * >>
 * >> save('mat_file.mat', 'double_arr');
 * >> save('mat_file.mat', 'char_arr', '-append');
 * 

 * 
 * @author 
 */
public class MatFileIncrementalWriter {
	//    private static final Logger logger = Logger.getLogger(MatFileWriter.class);
	private WritableByteChannel channel = null;

	private boolean headerWritten = false;
	private Set varNames = new TreeSet();

	/**
	 * Creates a writer to a file given the filename.
	 * 
	 * @param fileName - name of ouput file
	 * @throws IOException
	 * @throws DataFormatException
	 */
	public MatFileIncrementalWriter(String fileName) throws IOException {
		this(new File(fileName));
	}

	/**
	 * Creats a writer to a file given the File object.
	 * 
	 * @param file - an output File
	 * @throws IOException
	 * @throws DataFormatException
	 */
	@SuppressWarnings("resource") // the channel is closed when you call close()
	public MatFileIncrementalWriter(File file) throws IOException {
		this((new FileOutputStream(file)).getChannel());
	}

	/**
	 * Creates a writer for a file, given an output channel to the file..
	 * 
	 * Writes MAT-file header and compressed data (miCOMPRESSED).
	 * 
	 * @param chan - WritableByteChannel
	 * @param data - Collection of MLArray elements
	 * @throws IOException
	 */
	public MatFileIncrementalWriter(WritableByteChannel chan) throws IOException {
		this.channel = chan;
	}

	public synchronized void write(MLArray data)
			throws IOException {
		String vName = data.getName();
		if (varNames.contains(vName)) {
			throw new IllegalArgumentException("Error: variable " + vName + " specified more than once for file input.");
		}
		try {
			//write the header, but only once.
			if (!headerWritten) {
				writeHeader(channel);
			}

			//prepare buffer for MATRIX data
			ByteArrayOutputStream baos = new ByteArrayOutputStream();
			DataOutputStream dos = new DataOutputStream(baos);
			//write MATRIX bytes into buffer
			writeMatrix(dos, data);

			//compress data to save storage
			Deflater compresser = new Deflater();

			byte[] input = baos.toByteArray();

			ByteArrayOutputStream compressed = new ByteArrayOutputStream();
			DataOutputStream dout = new DataOutputStream(new DeflaterOutputStream(compressed, compresser));

			dout.write(input);

			dout.close();
			compressed.close();

			//write COMPRESSED tag and compressed data into output channel
			byte[] compressedBytes = compressed.toByteArray();
			ByteBuffer buf = ByteBuffer.allocateDirect(2 * 4 /* Int size */ + compressedBytes.length);
			buf.putInt(MatDataTypes.miCOMPRESSED);
			buf.putInt(compressedBytes.length);
			buf.put(compressedBytes);

			buf.flip();
			channel.write(buf);
		} catch (IOException e) {
			throw e;
		} finally {}
	}

	/**
	 * Writes MLArrays into WritableByteChannel.
	 * 
	 * @param channel
	 *            the channel to write to
	 * @param data
	 *            the collection of {@link MLArray} objects
	 * @throws IOException
	 *             if writing fails
	 */
	public synchronized void write(Collection data) throws IOException {
		try {

			//write data
			for (MLArray matrix : data) {
				write(matrix);
			}
		} catch (IllegalArgumentException iae) {
			throw iae;
		} catch (IOException e) {
			throw e;
		}
	}

	public synchronized void close() throws IOException {
		channel.close();
	}

	/**
	 * Writes MAT-file header into OutputStream
	 * @param os OutputStream
	 * @throws IOException
	 */
	private void writeHeader(WritableByteChannel channel) throws IOException {
		//write descriptive text
		MatFileHeader header = MatFileHeader.createHeader();
		char[] dest = new char[116];
		char[] src = header.getDescription().toCharArray();
		System.arraycopy(src, 0, dest, 0, src.length);

		byte[] endianIndicator = header.getEndianIndicator();

		ByteBuffer buf = ByteBuffer.allocateDirect(dest.length * 2 /* Char size */ + 2 + endianIndicator.length);

		for (int i = 0; i < dest.length; i++) {
			buf.put((byte) dest[i]);
		}
		//write subsyst data offset
		buf.position(buf.position() + 8);

		//write version
		int version = header.getVersion();
		buf.put((byte) (version >> 8));
		buf.put((byte) version);

		buf.put(endianIndicator);

		buf.flip();
		channel.write(buf);

		headerWritten = true;
	}

	/**
	 * Writes MATRIX into OutputStream.
	 * 
	 * @param os - OutputStream
	 * @param array - a MLArray
	 * @throws IOException
	 */
	private void writeMatrix(DataOutputStream output, MLArray array) throws IOException {
		OSArrayTag tag;
		ByteArrayOutputStream buffer;
		DataOutputStream bufferDOS;
		ByteArrayOutputStream baos = new ByteArrayOutputStream();
		DataOutputStream dos = new DataOutputStream(baos);

		//flags
		writeFlags(dos, array);

		//dimensions
		writeDimensions(dos, array);

		//array name
		writeName(dos, array);

		switch (array.getType()) {
		case MLArray.mxCHAR_CLASS:
			//write char data
			buffer = new ByteArrayOutputStream();
			bufferDOS = new DataOutputStream(buffer);
			Character[] ac = ((MLChar) array).exportChar();
			for (int i = 0; i < ac.length; i++) {
				bufferDOS.writeByte((byte) ac[i].charValue());
			}
			tag = new OSArrayTag(MatDataTypes.miUTF8, buffer.toByteArray());
			tag.writeTo(dos);

			break;
		case MLArray.mxDOUBLE_CLASS:

			tag = new OSArrayTag(MatDataTypes.miDOUBLE,
					((MLNumericArray) array).getRealByteBuffer());
			tag.writeTo(dos);

			//write real imaginary
			if (array.isComplex()) {
				tag = new OSArrayTag(MatDataTypes.miDOUBLE,
						((MLNumericArray) array).getImaginaryByteBuffer());
				tag.writeTo(dos);
			}
			break;
		case MLArray.mxUINT8_CLASS:

			tag = new OSArrayTag(MatDataTypes.miUINT8,
					((MLNumericArray) array).getRealByteBuffer());
			tag.writeTo(dos);

			//write real imaginary
			if (array.isComplex()) {
				tag = new OSArrayTag(MatDataTypes.miUINT8,
						((MLNumericArray) array).getImaginaryByteBuffer());
				tag.writeTo(dos);
			}
			break;
		case MLArray.mxINT8_CLASS:

			tag = new OSArrayTag(MatDataTypes.miINT8,
					((MLNumericArray) array).getRealByteBuffer());
			tag.writeTo(dos);

			//write real imaginary
			if (array.isComplex()) {
				tag = new OSArrayTag(MatDataTypes.miINT8,
						((MLNumericArray) array).getImaginaryByteBuffer());
				tag.writeTo(dos);
			}
			break;
		case MLArray.mxINT16_CLASS:

			tag = new OSArrayTag(MatDataTypes.miINT16,
					((MLNumericArray) array).getRealByteBuffer());
			tag.writeTo(dos);

			//write real imaginary
			if (array.isComplex()) {
				tag = new OSArrayTag(MatDataTypes.miINT16,
						((MLNumericArray) array).getImaginaryByteBuffer());
				tag.writeTo(dos);
			}
			break;
		case MLArray.mxINT64_CLASS:

			tag = new OSArrayTag(MatDataTypes.miINT64,
					((MLNumericArray) array).getRealByteBuffer());
			tag.writeTo(dos);

			//write real imaginary
			if (array.isComplex()) {
				tag = new OSArrayTag(MatDataTypes.miINT64,
						((MLNumericArray) array).getImaginaryByteBuffer());
				tag.writeTo(dos);
			}
			break;
		case MLArray.mxUINT64_CLASS:

			tag = new OSArrayTag(MatDataTypes.miUINT64,
					((MLNumericArray) array).getRealByteBuffer());
			tag.writeTo(dos);

			//write real imaginary
			if (array.isComplex()) {
				tag = new OSArrayTag(MatDataTypes.miUINT64,
						((MLNumericArray) array).getImaginaryByteBuffer());
				tag.writeTo(dos);
			}
			break;
		case MLArray.mxSTRUCT_CLASS:
			//field name length
			int itag = 4 << 16 | MatDataTypes.miINT32 & 0xffff;
			dos.writeInt(itag);
			dos.writeInt(((MLStructure) array).getMaxFieldLenth());

			//get field names
			tag = new OSArrayTag(MatDataTypes.miINT8, ((MLStructure) array).getKeySetToByteArray());
			tag.writeTo(dos);

			for (MLArray a : ((MLStructure) array).getAllFields()) {
				writeMatrix(dos, a);
			}
			break;
		case MLArray.mxCELL_CLASS:
			for (MLArray a : ((MLCell) array).cells()) {
				writeMatrix(dos, a);
			}
			break;
		case MLArray.mxSPARSE_CLASS:
			int[] ai;
			//write ir
			buffer = new ByteArrayOutputStream();
			bufferDOS = new DataOutputStream(buffer);
			ai = ((MLSparse) array).getIR();
			for (int i : ai) {
				bufferDOS.writeInt(i);
			}
			tag = new OSArrayTag(MatDataTypes.miINT32, buffer.toByteArray());
			tag.writeTo(dos);
			//write jc
			buffer = new ByteArrayOutputStream();
			bufferDOS = new DataOutputStream(buffer);
			ai = ((MLSparse) array).getJC();
			for (int i : ai) {
				bufferDOS.writeInt(i);
			}
			tag = new OSArrayTag(MatDataTypes.miINT32, buffer.toByteArray());
			tag.writeTo(dos);
			//write real
			buffer = new ByteArrayOutputStream();
			bufferDOS = new DataOutputStream(buffer);

			Double[] ad = ((MLSparse) array).exportReal();

			for (int i = 0; i < ad.length; i++) {
				bufferDOS.writeDouble(ad[i].doubleValue());
			}

			tag = new OSArrayTag(MatDataTypes.miDOUBLE, buffer.toByteArray());
			tag.writeTo(dos);
			//write real imaginary
			if (array.isComplex()) {
				buffer = new ByteArrayOutputStream();
				bufferDOS = new DataOutputStream(buffer);
				ad = ((MLSparse) array).exportImaginary();
				for (int i = 0; i < ad.length; i++) {
					bufferDOS.writeDouble(ad[i].doubleValue());
				}
				tag = new OSArrayTag(MatDataTypes.miDOUBLE, buffer.toByteArray());
				tag.writeTo(dos);
			}
			break;
		default:
			throw new MatlabIOException("Cannot write matrix of type: " + MLArray.typeToString(array.getType()));

		}

		//write matrix
		output.writeInt(MatDataTypes.miMATRIX); //matrix tag
		output.writeInt(baos.size()); //size of matrix
		output.write(baos.toByteArray()); //matrix data
	}

	/**
	 * Writes MATRIX flags into OutputStream.
	 * 
	 * @param os - OutputStream
	 * @param array - a MLArray
	 * @throws IOException
	 */
	private void writeFlags(DataOutputStream os, MLArray array) throws IOException {
		ByteArrayOutputStream buffer = new ByteArrayOutputStream();
		DataOutputStream bufferDOS = new DataOutputStream(buffer);

		bufferDOS.writeInt(array.getFlags());

		if (array.isSparse()) {
			bufferDOS.writeInt(((MLSparse) array).getMaxNZ());
		} else {
			bufferDOS.writeInt(0);
		}
		OSArrayTag tag = new OSArrayTag(MatDataTypes.miUINT32, buffer.toByteArray());
		tag.writeTo(os);

	}

	/**
	 * Writes MATRIX dimensions into OutputStream.
	 * 
	 * @param os - OutputStream
	 * @param array - a MLArray
	 * @throws IOException
	 */
	private void writeDimensions(DataOutputStream os, MLArray array) throws IOException {
		ByteArrayOutputStream buffer = new ByteArrayOutputStream();
		DataOutputStream bufferDOS = new DataOutputStream(buffer);

		int[] dims = array.getDimensions();
		for (int i = 0; i < dims.length; i++) {
			bufferDOS.writeInt(dims[i]);
		}
		OSArrayTag tag = new OSArrayTag(MatDataTypes.miINT32, buffer.toByteArray());
		tag.writeTo(os);

	}

	/**
	 * Writes MATRIX name into OutputStream.
	 * 
	 * @param os - OutputStream
	 * @param array - a MLArray
	 * @throws IOException
	 */
	private void writeName(DataOutputStream os, MLArray array) throws IOException {
		ByteArrayOutputStream buffer = new ByteArrayOutputStream();
		DataOutputStream bufferDOS = new DataOutputStream(buffer);
		byte[] nameByteArray = array.getNameToByteArray();
		bufferDOS.write(nameByteArray);
		OSArrayTag tag = new OSArrayTag(MatDataTypes.miINT8, buffer.toByteArray());
		tag.writeTo(os);
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy