|
||||||||||
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.ClusterMembership
public class ClusterMembership
A filter that uses a density-based clusterer to generate cluster membership values; filtered instances are composed of these values plus the class attribute (if set in the input data). If a (nominal) class attribute is set, the clusterer is run separately for each class. The class attribute (if set) and any user-specified attributes are ignored during the clustering operation
Valid options are:-W <clusterer name> Full name of clusterer to use. eg: weka.clusterers.EM Additional options after the '--'. (default: weka.clusterers.EM)
-I <att1,att2-att4,...> The range of attributes the clusterer should ignore. (the class attribute is automatically ignored)Options after the -- are passed on to the clusterer.
Constructor Summary | |
---|---|
ClusterMembership()
|
Method Summary | |
---|---|
boolean |
batchFinished()
Signify that this batch of input to the filter is finished. |
java.lang.String |
densityBasedClustererTipText()
Returns a description of this option suitable for display as a tip text in the gui. |
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). |
DensityBasedClusterer |
getDensityBasedClusterer()
Get the clusterer used by this 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.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. |
void |
setDensityBasedClusterer(DensityBasedClusterer newClusterer)
Set the clusterer for use in filtering |
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. |
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 ClusterMembership()
Method Detail |
---|
public Capabilities getCapabilities()
getCapabilities
in interface CapabilitiesHandler
getCapabilities
in class Filter
Capabilities
public Capabilities getCapabilities(Instances data)
getCapabilities
in class Filter
data
- the data to use for customization
getCapabilities()
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 name> Full name of clusterer to use. eg: weka.clusterers.EM Additional options after the '--'. (default: weka.clusterers.EM)
-I <att1,att2-att4,...> The range of attributes the clusterer should ignore. (the class attribute is automatically ignored)Options after the -- are passed on to the clusterer.
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 densityBasedClustererTipText()
public void setDensityBasedClusterer(DensityBasedClusterer newClusterer)
newClusterer
- the clusterer to usepublic DensityBasedClusterer getDensityBasedClusterer()
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.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 |