Class AddCluster
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.AddCluster
- All Implemented Interfaces:
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:
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.
- Version:
- $Revision: 15204 $
- Author:
- Richard Kirkby (rkirkby@cs.waikato.ac.nz), FracPete (fracpete at waikato dot ac dot nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanSignify that this batch of input to the filter is finished.Returns the tip text for this property.Returns the Capabilities of this filter.getCapabilities(Instances data) Returns the Capabilities of this filter, makes sure that the class is never set (for the clusterer).Gets the clusterer used by the filter.Gets ranges of attributes to be ignored.String[]Gets the current settings of the filter.Returns the revision string.Gets the file pointing to a serialized, built clusterer.Returns a string describing this filter.Returns the tip text for this property.booleanInput an instance for filtering.Returns an enumeration describing the available options.static voidMain method for testing this class.Returns the tip text for this property.voidsetClusterer(Clusterer clusterer) Sets the clusterer to assign clusters with.voidsetIgnoredAttributeIndices(String rangeList) Sets the ranges of attributes to be ignored.booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetOptions(String[] options) Parses a given list of options.voidsetSerializedClustererFile(File value) Sets the file pointing to a serialized, built clusterer.Methods inherited from class weka.filters.Filter
batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
AddCluster
public AddCluster()
-
-
Method Details
-
getCapabilities
Returns the Capabilities of this filter, makes sure that the class is never set (for the clusterer).- Overrides:
getCapabilitiesin classFilter- Parameters:
data- the data to use for customization- Returns:
- the capabilities of this object, based on the data
- See Also:
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormatin classFilter- 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
Signify that this batch of input to the filter is finished.- Overrides:
batchFinishedin classFilter- Returns:
- true if there are instances pending output
- Throws:
IllegalStateException- if no input structure has been definedNullPointerException- if no input structure has been defined,Exception- if there was a problem finishing the batch.
-
input
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:
inputin classFilter- 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
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options.
-
setOptions
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:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of the filter.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
globalInfo
Returns a string describing this filter.- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
clustererTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setClusterer
Sets the clusterer to assign clusters with.- Parameters:
clusterer- The clusterer to be used (with its options set).
-
getClusterer
Gets the clusterer used by the filter.- Returns:
- The clusterer being used.
-
ignoredAttributeIndicesTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getIgnoredAttributeIndices
Gets ranges of attributes to be ignored.- Returns:
- a string containing a comma-separated list of ranges
-
setIgnoredAttributeIndices
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:
IllegalArgumentException- if an invalid range list is supplied
-
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
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
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classFilter- Returns:
- the revision
-
main
Main method for testing this class.- Parameters:
argv- should contain arguments to the filter: use -h for help
-