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.
 

See Also:

StreamableFilter, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Filter[]	m_Filters The filters.
protected int[]	m_IndicesUnused the indices of the unused attributes.
protected Range[]	m_Ranges The attribute ranges.
protected boolean	m_RemoveUnused Whether unused attributes are left out of the output.

Fields inherited from class weka.filters.Filter

m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
PartitionedMultiFilter()

Method Summary

Modifier and Type	Method and Description
protected void	checkDimensions() checks whether the dimensions of filters and ranges fit together.
protected Instances	determineOutputFormat(Instances inputFormat) Determines the output format based only on the full input dataset and returns this otherwise null is returned.
protected void	determineUnusedIndices(Instances data) determines the indices of unused attributes (ones that are not covered by any of the range).
java.lang.String	filtersTipText() Returns the tip text for this property.
protected Instances	generateSubset(Instances data, Range range) generates a subset of the dataset with only the attributes from the range (class is always added if present).
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.
protected java.lang.String	getFilterSpec(Filter filter) returns the filter classname and the options as one string.
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.
protected Instances	process(Instances instances) Processes the given data (may change the provided dataset) and returns the modified version.
java.lang.String	rangesTipText() Returns the tip text for this property.
java.lang.String	removeUnusedTipText() Returns the tip text for this property.
protected Instances	renameAttributes(Instances data, java.lang.String prefix) renames all the attributes in the dataset (excluding the class if present) by adding the prefix to the name.
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.
protected void	testInputFormat(Instances instanceInfo) tests the data whether the filter can actually handle it.

Methods inherited from class weka.filters.SimpleBatchFilter

allowAccessToFullInputFormat, batchFinished, hasImmediateOutputFormat, input

Methods inherited from class weka.filters.SimpleFilter

reset, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, setOutputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Filters

protected Filter[] m_Filters

The filters.

m_Ranges

protected Range[] m_Ranges

The attribute ranges.

m_RemoveUnused

protected boolean m_RemoveUnused

Whether unused attributes are left out of the output.

m_IndicesUnused

protected int[] m_IndicesUnused

the indices of the unused attributes.

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

checkDimensions

protected void checkDimensions()
                        throws java.lang.Exception

checks whether the dimensions of filters and ranges fit together.

Throws:

java.lang.Exception - if dimensions differ

testInputFormat

protected void testInputFormat(Instances instanceInfo)
                        throws java.lang.Exception

tests the data whether the filter can actually handle it.

Overrides:

testInputFormat in class Filter

Parameters:

instanceInfo - the data to test

Throws:

java.lang.Exception - if the test fails

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

getFilterSpec

protected java.lang.String getFilterSpec(Filter filter)

returns the filter classname and the options as one string.

Parameters:

filter - the filter to get the specs for

Returns:

the classname plus options

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

determineUnusedIndices

protected void determineUnusedIndices(Instances data)

determines the indices of unused attributes (ones that are not covered by any of the range).

Parameters:

data - the data to base the determination on

See Also:

m_IndicesUnused

generateSubset

protected Instances generateSubset(Instances data,
                                   Range range)
                            throws java.lang.Exception

generates a subset of the dataset with only the attributes from the range (class is always added if present).

Parameters:

data - the data to work on

range - the range of attribute to use

Returns:

the generated subset

Throws:

java.lang.Exception - if creation fails

renameAttributes

protected Instances renameAttributes(Instances data,
                                     java.lang.String prefix)
                              throws java.lang.Exception

renames all the attributes in the dataset (excluding the class if present) by adding the prefix to the name.

Parameters:

data - the data to work on

prefix - the prefix for the attributes

Returns:

a copy of the data with the attributes renamed

Throws:

java.lang.Exception - if renaming fails

determineOutputFormat

protected Instances determineOutputFormat(Instances inputFormat)
                                   throws java.lang.Exception

Determines the output format based only on the full input dataset and returns this otherwise null is returned. 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:

java.lang.Exception - in case the determination goes wrong

See Also:

SimpleBatchFilter.hasImmediateOutputFormat(), SimpleBatchFilter.batchFinished()

process

protected Instances process(Instances instances)
                     throws java.lang.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:

java.lang.Exception - in case the processing goes wrong

See Also:

SimpleBatchFilter.batchFinished()

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