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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of matfilerw Show documentation

MatFileRW - Read and write .mat files

There is a newer version: 3.1.1

/*
 * 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.IOException;
import java.io.RandomAccessFile;
import java.nio.ByteBuffer;
import java.util.Map;

import com.jmatio.types.MLArray;

/**
 * MatFileReader's API is vague.  Do you pass a file in the constructor
 * or the read method?  It also limits your ability to partially parse
 * a section of code, such as the case where you have a MAT-file without
 * a header
 * 
 * MatFile is a value class which presents a simplified API for parsing either a
 * ByteBuffer or a RandomAccessFile.
 */
public class MatFile {
	private final MatFileHeader header;
	private final Map content;

	public MatFile(MatFileHeader header, Map content) {
		this.header = header;
		this.content = content;
	}

	public MatFileHeader getHeader() {
		return header;
	}

	public Map getContent() {
		return content;
	}

	/** Reads a bare set of bytes. */
	public static Map readBare(MatFileHeader header, ByteBuffer buffer) throws IOException {
		MatFileReader reader = new MatFileReader();
		reader.matFileHeader = header;
		buffer.order(header.getByteOrder());
		reader.readData(buffer);
		return reader.data;
	}

	/** Reads a full set of bytes (including the header). */
	public static MatFile readFull(ByteBuffer buf) throws IOException {
		return readFull(buf, MatFileType.Regular);
	}

	/** Reads a full set of bytes (including the header). */
	public static MatFile readFull(ByteBuffer buf, MatFileType type) throws IOException {
		MatFileReader reader = new MatFileReader(type);
		reader.readHeader(buf);
		while (buf.remaining() > 0) {
			reader.readData(buf);
		}
		return new MatFile(reader.getMatFileHeader(), reader.getContent());
	}

	/** Reads a full set of bytes (including the header). */
	public static MatFile readFull(RandomAccessFile file) throws IOException {
		MatFileReader reader = new MatFileReader();
		reader.read(file, new MatFileFilter(), MatFileReader.HEAP_BYTE_BUFFER);
		return new MatFile(reader.getMatFileHeader(), reader.getContent());
	}
}