All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.filters.unsupervised.attribute.Discretize

java.lang.Object
    |
    +----weka.filters.Filter
            |
            +----weka.filters.unsupervised.attribute.Discretize

public class Discretize

extends Filter

implements UnsupervisedFilter, OptionHandler, WeightedInstancesHandler

Valid filter-specific options are:

-B num
Specifies the (maximum) number of bins to divide numeric attributes into. Default = 10.

-F
Use equal-frequency instead of equal-width discretization if class-based discretisation is turned off.

-O
Optimize the number of bins using a leave-one-out estimate of the entropy (for equal-width binning).

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

-V
Invert matching sense.

-D
Make binary nominal attributes.

Version:

$Revision: 1.2 $

Author:

Len Trigg (trigg@cs.waikato.ac.nz)

Author:

Eibe Frank (eibe@cs.waikato.ac.nz)

Discretize()

Constructor - initialises the filter

attributeIndicesTipText()

Returns the tip text for this property

batchFinished()

Signifies that this batch of input to the filter is finished.

binsTipText()

Returns the tip text for this property

findNumBinsTipText()

Returns the tip text for this property

getAttributeIndices()

Gets the current range selection

getBins()

Gets the number of bins numeric attributes will be divided into

getCutPoints(int)

Gets the cut points for an attribute

getFindNumBins()

Get the value of FindNumBins.

getInvertSelection()

Gets whether the supplied columns are to be removed or kept

getMakeBinary()

Gets whether binary attributes should be made for discretized ones.

getOptions()

Gets the current settings of the filter.

getUseEqualFrequency()

Get the value of UseEqualFrequency.

globalInfo()

Returns a string describing this filter

input(Instance)

Input an instance for filtering.

invertSelectionTipText()

Returns the tip text for this property

listOptions()

Gets an enumeration describing the available options.

main(String[])

Main method for testing this class.

makeBinaryTipText()

Returns the tip text for this property

setAttributeIndices(String)

Sets which attributes are to be Discretized (only numeric attributes among the selection will be Discretized).

setAttributeIndicesArray(int[])

Sets which attributes are to be Discretized (only numeric attributes among the selection will be Discretized).

setBins(int)

Sets the number of bins to divide each selected numeric attribute into

setFindNumBins(boolean)

Set the value of FindNumBins.

setInputFormat(Instances)

Sets the format of the input instances.

setInvertSelection(boolean)

Sets whether selected columns should be removed or kept.

setMakeBinary(boolean)

Sets whether binary attributes should be made for discretized ones.

setOptions(String[])

Parses the options for this object.

setUseEqualFrequency(boolean)

Set the value of UseEqualFrequency.

public Discretize()

          Constructor - initialises the filter

public java.util.Enumeration listOptions()

          Gets an enumeration describing the available options.

Returns:

an enumeration of all the available options.

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

          Parses the options for this object. Valid options are:

-B num
Specifies the (maximum) number of bins to divide numeric attributes into. Default = 10.

-F
Use equal-frequency instead of equal-width discretization if class-based discretisation is turned off.

-O
Optimize the number of bins using a leave-one-out estimate of the entropy (for equal-width binning).

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

-V
Invert matching sense.

-D
Make binary nominal attributes.

Parameters:

options - the list of options as an array of strings

Throws:

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

public java.lang.String[] getOptions()

          Gets the current settings of the filter.

Returns:

an array of strings suitable for passing to setOptions

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

          Sets the format of the input instances.

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 the input format can't be set successfully

Overrides:

setInputFormat in class Filter

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.

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.

Overrides:

input in class Filter

public boolean batchFinished()

          Signifies that this batch of input to the filter is finished. If the filter requires all instances prior to filtering, output() may now be called to retrieve the filtered instances.

Returns:

true if there are instances pending output

Throws:

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

Overrides:

batchFinished in class Filter

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

public java.lang.String findNumBinsTipText()

          Returns the tip text for this property

Returns:

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

public boolean getFindNumBins()

          Get the value of FindNumBins.

Returns:

Value of FindNumBins.

public void setFindNumBins(boolean newFindNumBins)

          Set the value of FindNumBins.

Parameters:

newFindNumBins - Value to assign to FindNumBins.

public java.lang.String makeBinaryTipText()

          Returns the tip text for this property

Returns:

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

public boolean getMakeBinary()

          Gets whether binary attributes should be made for discretized ones.

Returns:

true if attributes will be binarized

public void setMakeBinary(boolean makeBinary)

          Sets whether binary attributes should be made for discretized ones.

Parameters:

makeBinary - if binary attributes are to be made

public boolean getUseEqualFrequency()

          Get the value of UseEqualFrequency.

Returns:

Value of UseEqualFrequency.

public void setUseEqualFrequency(boolean newUseEqualFrequency)

          Set the value of UseEqualFrequency.

Parameters:

newUseEqualFrequency - Value to assign to UseEqualFrequency.

public java.lang.String binsTipText()

          Returns the tip text for this property

Returns:

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

public int getBins()

          Gets the number of bins numeric attributes will be divided into

Returns:

the number of bins.

public void setBins(int numBins)

          Sets the number of bins to divide each selected numeric attribute into

Parameters:

numBins - the number of bins

public java.lang.String invertSelectionTipText()

          Returns the tip text for this property

Returns:

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

public boolean getInvertSelection()

          Gets whether the supplied columns are to be removed or kept

Returns:

true if the supplied columns will be kept

public void setInvertSelection(boolean invert)

          Sets whether selected columns should be removed or kept. If true the selected columns are kept and unselected columns are deleted. If false selected columns are deleted and unselected columns are kept.

Parameters:

invert - the new invert setting

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

public java.lang.String getAttributeIndices()

          Gets the current range selection

Returns:

a string containing a comma separated list of ranges

public void setAttributeIndices(java.lang.String rangeList)

          Sets which attributes are to be Discretized (only numeric attributes among the selection will be Discretized).

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

Throws:

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

public void setAttributeIndicesArray(int attributes[])

          Sets which attributes are to be Discretized (only numeric attributes among the selection will be Discretized).

Parameters:

attributes - an array containing indexes of attributes to Discretize. 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

public double[] getCutPoints(int attributeIndex)

          Gets the cut points for an attribute

Parameters:

the - index (from 0) of the attribute to get the cut points of

Returns:

an array containing the cutpoints (or null if the attribute requested isn't being Discretized

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home