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

Class weka.filters.unsupervised.attribute.AddCluster

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

public class AddCluster

extends Filter

implements UnsupervisedFilter, OptionHandler

Valid filter-specific options are:

-W clusterer string
Full class name of clusterer to use, followed by scheme options. (required)

-I range string
The range of attributes the clusterer should ignore.

Version:

$Revision: 1.2 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

AddCluster()

 

batchFinished()

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

clustererTipText()

Returns the tip text for this property

getClusterer()

Gets the clusterer used by the filter.

getIgnoredAttributeIndices()

Gets ranges of attributes to be ignored.

getOptions()

Gets the current settings of the filter.

globalInfo()

Returns a string describing this filter

ignoredAttributeIndicesTipText()

Returns the tip text for this property

listOptions()

Returns an enumeration describing the available options.

main(String[])

Main method for testing this class.

setClusterer(Clusterer)

Sets the clusterer to assign clusters with.

setIgnoredAttributeIndices(String)

Sets the ranges of attributes to be ignored.

setInputFormat(Instances)

Sets the format of the input instances.

setOptions(String[])

Parses the options for this object.

public AddCluster()

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

Overrides:

setInputFormat in class Filter

public boolean batchFinished() throws java.lang.Exception

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

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.util.Enumeration listOptions()

          Returns 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:

-W clusterer string
Full class name of clusterer to use, followed by scheme options. (required)

-I range string
The range of attributes the clusterer should ignore.

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 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 clustererTipText()

          Returns the tip text for this property

Returns:

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

public void setClusterer(Clusterer clusterer)

          Sets the clusterer to assign clusters with.

Parameters:

clusterer - The clusterer to be used (with its options set).

public Clusterer getClusterer()

          Gets the clusterer used by the filter.

Returns:

The clusterer being used.

public java.lang.String ignoredAttributeIndicesTipText()

          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 getIgnoredAttributeIndices()

          Gets ranges of attributes to be ignored.

Returns:

a string containing a comma-separated list of ranges

public void setIgnoredAttributeIndices(java.lang.String rangeList)

          Sets the ranges of attributes to be ignored. If provided string is null, no attributes will be ignored.

Parameters:

rangeList - a string representing the list of attributes. eg: first-3,5,6-last

Throws:

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

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