AddCluster (interruptible-weka 0.1.2 API)

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

All Implemented Interfaces:: java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, UnsupervisedFilter

public class AddCluster
extends Filter
implements UnsupervisedFilter, OptionHandler, WeightedAttributesHandler, WeightedInstancesHandler

A filter that adds a new nominal attribute representing the cluster assigned to each instance by the specified clustering algorithm.
Either the clustering algorithm gets built with the first batch of data or one specifies are serialized clusterer model file to use instead.

Valid options are:

 -W <clusterer specification>
  Full class name of clusterer to use, followed
  by scheme options. eg:
   "weka.clusterers.SimpleKMeans -N 3"
  (default: weka.clusterers.SimpleKMeans)

 -serialized <file>
  Instead of building a clusterer on the data, one can also provide
  a serialized model and use that for adding the clusters.

 -I <att1,att2-att4,...>
  The range of attributes the clusterer should ignore.

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Clusterer`	`m_ActualClusterer` The actual clusterer used to do the clustering.
`protected Clusterer`	`m_Clusterer` The clusterer used to do the cleansing.
`protected Range`	`m_IgnoreAttributesRange` Range of attributes to ignore.
`protected Filter`	`m_removeAttributes` Filter for removing attributes.
`protected java.io.File`	`m_SerializedClustererFile` The file from which to load a serialized clusterer.

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

AddCluster()

Constructors
Constructor and Description
`AddCluster()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`batchFinished()` Signify that this batch of input to the filter is finished.
`java.lang.String`	`clustererTipText()` Returns the tip text for this property.
`protected void`	`convertInstance(Instance instance)` Convert a single instance over.
`Capabilities`	`getCapabilities()` Returns the Capabilities of this filter.
`Capabilities`	`getCapabilities(Instances data)` Returns the Capabilities of this filter, makes sure that the class is never set (for the clusterer).
`Clusterer`	`getClusterer()` Gets the clusterer used by the filter.
`protected java.lang.String`	`getClustererSpec()` Gets the clusterer specification string, which contains the class name of the clusterer and any options to the clusterer.
`java.lang.String`	`getIgnoredAttributeIndices()` Gets ranges of attributes to be ignored.
`java.lang.String[]`	`getOptions()` Gets the current settings of the filter.
`java.lang.String`	`getRevision()` Returns the revision string.
`java.io.File`	`getSerializedClustererFile()` Gets the file pointing to a serialized, built clusterer.
`java.lang.String`	`globalInfo()` Returns a string describing this filter.
`java.lang.String`	`ignoredAttributeIndicesTipText()` Returns the tip text for this property.
`boolean`	`input(Instance instance)` Input an instance for filtering.
`java.util.Enumeration<Option>`	`listOptions()` Returns an enumeration describing the available options.
`static void`	`main(java.lang.String[] argv)` Main method for testing this class.
`protected Instances`	`removeIgnored(Instances data)` filters all attributes that should be ignored.
`java.lang.String`	`serializedClustererFileTipText()` Returns the tip text for this property.
`void`	`setClusterer(Clusterer clusterer)` Sets the clusterer to assign clusters with.
`void`	`setIgnoredAttributeIndices(java.lang.String rangeList)` Sets the ranges of attributes to be ignored.
`boolean`	`setInputFormat(Instances instanceInfo)` Sets the format of the input instances.
`void`	`setOptions(java.lang.String[] options)` Parses a given list of options.
`void`	`setSerializedClustererFile(java.io.File value)` Sets the file pointing to a serialized, built clusterer.
`protected void`	`testInputFormat(Instances instanceInfo)` tests the data whether the filter can actually handle it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_Clusterer
```
protected Clusterer m_Clusterer
```
    The clusterer used to do the cleansing.
  - m_SerializedClustererFile
```
protected java.io.File m_SerializedClustererFile
```
    The file from which to load a serialized clusterer.
  - m_ActualClusterer
```
protected Clusterer m_ActualClusterer
```
    The actual clusterer used to do the clustering.
  - m_IgnoreAttributesRange
```
protected Range m_IgnoreAttributesRange
```
    Range of attributes to ignore.
  - m_removeAttributes
```
protected Filter m_removeAttributes
```
    Filter for removing attributes.
- Constructor Detail
  - AddCluster
```
public AddCluster()
```
- Method Detail
  - getCapabilities
```
public Capabilities getCapabilities(Instances data)
```
    Returns the Capabilities of this filter, makes sure that the class is never set (for the clusterer).
    
    Overrides:
    
    getCapabilities in class Filter
    
    Parameters:
    
    data - the data to use for customization
    
    Returns:
    
    the capabilities of this object, based on the data
    
    See Also:
    
    getCapabilities()
  - 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
  - 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
  - setInputFormat
