|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweka.filters.Filter
weka.filters.unsupervised.instance.RemoveFrequentValues
public class RemoveFrequentValues
Determines which values (frequent or infrequent ones) of an (nominal) attribute are retained and filters the instances accordingly. In case of values with the same frequency, they are kept in the way they appear in the original instances object. E.g. if you have the values "1,2,3,4" with the frequencies "10,5,5,3" and you chose to keep the 2 most common values, the values "1,2" would be returned, since the value "2" comes before "3", even though they have the same frequency.
Valid options are:-C <num> Choose attribute to be used for selection.
-N <num> Number of values to retain for the sepcified attribute, i.e. the ones with the most instances (default 2).
-L Instead of values with the most instances the ones with the least are retained.
-H When selecting on nominal attributes, removes header references to excluded values.
-V Invert matching sense.
Constructor Summary | |
---|---|
RemoveFrequentValues()
|
Method Summary | |
---|---|
java.lang.String |
attributeIndexTipText()
Returns the tip text for this property |
boolean |
batchFinished()
Signifies that this batch of input to the filter is finished. |
void |
determineValues(Instances inst)
determines the values to retain, it is always at least 1 and up to the maximum number of distinct values |
java.lang.String |
getAttributeIndex()
Get the index of the attribute used. |
Capabilities |
getCapabilities()
Returns the Capabilities of this filter. |
boolean |
getInvertSelection()
Get whether the supplied columns are to be removed or kept |
boolean |
getModifyHeader()
Gets whether the header will be modified when selecting on nominal attributes. |
int |
getNumValues()
Gets how many values are retained |
java.lang.String[] |
getOptions()
Gets the current settings of the filter. |
java.lang.String |
getRevision()
Returns the revision string. |
boolean |
getUseLeastValues()
Gets whether to use values with least or most instances |
java.lang.String |
globalInfo()
Returns a string describing this filter |
boolean |
input(Instance instance)
Input an instance for filtering. |
java.lang.String |
invertSelectionTipText()
Returns the tip text for this property |
boolean |
isNominal()
Returns true if selection attribute is nominal. |
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 |
modifyHeaderTipText()
Returns the tip text for this property |
java.lang.String |
numValuesTipText()
Returns the tip text for this property |
void |
setAttributeIndex(java.lang.String attIndex)
Sets index of the attribute used. |
boolean |
setInputFormat(Instances instanceInfo)
Sets the format of the input instances. |
void |
setInvertSelection(boolean invert)
Set whether selected values should be removed or kept. |
void |
setModifyHeader(boolean newModifyHeader)
Sets whether the header will be modified when selecting on nominal attributes. |
void |
setNumValues(int numValues)
Sets how many values are retained |
void |
setOptions(java.lang.String[] options)
Parses a given list of options. |
void |
setUseLeastValues(boolean leastValues)
Sets whether to use values with least or most instances |
java.lang.String |
useLeastValuesTipText()
Returns the tip text for this property |
Methods inherited from class weka.filters.Filter |
---|
batchFilterFile, filterFile, getCapabilities, 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 RemoveFrequentValues()
Method Detail |
---|
public java.lang.String globalInfo()
public java.util.Enumeration listOptions()
listOptions
in interface OptionHandler
public void setOptions(java.lang.String[] options) throws java.lang.Exception
-C <num> Choose attribute to be used for selection.
-N <num> Number of values to retain for the sepcified attribute, i.e. the ones with the most instances (default 2).
-L Instead of values with the most instances the ones with the least are retained.
-H When selecting on nominal attributes, removes header references to excluded values.
-V Invert matching sense.
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 attributeIndexTipText()
public java.lang.String getAttributeIndex()
public void setAttributeIndex(java.lang.String attIndex)
attIndex
- the index of the attributepublic java.lang.String numValuesTipText()
public int getNumValues()
public void setNumValues(int numValues)
numValues
- the number of values to retainpublic java.lang.String useLeastValuesTipText()
public boolean getUseLeastValues()
public void setUseLeastValues(boolean leastValues)
leastValues
- whether values with least or most instances are retainedpublic java.lang.String modifyHeaderTipText()
public boolean getModifyHeader()
public void setModifyHeader(boolean newModifyHeader)
newModifyHeader
- true if so.public java.lang.String invertSelectionTipText()
public boolean getInvertSelection()
public void setInvertSelection(boolean invert)
invert
- the new invert settingpublic boolean isNominal()
public void determineValues(Instances inst)
inst
- the Instances to determine the values from which are keptpublic 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).
UnsupportedAttributeTypeException
- if the specified attribute
is not nominal.
java.lang.Exception
- if the inputFormat can't be set successfullypublic boolean input(Instance instance)
input
in class Filter
instance
- the input instance
java.lang.IllegalStateException
- if no input format has been set.public boolean batchFinished()
batchFinished
in class Filter
java.lang.IllegalStateException
- if no input structure has been definedpublic 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 |