weka.filters.supervised.attribute

Class PartitionMembership

java.lang.Object

weka.filters.Filter

weka.filters.supervised.attribute.PartitionMembership

All Implemented Interfaces:

Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler, SupervisedFilter

public class PartitionMembership
extends Filter
implements SupervisedFilter, OptionHandler, RevisionHandler

A filter that uses a PartitionGenerator to generate partition membership values; filtered instances are composed of these values plus the class attribute (if set in the input data) and rendered as sparse instances.

Valid options are:

 -W <name of partition generator>
  Full name of partition generator to use, e.g.:
   weka.classifiers.trees.J48
  Additional options after the '--'.
  (default: weka.classifiers.trees.J48)
 

Options after the -- are passed on to the clusterer.

Version:

$Revision: 10215 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz), Mark Hall (mhall@cs.waikato.ac.nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartitionMembership()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	batchFinished() Signify that this batch of input to the filter is finished.
Capabilities	getCapabilities() Returns the Capabilities of this filter.
String[]	getOptions() Gets the current settings of the filter.
PartitionGenerator	getPartitionGenerator() Get the generator used by this filter
String	getRevision() Returns the revision string.
String	globalInfo() Returns a string describing this filter
boolean	input(Instance instance) Input an instance for filtering.
Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(String[] argv) Main method for testing this class.
String	partitionGeneratorTipText() Returns a description of this option suitable for display as a tip text in the gui.
boolean	setInputFormat(Instances instanceInfo) Sets the format of the input instances.
void	setOptions(String[] options) Parses a given list of options.
void	setPartitionGenerator(PartitionGenerator newPartitionGenerator) Set the generator for use in filtering

Methods inherited from class weka.filters.Filter

batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, runFilter, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionMembership

public PartitionMembership()

Method Detail

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

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws Exception

Sets the format of the input instances.

Overrides:

setInputFormat in class Filter

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 inputFormat can't be set successfully

batchFinished

public boolean batchFinished()
                      throws Exception

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

Overrides:

batchFinished in class Filter

Returns:

true if there are instances pending output

Throws:

IllegalStateException - if no input structure has been defined

NullPointerException - if no input structure has been defined,

Exception - if there was a problem finishing the batch.

input

public boolean input(Instance instance)
              throws Exception

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:

input in class Filter

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.

NullPointerException - if the input format has not been defined.

Exception - if the input instance was not of the correct format or if there was a problem with the filtering.

listOptions

public Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

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:

 -W <name of partition generator>
  Full name of partition generator to use, e.g.:
   weka.classifiers.trees.J48
  Additional options after the '--'.
  (default: weka.classifiers.trees.J48)
 

Options after the -- are passed on to the clusterer.

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

getOptions

public String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

globalInfo

public String globalInfo()

Returns a string describing this filter

Returns:

a description of the filter suitable for displaying in the explorer/experimenter gui

partitionGeneratorTipText

public String partitionGeneratorTipText()

Returns a description of this option suitable for display as a tip text in the gui.

Returns:

description of this option

setPartitionGenerator

public void setPartitionGenerator(PartitionGenerator newPartitionGenerator)

Set the generator for use in filtering

Parameters:

newPartitionGenerator - the generator to use

getPartitionGenerator

public PartitionGenerator getPartitionGenerator()

Get the generator used by this filter

Returns:

the generator used

main

public static void main(String[] argv)

Main method for testing this class.

Parameters:

argv - should contain arguments to the filter: use -h for help

getRevision

public String getRevision()

Description copied from class: Filter

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class Filter

Returns:

the revision