Class Discretize
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.PotentialClassIgnorer
weka.filters.unsupervised.attribute.Discretize
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler,UnsupervisedFilter
- Direct Known Subclasses:
PKIDiscretize
public class Discretize
extends PotentialClassIgnorer
implements UnsupervisedFilter, WeightedInstancesHandler, WeightedAttributesHandler
An instance filter that discretizes a range of
numeric attributes in the dataset into nominal attributes. Discretization is
by simple binning. Skips the class attribute if set.
Valid options are:
-unset-class-temporarily Unsets the class index temporarily before the filter is applied to the data. (default: no)
-B <num> Specifies the (maximum) number of bins to divide numeric attributes into. (default = 10)
-M <num> Specifies the desired weight of instances per bin for equal-frequency binning. If this is set to a positive number then the -B option will be ignored. (default = -1)
-F Use equal-frequency instead of equal-width discretization.
-O Optimize number of bins using leave-one-out estimate of estimated entropy (for equal-width discretization). If this is set then the -B option will be ignored.
-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.
-D Output binary attributes for discretized attributes.
-Y Use bin numbers rather than ranges for discretized attributes.
-precision <integer> Precision for bin boundary labels. (default = 6 decimal places).
-spread-attribute-weight When generating binary attributes, spread weight of old attribute across new attributes. Do not give each new attribute the old weight.
- Version:
- $Revision: 14534 $
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz), Eibe Frank (eibe@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor - initialises the filterDiscretize(String cols) Another constructor, sets the attribute indices immediately -
Method Summary
Modifier and TypeMethodDescriptionReturns the tip text for this propertybooleanSignifies that this batch of input to the filter is finished.Returns the tip text for this propertyReturns the tip text for this propertyReturns the tip text for this propertyReturns the tip text for this propertyGets the current range selectionintGet the precision for bin boundaries.getBinRangesString(int attributeIndex) Gets the bin ranges string for an attributeintgetBins()Gets the number of bins numeric attributes will be divided intoReturns the Capabilities of this filter.double[]getCutPoints(int attributeIndex) Gets the cut points for an attributedoubleGet the DesiredWeightOfInstancesPerInterval value.booleanGet the value of FindNumBins.booleanGets whether the supplied columns are to be removed or keptbooleanGets whether binary attributes should be made for discretized ones.String[]Gets the current settings of the filter.Returns the revision string.booleanIf true, when generating binary attributes, spread weight of old attribute across new attributes.booleanGets whether bin numbers rather than ranges should be used for discretized attributes.booleanGet the value of UseEqualFrequency.Returns a string describing this filterbooleanInput an instance for filtering.Returns the tip text for this propertyGets an enumeration describing the available options.static voidMain method for testing this class.Returns the tip text for this propertyvoidsetAttributeIndices(String rangeList) Sets which attributes are to be Discretized (only numeric attributes among the selection will be Discretized).voidsetAttributeIndicesArray(int[] attributes) Sets which attributes are to be Discretized (only numeric attributes among the selection will be Discretized).voidsetBinRangePrecision(int p) Set the precision for bin boundaries.voidsetBins(int numBins) Sets the number of bins to divide each selected numeric attribute intovoidsetDesiredWeightOfInstancesPerInterval(double newDesiredNumber) Set the DesiredWeightOfInstancesPerInterval value.voidsetFindNumBins(boolean newFindNumBins) Set the value of FindNumBins.booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetInvertSelection(boolean invert) Sets whether selected columns should be removed or kept.voidsetMakeBinary(boolean makeBinary) Sets whether binary attributes should be made for discretized ones.voidsetOptions(String[] options) Parses a given list of options.voidsetSpreadAttributeWeight(boolean p) If true, when generating binary attributes, spread weight of old attribute across new attributes.voidsetUseBinNumbers(boolean useBinNumbers) Sets whether bin numbers rather than ranges should be used for discretized attributes.voidsetUseEqualFrequency(boolean newUseEqualFrequency) Set the value of UseEqualFrequency.Returns the tip text for this propertyReturns the tip text for this propertyReturns the tip text for this propertyMethods inherited from class weka.filters.unsupervised.attribute.PotentialClassIgnorer
getIgnoreClass, getOutputFormat, ignoreClassTipText, setIgnoreClassMethods inherited from class weka.filters.Filter
batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
Discretize
public Discretize()Constructor - initialises the filter -
Discretize
Another constructor, sets the attribute indices immediately- Parameters:
cols- the attribute indices
-
-
Method Details
-
listOptions
Gets an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classPotentialClassIgnorer- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-unset-class-temporarily Unsets the class index temporarily before the filter is applied to the data. (default: no)
-B <num> Specifies the (maximum) number of bins to divide numeric attributes into. (default = 10)
-M <num> Specifies the desired weight of instances per bin for equal-frequency binning. If this is set to a positive number then the -B option will be ignored. (default = -1)
-F Use equal-frequency instead of equal-width discretization.
-O Optimize number of bins using leave-one-out estimate of estimated entropy (for equal-width discretization). If this is set then the -B option will be ignored.
-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.
-D Output binary attributes for discretized attributes.
-Y Use bin numbers rather than ranges for discretized attributes.
-precision <integer> Precision for bin boundary labels. (default = 6 decimal places).
-spread-attribute-weight When generating binary attributes, spread weight of old attribute across new attributes. Do not give each new attribute the old weight.
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classPotentialClassIgnorer- 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 classPotentialClassIgnorer- 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 classPotentialClassIgnorer- 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 the input format can't be set successfully
-
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.
-
batchFinished
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.- Overrides:
batchFinishedin classFilter- Returns:
- true if there are instances pending output
- Throws:
IllegalStateException- if no input structure has been defined
-
globalInfo
Returns a string describing this filter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
findNumBinsTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getFindNumBins
public boolean getFindNumBins()Get the value of FindNumBins.- Returns:
- Value of FindNumBins.
-
setFindNumBins
public void setFindNumBins(boolean newFindNumBins) Set the value of FindNumBins.- Parameters:
newFindNumBins- Value to assign to FindNumBins.
-
makeBinaryTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getMakeBinary
public boolean getMakeBinary()Gets whether binary attributes should be made for discretized ones.- Returns:
- true if attributes will be binarized
-
setMakeBinary
public void setMakeBinary(boolean makeBinary) Sets whether binary attributes should be made for discretized ones.- Parameters:
makeBinary- if binary attributes are to be made
-
useBinNumbersTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getUseBinNumbers
public boolean getUseBinNumbers()Gets whether bin numbers rather than ranges should be used for discretized attributes.- Returns:
- true if bin numbers should be used
-
setUseBinNumbers
public void setUseBinNumbers(boolean useBinNumbers) Sets whether bin numbers rather than ranges should be used for discretized attributes.- Parameters:
useBinNumbers- if bin numbers should be used
-
desiredWeightOfInstancesPerIntervalTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getDesiredWeightOfInstancesPerInterval
public double getDesiredWeightOfInstancesPerInterval()Get the DesiredWeightOfInstancesPerInterval value.- Returns:
- the DesiredWeightOfInstancesPerInterval value.
-
setDesiredWeightOfInstancesPerInterval
public void setDesiredWeightOfInstancesPerInterval(double newDesiredNumber) Set the DesiredWeightOfInstancesPerInterval value.- Parameters:
newDesiredNumber- The new DesiredNumber value.
-
useEqualFrequencyTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getUseEqualFrequency
public boolean getUseEqualFrequency()Get the value of UseEqualFrequency.- Returns:
- Value of UseEqualFrequency.
-
setUseEqualFrequency
public void setUseEqualFrequency(boolean newUseEqualFrequency) Set the value of UseEqualFrequency.- Parameters:
newUseEqualFrequency- Value to assign to UseEqualFrequency.
-
binsTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getBins
public int getBins()Gets the number of bins numeric attributes will be divided into- Returns:
- the number of bins.
-
setBins
public void setBins(int numBins) Sets the number of bins to divide each selected numeric attribute into- Parameters:
numBins- the number of bins
-
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 removed or kept- Returns:
- true if the supplied columns will be kept
-
setInvertSelection
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
-
attributeIndicesTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getAttributeIndices
Gets the current range selection- Returns:
- a string containing a comma separated list of ranges
-
setAttributeIndices
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:
IllegalArgumentException- if an invalid range list is supplied
-
setAttributeIndicesArray
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:
IllegalArgumentException- if an invalid set of ranges is supplied
-
spreadAttributeWeightTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setSpreadAttributeWeight
public void setSpreadAttributeWeight(boolean p) If true, when generating binary attributes, spread weight of old attribute across new attributes. Do not give each new attribute the old weight.- Parameters:
p- whether weight is spread
-
getSpreadAttributeWeight
public boolean getSpreadAttributeWeight()If true, when generating binary attributes, spread weight of old attribute across new attributes. Do not give each new attribute the old weight.- Returns:
- whether weight is spread
-
binRangePrecisionTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setBinRangePrecision
public void setBinRangePrecision(int p) Set the precision for bin boundaries. Only affects the boundary values used in the labels for the converted attributes; internal cutpoints are at full double precision.- Parameters:
p- the precision for bin boundaries
-
getBinRangePrecision
public int getBinRangePrecision()Get the precision for bin boundaries. Only affects the boundary values used in the labels for the converted attributes; internal cutpoints are at full double precision.- Returns:
- the precision for bin boundaries
-
getCutPoints
public double[] getCutPoints(int attributeIndex) Gets the cut points for an attribute- Parameters:
attributeIndex- 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 has been discretized into only one interval.)
-
getBinRangesString
Gets the bin ranges string for an attribute- Parameters:
attributeIndex- the index (from 0) of the attribute to get the bin ranges string of- Returns:
- the bin ranges string (or null if the attribute requested has been discretized into only one interval.)
-
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
-