weka.filters.unsupervised.attribute

Class PartitionedMultiFilter

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.PartitionedMultiFilter

All Implemented Interfaces:

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

public class PartitionedMultiFilter
extends SimpleBatchFilter
implements WeightedInstancesHandler, WeightedAttributesHandler

A filter that applies filters on subsets of attributes and assembles the output into a new dataset. Attributes that are not covered by any of the ranges can be either retained or removed from the output.

Valid options are:

 -D
  Turns on output of debugging information.
 

 -F <classname [options]>
  A filter to apply (can be specified multiple times).
 

 -R <range>
  An attribute range (can be specified multiple times).
  For each filter a range must be supplied. 'first' and 'last'
  are valid indices. 'inv(...)' around the range denotes an
  inverted range.
 

 -U
  Flag for leaving unused attributes out of the output, by default
  these are included in the filter output.
 

Version:

$Revision: 14534 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

StreamableFilter, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartitionedMultiFilter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	filtersTipText() Returns the tip text for this property.
Filter	getFilter(int index) Gets a single filter from the set of available filters.
Filter[]	getFilters() Gets the list of possible filters to choose from.
java.lang.String[]	getOptions() Gets the current settings of the filter.
Range	getRange(int index) Gets a single Range from the set of available Ranges.
Range[]	getRanges() Gets the list of possible Ranges to choose from.
boolean	getRemoveUnused() Gets whether unused attributes (ones that are not covered by any of the ranges) are removed from the output.
java.lang.String	getRevision() Returns the revision string.
java.lang.String	globalInfo() Returns a string describing this filter.
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method for executing this class.
java.lang.String	rangesTipText() Returns the tip text for this property.
java.lang.String	removeUnusedTipText() Returns the tip text for this property.
void	setFilters(Filter[] filters) Sets the list of possible filters to choose from.
void	setOptions(java.lang.String[] options) Parses a list of options for this object.
void	setRanges(Range[] Ranges) Sets the list of possible Ranges to choose from.
void	setRemoveUnused(boolean value) Sets whether unused attributes (ones that are not covered by any of the ranges) are removed from the output.

Methods inherited from class weka.filters.SimpleBatchFilter

allowAccessToFullInputFormat, batchFinished, input, input

Methods inherited from class weka.filters.SimpleFilter

setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

PartitionedMultiFilter

public PartitionedMultiFilter()

Method Detail

globalInfo

public java.lang.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 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 list of options for this object.

Valid options are:

 -D
  Turns on output of debugging information.
 

 -F <classname [options]>
  A filter to apply (can be specified multiple times).
 

 -R <range>
  An attribute range (can be specified multiple times).
  For each filter a range must be supplied. 'first' and 'last'
  are valid indices. 'inv(...)' around the range denotes an
  inverted range.
 

 -U
  Flag for leaving unused attributes out of the output, by default
  these are included in the filter output.
 

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

setRemoveUnused

public void setRemoveUnused(boolean value)

Sets whether unused attributes (ones that are not covered by any of the ranges) are removed from the output.

Parameters:

value - if true then the unused attributes get removed

getRemoveUnused

public boolean getRemoveUnused()

Gets whether unused attributes (ones that are not covered by any of the ranges) are removed from the output.

Returns:

true if unused attributes are removed

removeUnusedTipText

public java.lang.String removeUnusedTipText()

Returns the tip text for this property.

Returns:

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

setFilters

public void setFilters(Filter[] filters)

Sets the list of possible filters to choose from. Also resets the state of the filter (this reset doesn't affect the options).

Parameters:

filters - an array of filters with all options set.

See Also:

SimpleFilter.reset()

getFilters

public Filter[] getFilters()

Gets the list of possible filters to choose from.

Returns:

the array of Filters

filtersTipText

public java.lang.String filtersTipText()

Returns the tip text for this property.

Returns:

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

getFilter

public Filter getFilter(int index)

Gets a single filter from the set of available filters.

Parameters:

index - the index of the filter wanted

Returns:

the Filter

setRanges

public void setRanges(Range[] Ranges)

Sets the list of possible Ranges to choose from. Also resets the state of the Range (this reset doesn't affect the options).

Parameters:

Ranges - an array of Ranges with all options set.

See Also:

SimpleFilter.reset()

getRanges

public Range[] getRanges()

Gets the list of possible Ranges to choose from.

Returns:

the array of Ranges

rangesTipText

public java.lang.String rangesTipText()

Returns the tip text for this property.

Returns:

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

getRange

public Range getRange(int index)

Gets a single Range from the set of available Ranges.

Parameters:

index - the index of the Range wanted

Returns:

the Range

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

Main method for executing this class.

Parameters:

args - should contain arguments for the filter: use -h for help