Package weka.filters.unsupervised.instance

Class NonSparseToSparse

java.lang.Object

weka.filters.Filter

weka.filters.unsupervised.instance.NonSparseToSparse

All Implemented Interfaces:

Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter, UnsupervisedFilter

public class NonSparseToSparse
extends Filter
implements UnsupervisedFilter, StreamableFilter, OptionHandler, WeightedAttributesHandler, WeightedInstancesHandler

An instance filter that converts all incoming instances into sparse format.

Version:

$Revision$

Author:

Eibe Frank (eibe@cs.waikato.ac.nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NonSparseToSparse()

Method Summary

Modifier and Type	Method	Description
Capabilities	getCapabilities()	Returns the Capabilities of this filter.
String[]	getOptions()	Gets the current settings of the filter.
String	getRevision()	Returns the revision string.
boolean	getTreatMissingValuesAsZero()	Get whether missing values are to be treated in the same way as zeros
String	globalInfo()	Returns a string describing this filter
boolean	input(Instance instance)	Input an instance for filtering.
Enumeration<Option>	listOptions()	Returns an enumeration describing the available options.
static void	main(String[] argv)	Main method for testing this class.
boolean	setInputFormat(Instances instanceInfo)	Sets the format of the input instances.
void	setOptions(String[] options)	Parses a given list of options.
void	setTreatMissingValuesAsZero(boolean m)	Set whether missing values should be treated in the same way as zeros
String	treatMissingValuesAsZeroTipText()	Returns the tip text for this property

Methods inherited from class weka.filters.Filter

batchFilterFile, batchFinished, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NonSparseToSparse

public NonSparseToSparse()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing this filter

Returns:

a description of the filter suitable for displaying in the explorer/experimenter gui

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

listOptions

public 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(String[] options)
                throws Exception

Description copied from class: Filter

Parses a given list of options. Valid options are:

-D
If set, filter is run in debug mode and may output additional info to the console.

-do-not-check-capabilities
If set, filter capabilities are not checked before filter is built (use with caution).

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Filter

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

getOptions

public String[] getOptions()

Description copied from class: Filter

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

setTreatMissingValuesAsZero

public void setTreatMissingValuesAsZero(boolean m)

Set whether missing values should be treated in the same way as zeros

Parameters:

m - true if missing values are to be treated the same as zeros

getTreatMissingValuesAsZero

public boolean getTreatMissingValuesAsZero()

Get whether missing values are to be treated in the same way as zeros

Returns:

true if missing values are to be treated in the same way as zeros

treatMissingValuesAsZeroTipText

public String treatMissingValuesAsZeroTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws 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:

Exception - if format cannot be processed

input

public boolean input(Instance instance)
              throws 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:

IllegalStateException - if no input format has been set.

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.

getRevision

public 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(String[] argv)

Main method for testing this class.

Parameters:

argv - should contain arguments to the filter: use -h for help