Package weka.filters.unsupervised.instance.instanceweightsmodifiers

Class FromAttribute

java.lang.Object

weka.filters.unsupervised.instance.instanceweightsmodifiers.AbstractInstanceWeightsModifier

weka.filters.unsupervised.instance.instanceweightsmodifiers.FromAttribute

All Implemented Interfaces:

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

public class FromAttribute
extends AbstractInstanceWeightsModifier

Uses the values from a numeric attribute as instance weights.

Valid options are:

 -C <index>
  Specify the index of the attribute with the weights. First and last
  are valid indexes.(default: last)

 -do-not-check-capabilities
  If set, modifier capabilities are not checked
  (use with caution).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FromAttribute()

Method Summary

Modifier and Type	Method	Description
String	attributeIndexTipText()	Returns the tip text for this property.
weka.core.Instances	determineOutputFormat(weka.core.Instances inputFormat)	Returns the new output format.
String	getAttributeIndex()	Get the index of the attribute with the weights.
String[]	getOptions()	Gets the current settings of the filter.
String	globalInfo()	Returns a string describing this scheme.
Enumeration<weka.core.Option>	listOptions()	Returns an enumeration describing the available options.
void	setAttributeIndex(String value)	Sets index of the attribute with the weights.
void	setOptions(String[] options)	Parses a given list of options.

Methods inherited from class weka.filters.unsupervised.instance.instanceweightsmodifiers.AbstractInstanceWeightsModifier

doNotCheckCapabilitiesTipText, getCapabilities, getCapabilities, getDoNotCheckCapabilities, modifyInstanceWeights, setDoNotCheckCapabilities

Methods inherited from class java.lang.Object

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

Constructor Detail

FromAttribute

public FromAttribute()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing this scheme.

Specified by:

globalInfo in class AbstractInstanceWeightsModifier

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

Overrides:

listOptions in class AbstractInstanceWeightsModifier

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

Overrides:

setOptions in class AbstractInstanceWeightsModifier

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

Overrides:

getOptions in class AbstractInstanceWeightsModifier

Returns:

an array of strings suitable for passing to setOptions

setAttributeIndex

public void setAttributeIndex(String value)

Sets index of the attribute with the weights.

Parameters:

value - the index of the attribute

getAttributeIndex

public String getAttributeIndex()

Get the index of the attribute with the weights.

Returns:

the index of the attribute

attributeIndexTipText

public String attributeIndexTipText()

Returns the tip text for this property.

Returns:

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

determineOutputFormat

public weka.core.Instances determineOutputFormat(weka.core.Instances inputFormat)
                                          throws Exception

Returns the new output format.

Parameters:

inputFormat - the input format, before applying the weights

Returns:

the output format, after applying the weights

Throws:

Exception - if determination fails