|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweka.filters.Filter
weka.filters.unsupervised.attribute.AddCluster
public class AddCluster
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.
-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.
Constructor Summary | |
---|---|
AddCluster()
|
Method Summary | |
---|---|
boolean |
batchFinished()
Signify that this batch of input to the filter is finished. |
java.lang.String |
clustererTipText()
Returns the tip text for this property. |
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. |
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 |
listOptions()
Returns an enumeration describing the available options. |
static void |
main(java.lang.String[] argv)
Main method for testing this class. |
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. |
Methods inherited from class weka.filters.Filter |
---|
batchFilterFile, filterFile, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AddCluster()
Method Detail |
---|
public Capabilities getCapabilities(Instances data)
getCapabilities
in class Filter
data
- the data to use for customization
getCapabilities()
public Capabilities getCapabilities()
getCapabilities
in interface CapabilitiesHandler
getCapabilities
in class Filter
Capabilities
public boolean setInputFormat(Instances instanceInfo) throws java.lang.Exception
setInputFormat
in class Filter
instanceInfo
- an Instances object containing the input instance
structure (any instances contained in the object are ignored - only the
structure is required).
java.lang.Exception
- if the inputFormat can't be set successfullypublic boolean batchFinished() throws java.lang.Exception
batchFinished
in class Filter
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.public boolean input(Instance instance) throws java.lang.Exception
input
in class Filter
instance
- the input instance
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.public java.util.Enumeration listOptions()
listOptions
in interface OptionHandler
public void setOptions(java.lang.String[] options) throws java.lang.Exception
-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.
setOptions
in interface OptionHandler
options
- the list of options as an array of strings
java.lang.Exception
- if an option is not supportedpublic java.lang.String[] getOptions()
getOptions
in interface OptionHandler
public java.lang.String globalInfo()
public java.lang.String clustererTipText()
public void setClusterer(Clusterer clusterer)
clusterer
- The clusterer to be used (with its options set).public Clusterer getClusterer()
public java.lang.String ignoredAttributeIndicesTipText()
public java.lang.String getIgnoredAttributeIndices()
public void setIgnoredAttributeIndices(java.lang.String rangeList)
rangeList
- a string representing the list of attributes.
eg: first-3,5,6-last
java.lang.IllegalArgumentException
- if an invalid range list is suppliedpublic java.io.File getSerializedClustererFile()
public void setSerializedClustererFile(java.io.File value)
value
- the file pointing to the serialized, built clustererpublic java.lang.String serializedClustererFileTipText()
public java.lang.String getRevision()
getRevision
in interface RevisionHandler
getRevision
in class Filter
public static void main(java.lang.String[] argv)
argv
- should contain arguments to the filter: use -h for help
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |