Package weka.filters.unsupervised.instance.instanceweightsmodifiers

Class AbstractInstanceWeightsModifier

java.lang.Object

weka.filters.unsupervised.instance.instanceweightsmodifiers.AbstractInstanceWeightsModifier

All Implemented Interfaces:

Serializable, weka.core.CapabilitiesHandler, weka.core.OptionHandler, InstanceWeightsModifier

Direct Known Subclasses:

AbstractRangeBasedInstanceWeightsModifier, FromAttribute, FromFile, PassThrough

public abstract class AbstractInstanceWeightsModifier
extends Object
implements Serializable, weka.core.OptionHandler, InstanceWeightsModifier, weka.core.CapabilitiesHandler

Ancestor for instance weights modifiers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractInstanceWeightsModifier()

Method Summary

Modifier and Type	Method	Description
String	doNotCheckCapabilitiesTipText()	Returns the tip text for this property
weka.core.Capabilities	getCapabilities()	Returns the Capabilities of this filter.
weka.core.Capabilities	getCapabilities(weka.core.Instances data)	Returns the Capabilities of this filter, customized based on the data.
boolean	getDoNotCheckCapabilities()	Get whether capabilities checking is turned off.
String[]	getOptions()	Gets the current settings of the filter.
abstract String	globalInfo()	Returns a string describing this scheme.
Enumeration<weka.core.Option>	listOptions()	Returns an enumeration describing the available options.
weka.core.Instances	modifyInstanceWeights(weka.core.Instances data)	Modifies the instance weights.
void	setDoNotCheckCapabilities(boolean value)	Set whether not to check capabilities.
void	setOptions(String[] options)	Parses a given list of options.

Methods inherited from interface weka.filters.unsupervised.instance.instanceweightsmodifiers.InstanceWeightsModifier

determineOutputFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInstanceWeightsModifier

public AbstractInstanceWeightsModifier()

Method Detail

globalInfo

public abstract String globalInfo()

Returns a string describing this scheme.

Returns:

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

listOptions

public Enumeration<weka.core.Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a given list of options.

Specified by:

setOptions in interface weka.core.OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

getOptions

public String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface weka.core.OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setDoNotCheckCapabilities

public void setDoNotCheckCapabilities(boolean value)

Set whether not to check capabilities.

Parameters:

value - true if capabilities are not to be checked.

getDoNotCheckCapabilities

public boolean getDoNotCheckCapabilities()

Get whether capabilities checking is turned off.

Returns:

true if capabilities checking is turned off.

doNotCheckCapabilitiesTipText

public String doNotCheckCapabilitiesTipText()

Returns the tip text for this property

Returns:

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

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns the Capabilities of this filter. Derived filters have to override this method to enable capabilities.

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Returns:

the capabilities of this object

See Also:

Capabilities

getCapabilities

public weka.core.Capabilities getCapabilities(weka.core.Instances data)

Returns the Capabilities of this filter, customized based on the data. I.e., if removes all class capabilities, in case there's not class attribute present or removes the NO_CLASS capability, in case that there's a class present.

Parameters:

data - the data to use for customization

Returns:

the capabilities of this object, based on the data

See Also:

getCapabilities()

modifyInstanceWeights

public weka.core.Instances modifyInstanceWeights(weka.core.Instances data)
                                          throws Exception

Modifies the instance weights.

Specified by:

modifyInstanceWeights in interface InstanceWeightsModifier

Parameters:

data - the data to process

Returns:

the modified data

Throws:

Exception - if modifying fails