com.jmatio.io

Class MatFileHeader

java.lang.Object

com.jmatio.io.MatFileHeader

public class MatFileHeader
extends Object

MAT-file header Level 5 MAT-files begin with a 128-byte header made up of a 124 byte text field and two, 16-bit flag fields

Field Summary

Fields

Modifier and Type	Field and Description
static ByteOrder	DEFAULT_ENDIAN
static int	DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
MatFileHeader(String description, int version, ByteOrder byteOrder) New MAT-file header

Method Summary

Modifier and Type	Method and Description
static MatFileHeader	createHeader() A factory.
ByteOrder	getByteOrder()
String	getDescription() Gets descriptive text
byte[]	getEndianIndicator() Gets endian indicator.
int	getVersion() When creating a MAT-file, set version to 0x0100
static ByteOrder	parseByteOrder(byte[] endianIndicator) Parses out the byte order based on a byte array containing either 'MI' (big-endian) or 'IM' (little-endian).
static MatFileHeader	parseFrom(String description, byte[] bversion, byte[] endianIndicator) Parses a MatFileHeader from its desciption and the raw bytes of the version and endian indicator.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_VERSION

public static final int DEFAULT_VERSION

See Also:

Constant Field Values

DEFAULT_ENDIAN

public static final ByteOrder DEFAULT_ENDIAN

Constructor Detail

MatFileHeader

public MatFileHeader(String description,
                     int version,
                     ByteOrder byteOrder)

New MAT-file header

Parameters:

description - - descriptive text (no longer than 116 characters)

version - - by default is set to 0x0100

endianIndicator - - byte array size of 2 indicating byte-swapping requirement

Method Detail

parseFrom

public static MatFileHeader parseFrom(String description,
                                      byte[] bversion,
                                      byte[] endianIndicator)

Parses a MatFileHeader from its desciption and the raw bytes of the version and endian indicator.

Parameters:

description - - descriptive test

bversion - - 2-byte array containing the version (raw from a MAT-File)

endianIndicator - - 2-byte array containing the endian indicator (raw from a MAT-File(

Returns:

parseByteOrder

public static ByteOrder parseByteOrder(byte[] endianIndicator)

Parses out the byte order based on a byte array containing either 'MI' (big-endian) or 'IM' (little-endian).

Parameters:

endianIndicator - 2-byte long array holding the endian indicator

getDescription

public String getDescription()

Gets descriptive text

Returns:

getEndianIndicator

public byte[] getEndianIndicator()

Gets endian indicator. Bytes written as "MI" suggest that byte-swapping operation is required in order to interpret data correctly. If value is set to "IM" byte-swapping is not needed.

Returns:

- a byte array size of 2

getVersion

public int getVersion()

When creating a MAT-file, set version to 0x0100

Returns:

createHeader

public static MatFileHeader createHeader()

A factory. Creates new MatFileHeader instance with default header values:

• MAT-file is 5.0 version
• version is set to 0x0100
• no byte-swapping ("IM")

Returns:

- new MatFileHeader instance

toString

public String toString()

Overrides:

toString in class Object

getByteOrder

public ByteOrder getByteOrder()