weka.filters.unsupervised.attribute

Class CartesianProduct

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.CartesianProduct

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler

public class CartesianProduct
extends SimpleBatchFilter

A filter for performing the Cartesian product of a set of nominal attributes. The weight of the new Cartesian product attribute is the sum of the weights of the combined attributes.

Valid options are:

 -R <col1,col2-col4,...>
  Specifies list of nominal attributes to use to form the product.
  (default none)

 -output-debug-info
  If set, filter is run in debug mode and
  may output additional info to the console

 -do-not-check-capabilities
  If set, filter capabilities are not checked before filter is built
  (use with caution).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Range	m_Attributes the attribute range to work on

Fields inherited from class weka.filters.Filter

m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
CartesianProduct()

Method Summary

Modifier and Type	Method and Description
java.lang.String	attributeIndicesTipText() Returns the tip text for this property
protected Instances	determineOutputFormat(Instances inputFormat) Determines the output format based on the input format and returns this.
java.lang.String	getAttributeIndices() Gets the current range selection
Capabilities	getCapabilities() Returns the Capabilities of this filter.
java.lang.String[]	getOptions() Gets the current settings of the filter.
java.lang.String	getRevision() Returns the revision string.
java.lang.String	globalInfo() Returns a string describing this filter
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method for testing this class.
protected Instances	process(Instances instances) Processes the given data (may change the provided dataset) and returns the modified version.
void	setAttributeIndices(java.lang.String value) Sets which attributes are to be used for interquartile calculations and outlier/extreme value detection (only numeric attributes among the selection will be used).
void	setAttributeIndicesArray(int[] value) Sets which attributes are to be used.
void	setOptions(java.lang.String[] options) Parses a list of options for this object.

Methods inherited from class weka.filters.SimpleBatchFilter

allowAccessToFullInputFormat, batchFinished, hasImmediateOutputFormat, input

Methods inherited from class weka.filters.SimpleFilter

reset, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, 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_Attributes

protected Range m_Attributes

the attribute range to work on

Constructor Detail

CartesianProduct

public CartesianProduct()

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing this filter

Specified by:

globalInfo in class SimpleFilter

Returns:

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

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class Filter

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a list of options for this object.

Valid options are:

 -R <col1,col2-col4,...>
  Specifies list of nominal attributes to use to form the product.
  (default none)

 -output-debug-info
  If set, filter is run in debug mode and
  may output additional info to the console

 -do-not-check-capabilities
  If set, filter capabilities are not checked before filter is built
  (use with caution).

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Filter

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class Filter

Returns:

an array of strings suitable for passing to setOptions

attributeIndicesTipText

public java.lang.String attributeIndicesTipText()

Returns the tip text for this property

Returns:

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

getAttributeIndices

public java.lang.String getAttributeIndices()

Gets the current range selection

Returns:

a string containing a comma separated list of ranges

setAttributeIndices

public void setAttributeIndices(java.lang.String value)

Sets which attributes are to be used for interquartile calculations and outlier/extreme value detection (only numeric attributes among the selection will be used).

Parameters:

value - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from 1.
eg: first-3,5,6-last

Throws:

java.lang.IllegalArgumentException - if an invalid range list is supplied

setAttributeIndicesArray

public void setAttributeIndicesArray(int[] value)

Sets which attributes are to be used.

Parameters:

value - an array containing indexes of attributes to work on. Since the array will typically come from a program, attributes are indexed from 0.

Throws:

java.lang.IllegalArgumentException - if an invalid set of ranges is supplied

getCapabilities

public Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class Filter

Returns:

the capabilities of this object

See Also:

Capabilities

determineOutputFormat

protected Instances determineOutputFormat(Instances inputFormat)
                                   throws java.lang.Exception

Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., hasImmediateOutputFormat() returns false, then this method will called from batchFinished() after the call of preprocess(Instances), in which, e.g., statistics for the actual processing step can be gathered.

Specified by:

determineOutputFormat in class SimpleFilter

Parameters:

inputFormat - the input format to base the output format on

Returns:

the output format

Throws:

java.lang.Exception - in case the determination goes wrong

See Also:

SimpleBatchFilter.hasImmediateOutputFormat(), SimpleBatchFilter.batchFinished()

process

protected Instances process(Instances instances)
                     throws java.lang.Exception

Processes the given data (may change the provided dataset) and returns the modified version. This method is called in batchFinished(). This implementation only calls process(Instance) for each instance in the given dataset.

Specified by:

process in class SimpleFilter

Parameters:

instances - the data to process

Returns:

the modified data

Throws:

java.lang.Exception - in case the processing goes wrong

See Also:

SimpleBatchFilter.batchFinished()

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class Filter

Returns:

the revision

main

public static void main(java.lang.String[] args)

Main method for testing this class.

Parameters:

args - should contain arguments to the filter: use -h for help