org.cognity.data.io

Class MatlabImporter

java.lang.Object

org.cognity.data.io.AbstractMatlabIO

org.cognity.data.io.MatlabImporter

All Implemented Interfaces:

DataSetImporter

public final class MatlabImporter
extends AbstractMatlabIO
implements DataSetImporter

This class allows you to import data sets from Matlab files.
In Matlab environment, an unsupervised data set should be stored as a single dense matrix, while supervised data set requires two matrices - one for the input vectors and a second for the target vectors.
Before an import you need to specify the name of the matrix with input vectors and, optionally, the name of the matrix with target vectors. You can also specify how the vectors are arranged in the matrix by setting Orientation property.
If names of the matrices are not specified, then default names are used "inputs" for the input matrix and "targets" for the target matrix.

Author:

Artur Markiewicz

Nested Class Summary

Nested classes/interfaces inherited from class org.cognity.data.io.AbstractMatlabIO

AbstractMatlabIO.Orientation

Field Summary

Fields inherited from class org.cognity.data.io.AbstractMatlabIO

DEFAULT_INPUTS_NAME, DEFAULT_ORIENTATION, DEFAULT_TARGETS_NAME

Constructor Summary

Constructors

Constructor and Description
MatlabImporter(File file) Creates a new importer using the specified file.
MatlabImporter(File file, String inputsName) Creates a new importer using the specified file and input matrix name.
MatlabImporter(File file, String inputsName, String targetsName) Creates a new importer using the specified file and names of the matrices.

Method Summary

Methods

Modifier and Type	Method and Description
DataSet	importData() Imports the data set.

Methods inherited from class org.cognity.data.io.AbstractMatlabIO

getInputMatrixName, getOrientation, getTargetMatrixName, setInputMatrixName, setOrientation, setTargetMatrixName

Methods inherited from class java.lang.Object

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

Constructor Detail

MatlabImporter

public MatlabImporter(File file)
               throws IOException

Creates a new importer using the specified file. Default names for the input and target matrices are used.

Parameters:

file - the file containing the data set

Throws:

IOException

MatlabImporter

public MatlabImporter(File file,
              String inputsName)
               throws IOException

Creates a new importer using the specified file and input matrix name. Use this constructor in order to import an unsupervised data set.

Parameters:

file - the file containing data set

inputsName - the name of the input matrix

Throws:

IOException

MatlabImporter

public MatlabImporter(File file,
              String inputsName,
              String targetsName)
               throws IOException

Creates a new importer using the specified file and names of the matrices. Use this constructor in order to import a supervised data set.

Parameters:

file - the file containing data set

inputsName - the name of the input matrix

targetsName - the name of the target matrix

Throws:

IOException

Method Detail

importData

public DataSet importData()

Imports the data set.

Specified by:

importData in interface DataSetImporter

Returns:

imported data set