com.jmatio.io

Class MatFileWriter

java.lang.Object

com.jmatio.io.MatFileWriter

public class MatFileWriter
extends java.lang.Object

MAT-file writer. 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
 ArrayList list = new ArrayList();
 list.add( mlDouble );
 list.add( mlChar );
 
 new MatFileWriter( "mat_file.mat", list );
 

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', 'char_arr');
 

Constructor Summary

Constructors

Constructor and Description
MatFileWriter() Creates the new MatFileWriter instance
MatFileWriter(java.io.File file, java.util.Collection<MLArray> data) Writes MLArrays into File.
MatFileWriter(java.lang.String fileName, java.util.Collection<MLArray> data) Writes MLArrays into file given by fileName.
MatFileWriter(java.nio.channels.WritableByteChannel channel, java.util.Collection<MLArray> data) Writes MLArrays into OuputSteram.

Method Summary

Modifier and Type	Method and Description
void	write(java.io.File file, java.util.Collection<MLArray> data) Writes MLArrays into File
void	write(java.lang.String filepath, java.util.Collection<MLArray> data) Writes MLArrays into file created from filepath.
private void	write(java.nio.channels.WritableByteChannel channel, java.util.Collection<MLArray> data) Writes MLArrays into WritableByteChannel.
private void	writeDimensions(java.io.DataOutputStream os, MLArray array) Writes MATRIX dimensions into OutputStream.
private void	writeFlags(java.io.DataOutputStream os, MLArray array) Writes MATRIX flags into OutputStream.
private void	writeHeader(java.nio.channels.WritableByteChannel channel) Writes MAT-file header into OutputStream
private void	writeMatrix(java.io.DataOutputStream output, MLArray array) Writes MATRIX into OutputStream.
private void	writeName(java.io.DataOutputStream os, MLArray array) Writes MATRIX name into OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatFileWriter

public MatFileWriter()

Creates the new MatFileWriter instance

MatFileWriter

public MatFileWriter(java.lang.String fileName,
                     java.util.Collection<MLArray> data)
              throws java.io.IOException

Writes MLArrays into file given by fileName.

Parameters:

fileName - - name of ouput file

data - - Collection of MLArray elements

Throws:

java.io.IOException

java.util.zip.DataFormatException

MatFileWriter

public MatFileWriter(java.io.File file,
                     java.util.Collection<MLArray> data)
              throws java.io.IOException

Writes MLArrays into File.

Parameters:

file - - an output File

data - - Collection of MLArray elements

Throws:

java.io.IOException

java.util.zip.DataFormatException

MatFileWriter

public MatFileWriter(java.nio.channels.WritableByteChannel channel,
                     java.util.Collection<MLArray> data)
              throws java.io.IOException

Writes MLArrays into OuputSteram. Writes MAT-file header and compressed data (miCOMPRESSED).

Parameters:

output - - OutputStream

data - - Collection of MLArray elements

Throws:

java.io.IOException

Method Detail

write

public void write(java.lang.String filepath,
                  java.util.Collection<MLArray> data)
           throws java.io.IOException

Writes MLArrays into file created from filepath.

Parameters:

filepath - the absolute file path of a MAT-file to which data is written

data - the collection of MLArray objects

Throws:

java.io.IOException - if error occurred during MAT-file writing

write

public void write(java.io.File file,
                  java.util.Collection<MLArray> data)
           throws java.io.IOException

Writes MLArrays into File

Parameters:

file - the MAT-file to which data is written

data - the collection of MLArray objects

Throws:

java.io.IOException - if error occurred during MAT-file writing

write

private void write(java.nio.channels.WritableByteChannel channel,
                   java.util.Collection<MLArray> data)
            throws java.io.IOException

Writes MLArrays into WritableByteChannel.

Parameters:

channel - the channel to write to

data - the collection of MLArray objects

Throws:

java.io.IOException - if writing fails

writeHeader

private void writeHeader(java.nio.channels.WritableByteChannel channel)
                  throws java.io.IOException

Writes MAT-file header into OutputStream

Parameters:

os - OutputStream

Throws:

java.io.IOException

writeMatrix

private void writeMatrix(java.io.DataOutputStream output,
                         MLArray array)
                  throws java.io.IOException

Writes MATRIX into OutputStream.

Parameters:

os - - OutputStream

array - - a MLArray

Throws:

java.io.IOException

writeFlags

private void writeFlags(java.io.DataOutputStream os,
                        MLArray array)
                 throws java.io.IOException

Writes MATRIX flags into OutputStream.

Parameters:

os - - OutputStream

array - - a MLArray

Throws:

java.io.IOException

writeDimensions

private void writeDimensions(java.io.DataOutputStream os,
                             MLArray array)
                      throws java.io.IOException

Writes MATRIX dimensions into OutputStream.

Parameters:

os - - OutputStream

array - - a MLArray

Throws:

java.io.IOException

writeName

private void writeName(java.io.DataOutputStream os,
                       MLArray array)
                throws java.io.IOException

Writes MATRIX name into OutputStream.

Parameters:

os - - OutputStream

array - - a MLArray

Throws:

java.io.IOException