Class Reorder
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.Reorder
- All Implemented Interfaces:
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:
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).
- Version:
- $Revision: 14606 $
- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the tip text for this propertyGet the current range selectionReturns the Capabilities of this filter.String[]Gets the current settings of the filter.Returns the revision string.Returns a string describing this filterbooleanInput an instance for filtering.Returns an enumeration describing the available options.static voidMain method for testing this class.voidsetAllAttributeWeightsToOne(boolean b) Whether to set all attribute weights to one in output data.voidsetAttributeIndices(String rangeList) Set which attributes are to be copied (or kept if invert is true)voidsetAttributeIndicesArray(int[] attributes) Set which attributes are to be copied (or kept if invert is true)booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetOptions(String[] options) Parses a given list of options.Methods inherited from class weka.filters.Filter
batchFilterFile, batchFinished, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
Reorder
public Reorder()
-
-
Method Details
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-R <index1,index2-index4,...> Specifies the order of the attributes (default first-last).
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of the filter.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormatin classFilter- 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:
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
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:
inputin classFilter- Parameters:
instance- the input instance- Returns:
- true if the filtered instance may now be collected with output().
- Throws:
IllegalStateException- if no input format has been defined.
-
globalInfo
Returns a string describing this filter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
getAttributeIndices
Get the current range selection- Returns:
- a string containing a comma separated list of ranges
-
attributeIndicesTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setAttributeIndices
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 callsetInputFormat(Instances), since the output format is determined in that method.- Throws:
Exception- if an invalid range list is supplied
-
setAttributeIndicesArray
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 callsetInputFormat(Instances), since the output format is determined in that method.- Throws:
Exception- if an invalid set of ranges is supplied
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classFilter- Returns:
- the revision
-
main
Main method for testing this class.- Parameters:
argv- should contain arguments to the filter: use -h for help
-