```
public boolean setInputFormat(Instances instanceInfo)
                       throws java.lang.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:
    
    java.lang.Exception - if the inputFormat can't be set successfully
  - removeIgnored
```
protected Instances removeIgnored(Instances data)
                           throws java.lang.Exception
```
    filters all attributes that should be ignored.
    
    Parameters:
    
    data - the data to filter
    
    Returns:
    
    the filtered data
    
    Throws:
    
    java.lang.Exception - if filtering fails
  - batchFinished
```
public boolean batchFinished()
                      throws java.lang.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:
    
    java.lang.IllegalStateException - if no input structure has been defined
    
    java.lang.NullPointerException - if no input structure has been defined,
    
    java.lang.Exception - if there was a problem finishing the batch.
  - input
```
public boolean input(Instance instance)
              throws java.lang.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:
    
    java.lang.IllegalStateException - if no input format has been defined.
    
    java.lang.NullPointerException - if the input format has not been defined.
    
    java.lang.Exception - if the input instance was not of the correct format or if there was a problem with the filtering.
  - convertInstance
```
protected void convertInstance(Instance instance)
                        throws java.lang.Exception
```
    Convert a single instance over. The converted instance is added to the end of the output queue.
    
    Parameters:
    
    instance - the instance to convert
    
    Throws:
    
    java.lang.Exception - if something goes wrong
  - 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 given list of options.
    Valid options are:
```
 -W <clusterer specification>
  Full class name of clusterer to use, followed
  by scheme options. eg:
   "weka.clusterers.SimpleKMeans -N 3"
  (default: weka.clusterers.SimpleKMeans)
 
```
```
 -serialized <file>
  Instead of building a clusterer on the data, one can also provide
  a serialized model and use that for adding the clusters.
 
```
```
 -I <att1,att2-att4,...>
  The range of attributes the clusterer should ignore.
 
```
    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
  - globalInfo
```
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
  - clustererTipText
```
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
  - setClusterer
```
public void setClusterer(Clusterer clusterer)
```
    Sets the clusterer to assign clusters with.
    
    Parameters:
    
    clusterer - The clusterer to be used (with its options set).
  - getClusterer
```
public Clusterer getClusterer()
```
    Gets the clusterer used by the filter.
    
    Returns:
    
    The clusterer being used.
  - getClustererSpec
```
protected java.lang.String getClustererSpec()
```
    Gets the clusterer specification string, which contains the class name of the clusterer and any options to the clusterer.
    
    Returns:
    
    the clusterer string.
  - ignoredAttributeIndicesTipText
```
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
  - getIgnoredAttributeIndices
```
public java.lang.String getIgnoredAttributeIndices()
```
    Gets ranges of attributes to be ignored.
    
    Returns:
    
    a string containing a comma-separated list of ranges
  - setIgnoredAttributeIndices
```
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
  - getSerializedClustererFile
```
public java.io.File getSerializedClustererFile()
```
    Gets the file pointing to a serialized, built clusterer. If it is null or pointing to a directory it will not be used.
    
    Returns:
    
    the file the serialized, built clusterer is located in
  - setSerializedClustererFile
```
public void setSerializedClustererFile(java.io.File value)
```
    Sets the file pointing to a serialized, built clusterer. If the argument is null, doesn't exist or pointing to a directory, then the value is ignored.
    
    Parameters:
    
    value - the file pointing to the serialized, built clusterer
  - serializedClustererFileTipText
```
public java.lang.String serializedClustererFileTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - 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[] argv)
```
    Main method for testing this class.
    
    Parameters:
    
    argv - should contain arguments to the filter: use -h for help

Class AddCluster

Field Summary

Fields inherited from class weka.filters.Filter

Constructor Summary

Method Summary

Methods inherited from class weka.filters.Filter

Methods inherited from class java.lang.Object

Field Detail

m_Clusterer

m_SerializedClustererFile

m_ActualClusterer

m_IgnoreAttributesRange

m_removeAttributes

Constructor Detail

AddCluster

Method Detail

getCapabilities

getCapabilities

testInputFormat

setInputFormat

removeIgnored

batchFinished

input

convertInstance

listOptions

setOptions

getOptions

globalInfo

clustererTipText

setClusterer

getClusterer

getClustererSpec

ignoredAttributeIndicesTipText

getIgnoredAttributeIndices

setIgnoredAttributeIndices

getSerializedClustererFile

setSerializedClustererFile

serializedClustererFileTipText

getRevision

main