Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

marf.Classification
Class Classification  view Classification download Classification.java

java.lang.Object
  extended bymarf.Storage.StorageManager
      extended bymarf.Classification.Classification
All Implemented Interfaces:
IClassification, marf.Storage.IStorageManager, java.io.Serializable

public abstract class Classification
extends marf.Storage.StorageManager
implements IClassification

Abstract Classification Module. A generic implementation of the IClassification interface. The derivatives must inherit from this module, and if they cannot, they should implement IClassification themselves.

$Id: Classification.java,v 1.39 2005/08/05 22:19:47 mokhov Exp $

Since:
0.0.1
Version:
$Revision: 1.39 $

Field Summary
protected  marf.FeatureExtraction.IFeatureExtraction oFeatureExtraction
          Reference to the enclosed FeatureExtraction object.
protected  marf.Storage.ResultSet oResultSet
          Classification result set.
protected  marf.Storage.TrainingSet oTrainingSet
          TrainingSet Container.
 
Fields inherited from class marf.Storage.StorageManager
bDumpOnNotFound, iCurrentDumpMode, oObjectToSerialize, strFilename
 
Fields inherited from interface marf.Classification.IClassification
MARF_INTERFACE_CODE_REVISION
 
Fields inherited from interface marf.Storage.IStorageManager
DUMP_BINARY, DUMP_CSV_TEXT, DUMP_GZIP_BINARY, DUMP_HTML, DUMP_SQL, DUMP_XML, MARF_INTERFACE_CODE_REVISION, STORAGE_FILE_EXTENSIONS
 
Constructor Summary
protected Classification(marf.FeatureExtraction.IFeatureExtraction poFeatureExtraction)
          Generic Classification Constructor.
 
Method Summary
 void dump()
          Generic implementation of dump() to dump the TrainingSet.
 marf.FeatureExtraction.IFeatureExtraction getFeatureExtraction()
          Retrieves the features source.
static java.lang.String getMARFSourceCodeRevision()
          Retrieves class' revision.
 marf.Storage.ResultSet getResultSet()
          Retrieves the enclosed result set.
protected  java.lang.String getTrainingSetFilename()
          Constructs a global cluster file name for the TrainingSet.
private  void loadTrainingSet()
          Loads TrainingSet from a file.
 void restore()
          Generic implementation of restore() for TrainingSet.
private  void saveTrainingSet()
          Saves TrainingSet to a file.
 void setFeatureExtraction(marf.FeatureExtraction.IFeatureExtraction poFeatureExtraction)
          Allows setting the features surce.
 boolean train()
          Generic training routine for building/updating mean vectors in the training set.
 
Methods inherited from class marf.Storage.StorageManager
backSynchronizeObject, dumpBinary, dumpCSV, dumpGzipBinary, dumpHTML, dumpSQL, dumpXML, enableDumpOnNotFound, getDefaultExtension, getDefaultExtension, getDumpMode, getFilename, restoreBinary, restoreCSV, restoreGzipBinary, restoreHTML, restoreSQL, restoreXML, setDumpMode, setFilename
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface marf.Classification.IClassification
classify, getResult
 

Field Detail

oFeatureExtraction

protected marf.FeatureExtraction.IFeatureExtraction oFeatureExtraction
Reference to the enclosed FeatureExtraction object.


oTrainingSet

protected marf.Storage.TrainingSet oTrainingSet
TrainingSet Container.


oResultSet

protected marf.Storage.ResultSet oResultSet
Classification result set. May contain one or more results (in case of similarity).

Since:
0.3.0.2
Constructor Detail

Classification

protected Classification(marf.FeatureExtraction.IFeatureExtraction poFeatureExtraction)
Generic Classification Constructor.

Method Detail

train

public boolean train()
              throws ClassificationException
Generic training routine for building/updating mean vectors in the training set. Can be overridden, and if the overriding classifier is using TrainingSet, it should call super.train();

Specified by:
train in interface IClassification

dump

public void dump()
          throws marf.Storage.StorageException
Generic implementation of dump() to dump the TrainingSet.

Specified by:
dump in interface marf.Storage.IStorageManager
Since:
0.2.0

restore

public void restore()
             throws marf.Storage.StorageException
Generic implementation of restore() for TrainingSet.

Specified by:
restore in interface marf.Storage.IStorageManager
Since:
0.2.0

saveTrainingSet

private final void saveTrainingSet()
                            throws marf.Storage.StorageException
Saves TrainingSet to a file. Called by dump().

Since:
0.2.0

loadTrainingSet

private final void loadTrainingSet()
                            throws marf.Storage.StorageException
Loads TrainingSet from a file. Called by restore().

Since:
0.2.0

getResultSet

public marf.Storage.ResultSet getResultSet()
Retrieves the enclosed result set.

Specified by:
getResultSet in interface IClassification
Since:
0.3.0.2

getTrainingSetFilename

protected java.lang.String getTrainingSetFilename()
Constructs a global cluster file name for the TrainingSet.

Filename is constructed using fully-qualified class of either TrainingSet or a classifier name with global clustering info such as preprocessing and feature extraction methods, so that ony that cluster can be reloaded after.

May be overridden by the drivatives when necessary.

Since:
0.2.0

getFeatureExtraction

public marf.FeatureExtraction.IFeatureExtraction getFeatureExtraction()
Retrieves the features source.

Specified by:
getFeatureExtraction in interface IClassification
Since:
0.3.0.4

setFeatureExtraction

public void setFeatureExtraction(marf.FeatureExtraction.IFeatureExtraction poFeatureExtraction)
Allows setting the features surce.

Specified by:
setFeatureExtraction in interface IClassification
Since:
0.3.0.4

getMARFSourceCodeRevision

public static java.lang.String getMARFSourceCodeRevision()
Retrieves class' revision.

Since:
0.3.0.2