weka.filters.unsupervised.attribute
Class CorrelationMatrix

java.lang.Object
  weka.filters.Filter
      weka.filters.SimpleFilter
          weka.filters.SimpleBatchFilter
              weka.filters.unsupervised.attribute.CorrelationMatrix

All Implemented Interfaces:

Serializable, weka.core.CapabilitiesHandler, weka.core.OptionHandler, weka.core.RevisionHandler, weka.filters.UnsupervisedFilter

public class CorrelationMatrix
extends weka.filters.SimpleBatchFilter
implements weka.filters.UnsupervisedFilter

Computes a matrix with the correlation coefficients between attributes.

Valid options are:

 -D
  Turns on output of debugging information.

 -R <range specification>
  The range of attributes to compute the matrix for.
  (default: first-last)

 -absolute
  If turned on, the absolute values of the correlation coefficients
  are returned.
  (default: off)

Version:

$Revision: 4521 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected boolean	m_Absolute whether to return the absolute correlations.
protected weka.core.Range	m_AttributeRange the range of attributes to work on.
protected Vector<Integer>	m_Indices the attribute indices to use.

Fields inherited from class weka.filters.SimpleFilter

m_Debug

Fields inherited from class weka.filters.Filter

m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

CorrelationMatrix()

Method Summary

String	absoluteTipText() Returns the tip text for this property.
String	attributeRangeTipText() Returns the tip text for this property.
protected weka.core.Instances	determineOutputFormat(weka.core.Instances inputFormat) Determines the output format based on the input format and returns this.
boolean	getAbsolute() Returns whether the absolute values of coefficients are returned.
String	getAttributeRange() Returns the range of attributes to compute the matrix for.
weka.core.Capabilities	getCapabilities() Returns the Capabilities of this filter.
String[]	getOptions() returns the options of the current setup.
String	getRevision() Returns the revision string.
String	globalInfo() Returns a string describing this classifier.
Enumeration	listOptions() Gets an enumeration describing the available options.
static void	main(String[] args) runs the filter with the given arguments.
protected weka.core.Instances	process(weka.core.Instances instances) Processes the given data (may change the provided dataset) and returns the modified version.
void	setAbsolute(boolean value) Sets whether to return the absolute values of the coefficients.
void	setAttributeRange(String value) Sets the range of attributes to compute the matrix for.
void	setOptions(String[] options) Parses the options for this object.

Methods inherited from class weka.filters.SimpleBatchFilter

batchFinished, hasImmediateOutputFormat, input

Methods inherited from class weka.filters.SimpleFilter

debugTipText, getDebug, reset, setDebug, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, filterFile, flushInput, getCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, push, resetQueue, runFilter, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Field Detail

m_AttributeRange

protected weka.core.Range m_AttributeRange

the range of attributes to work on.

m_Absolute

protected boolean m_Absolute

whether to return the absolute correlations.

m_Indices

protected Vector<Integer> m_Indices

the attribute indices to use.

Constructor Detail

CorrelationMatrix

public CorrelationMatrix()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing this classifier.

Specified by:

globalInfo in class weka.filters.SimpleFilter

Returns:

a description of the classifier suitable for displaying in the explorer/experimenter gui

listOptions

public Enumeration listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class weka.filters.SimpleFilter

Returns:

an enumeration of all the available options.

getOptions

public String[] getOptions()

returns the options of the current setup.

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class weka.filters.SimpleFilter

Returns:

the current options

setOptions

public void setOptions(String[] options)
                throws Exception

Parses the options for this object.

Valid options are:

 -D
  Turns on output of debugging information.

 -R <range specification>
  The range of attributes to compute the matrix for.
  (default: first-last)

 -absolute
  If turned on, the absolute values of the correlation coefficients
  are returned.
  (default: off)

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class weka.filters.SimpleFilter

Parameters:

options - the options to use

Throws:

Exception - if the option setting fails

attributeRangeTipText

public String attributeRangeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setAttributeRange

public void setAttributeRange(String value)

Sets the range of attributes to compute the matrix for.

Parameters:

value - the attribute range

getAttributeRange

public String getAttributeRange()

Returns the range of attributes to compute the matrix for.

Returns:

the attribute range

absoluteTipText

public String absoluteTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setAbsolute

public void setAbsolute(boolean value)

Sets whether to return the absolute values of the coefficients.

Parameters:

value - if true then the absolute values are returned

getAbsolute

public boolean getAbsolute()

Returns whether the absolute values of coefficients are returned.

Returns:

true if absolute values are returned

determineOutputFormat

protected weka.core.Instances determineOutputFormat(weka.core.Instances inputFormat)
                                             throws Exception

Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., immediateOutputFormat() returns false, then this method will be called from batchFinished().

Specified by:

determineOutputFormat in class weka.filters.SimpleFilter

Parameters:

inputFormat - the input format to base the output format on

Returns:

the output format

Throws:

Exception - in case the determination goes wrong

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.filters.Filter

Returns:

the capabilities of this object

See Also:

Capabilities

process

protected weka.core.Instances process(weka.core.Instances instances)
                               throws Exception

Processes the given data (may change the provided dataset) and returns the modified version. This method is called in batchFinished().

Specified by:

process in class weka.filters.SimpleFilter

Parameters:

instances - the data to process

Returns:

the modified data

Throws:

Exception - in case the processing goes wrong

getRevision

public String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class weka.filters.Filter

Returns:

the revision

main

public static void main(String[] args)

runs the filter with the given arguments.

Parameters:

args - the commandline arguments