weka.filters.unsupervised.attribute

Class Reorder

java.lang.Object

weka.filters.Filter

weka.filters.unsupervised.attribute.Reorder

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter, UnsupervisedFilter

public class Reorder
extends Filter
implements UnsupervisedFilter, StreamableFilter, OptionHandler, WeightedAttributesHandler, WeightedInstancesHandler

A filter that generates output with a new order of the attributes. Useful if one wants to move an attribute to the end of the list of attributes to use it as class attribute (e.g., using "-R 2-last,1").

It is not only possible to change the order of the attributes. Attributes can also be left out. E.g. if you have 10 attributes, you can generate the following output order: 1,3,5,7,9,10 or 10,1-5.

You can also duplicate attributes, e.g., for further processing later on: e.g., using 1,1,1,4,4,4,2,2,2 if one needs to process two copies of the attributes with other filters but also needs to keep the original attributes.

One can simply reverse the order of the attributes via 'last-first'.

After applying the filter, the index of the class attribute is set to the index of the last attribute.

Valid options are:

 -R <index1,index2-index4,...>
  Specifies the order of the attributes (default first-last).
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	m_InputStringIndex Contains an index of string attributes in the input format that survive the filtering process -- some entries may be duplicated
protected java.lang.String	m_NewOrderCols Stores which columns to reorder
protected int[]	m_SelectedAttributes Stores the indexes of the selected attributes in order, once the dataset is seen
protected boolean	m_setAllAttributeWeightsToOne Whether to set all attribute weights to 1.0 in the reordered data.

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
Reorder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	attributeIndicesTipText() Returns the tip text for this property
protected int	determineIndex(java.lang.String s, int numAttributes) parses the index string and returns the corresponding int index
protected int[]	determineIndices(int numAttributes) parses the range string and returns an array with the indices
java.lang.String	getAttributeIndices() Get 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
boolean	input(Instance instance) Input an instance for filtering.
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] argv) Main method for testing this class.
void	setAllAttributeWeightsToOne(boolean b) Whether to set all attribute weights to one in output data.
void	setAttributeIndices(java.lang.String rangeList) Set which attributes are to be copied (or kept if invert is true)
void	setAttributeIndicesArray(int[] attributes) Set which attributes are to be copied (or kept if invert is true)
boolean	setInputFormat(Instances instanceInfo) Sets the format of the input instances.
void	setOptions(java.lang.String[] options) Parses a given list of options.

Methods inherited from class weka.filters.Filter

batchFilterFile, batchFinished, 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_NewOrderCols

protected java.lang.String m_NewOrderCols

Stores which columns to reorder

m_SelectedAttributes

protected int[] m_SelectedAttributes

Stores the indexes of the selected attributes in order, once the dataset is seen

m_InputStringIndex

protected int[] m_InputStringIndex

Contains an index of string attributes in the input format that survive the filtering process -- some entries may be duplicated

m_setAllAttributeWeightsToOne

protected boolean m_setAllAttributeWeightsToOne

Whether to set all attribute weights to 1.0 in the reordered data.

Constructor Detail

Reorder

public Reorder()

Method Detail

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 given list of options.

Valid options are:

 -R <index1,index2-index4,...>
  Specifies the order of the attributes (default first-last).
 

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

determineIndex

protected int determineIndex(java.lang.String s,
                             int numAttributes)
                      throws java.lang.Exception

parses the index string and returns the corresponding int index

Parameters:

s - the index string to parse

numAttributes - necessary for "last" and OutOfBounds checks

Returns:

the int index determined form the index string

Throws:

java.lang.Exception - if index is not valid

determineIndices

protected int[] determineIndices(int numAttributes)
                          throws java.lang.Exception

parses the range string and returns an array with the indices

Parameters:

numAttributes - necessary for "last" and OutOfBounds checks

Returns:

the indices determined form the range string

Throws:

java.lang.Exception - if range is not valid

See Also:

m_NewOrderCols

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

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws java.lang.Exception

Sets the format of the input instances.

Overrides:

setInputFormat in class Filter

Parameters:

instanceInfo - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).

Returns:

true if the outputFormat may be collected immediately

Throws:

java.lang.Exception - if a problem occurs setting the input format

setAllAttributeWeightsToOne

public void setAllAttributeWeightsToOne(boolean b)

Whether to set all attribute weights to one in output data.

input

public boolean input(Instance instance)

Input an instance for filtering. Ordinarily the instance is processed and made available for output immediately. Some filters require all instances be read before producing output.

Overrides:

input in class Filter

Parameters:

instance - the input instance

Returns:

true if the filtered instance may now be collected with output().

Throws:

java.lang.IllegalStateException - if no input format has been defined.

globalInfo

public java.lang.String globalInfo()

Returns a string describing this filter

Returns:

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

getAttributeIndices

public java.lang.String getAttributeIndices()

Get the current range selection

Returns:

a string containing a comma separated list of ranges

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

setAttributeIndices

public void setAttributeIndices(java.lang.String rangeList)
                         throws java.lang.Exception

Set which attributes are to be copied (or kept if invert is true)

Parameters:

rangeList - 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
Note: use this method before you call setInputFormat(Instances), since the output format is determined in that method.

Throws:

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

setAttributeIndicesArray

public void setAttributeIndicesArray(int[] attributes)
                              throws java.lang.Exception

Set which attributes are to be copied (or kept if invert is true)

Parameters:

attributes - an array containing indexes of attributes to select. Since the array will typically come from a program, attributes are indexed from 0.
Note: use this method before you call setInputFormat(Instances), since the output format is determined in that method.

Throws:

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

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[] argv)

Main method for testing this class.

Parameters:

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