weka.filters.unsupervised.attribute

Class NumericToNominal

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.NumericToNominal

All Implemented Interfaces:

Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler

public class NumericToNominal
extends SimpleBatchFilter

A filter for turning numeric attributes into nominal ones. Unlike discretization, it just takes all numeric values and adds them to the list of nominal values of that attribute. Useful after CSV imports, to enforce certain attributes to become nominal, e.g., the class attribute, containing values from 1 to 5.

Valid options are:

 -R <col1,col2-col4,...>
  Specifies list of columns to Discretize. First and last are valid indexes.
  (default: first-last)

 -V
  Invert matching sense of column indexes.

Version:

$Revision: 8576 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Range	m_Cols Stores which columns to turn into nominals
protected String	m_DefaultCols The default columns to turn into nominals
protected static int	MAX_DECIMALS the maximum number of decimals 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

Constructors

Constructor and Description
NumericToNominal()

Method Summary

Modifier and Type	Method and Description
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.
String	getAttributeIndices() Gets the current range selection
Capabilities	getCapabilities() Returns the Capabilities of this filter.
boolean	getInvertSelection() Gets whether the supplied columns are to be worked on or the others.
String[]	getOptions() Gets the current settings of the filter.
String	getRevision() Returns the revision string.
String	globalInfo() Returns a string describing this filter
String	invertSelectionTipText() Returns the tip text for this property
Enumeration	listOptions() Gets an enumeration describing the available options.
static void	main(String[] args) Runs the filter with the given parameters.
protected Instances	process(Instances instances) Processes the given data (may change the provided dataset) and returns the modified version.
void	setAttributeIndices(String value) Sets which attributes are to be "nominalized" (only numeric attributes among the selection will be transformed).
void	setAttributeIndicesArray(int[] value) Sets which attributes are to be transoformed to nominal.
void	setInvertSelection(boolean value) Sets whether selected columns should be worked on or all the others apart from these.
void	setOptions(String[] options) Parses a given list of options.

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, 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

MAX_DECIMALS

protected static final int MAX_DECIMALS

the maximum number of decimals to use

See Also:

Constant Field Values

m_Cols

protected Range m_Cols

Stores which columns to turn into nominals

m_DefaultCols

protected String m_DefaultCols

The default columns to turn into nominals

Constructor Detail

NumericToNominal

public NumericToNominal()

Method Detail

globalInfo

public 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 Enumeration listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class SimpleFilter

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a given list of options.

Valid options are:

 -R <col1,col2-col4,...>
  Specifies list of columns to Discretize. First and last are valid indexes.
  (default: first-last)

 -V
  Invert matching sense of column indexes.

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class SimpleFilter

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

See Also:

SimpleFilter.reset()

getOptions

public String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class SimpleFilter

Returns:

an array of strings suitable for passing to setOptions

invertSelectionTipText

public String invertSelectionTipText()

Returns the tip text for this property

Returns:

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

getInvertSelection

public boolean getInvertSelection()

Gets whether the supplied columns are to be worked on or the others.

Returns:

true if the supplied columns will be worked on

setInvertSelection

public void setInvertSelection(boolean value)

Sets whether selected columns should be worked on or all the others apart from these. If true all the other columns are considered for "nominalization".

Parameters:

value - the new invert setting

attributeIndicesTipText

public 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 String getAttributeIndices()

Gets the current range selection

Returns:

a string containing a comma separated list of ranges

setAttributeIndices

public void setAttributeIndices(String value)

Sets which attributes are to be "nominalized" (only numeric attributes among the selection will be transformed).

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:

IllegalArgumentException - if an invalid range list is supplied

setAttributeIndicesArray

public void setAttributeIndicesArray(int[] value)

Sets which attributes are to be transoformed to nominal. (only numeric attributes among the selection will be transformed).

Parameters:

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

Throws:

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 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 SimpleFilter

Parameters:

inputFormat - the input format to base the output format on

Returns:

the output format

Throws:

Exception - in case the determination goes wrong

See Also:

SimpleBatchFilter.hasImmediateOutputFormat(), SimpleBatchFilter.batchFinished()

process

protected Instances process(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 SimpleFilter

Parameters:

instances - the data to process

Returns:

the modified data

Throws:

Exception - in case the processing goes wrong

See Also:

SimpleBatchFilter.batchFinished()

getRevision

public 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(String[] args)

Runs the filter with the given parameters. Use -h to list options.

Parameters:

args - the commandline options