Package weka.filters.unsupervised.instance.instanceweightsmodifiers

Class FixedValue

java.lang.Object

weka.filters.unsupervised.instance.instanceweightsmodifiers.AbstractInstanceWeightsModifier

weka.filters.unsupervised.instance.instanceweightsmodifiers.AbstractRangeBasedInstanceWeightsModifier

weka.filters.unsupervised.instance.instanceweightsmodifiers.FixedValue

All Implemented Interfaces:

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

public class FixedValue
extends AbstractRangeBasedInstanceWeightsModifier

Uses a user-supplied instance weight on all the instances in the defined range.

Valid options are:

 -weight <number>
  The instance weight to use.
  (default: 1.0)

 -R <range>
  The row range to work on.
 This is a comma separated list of row indices, with "first" and "last" valid values.
  Specify an inclusive range with "-".
  E.g: "first-3,5,6-10,last".
  (default: first-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
FixedValue()

Method Summary

Modifier and Type	Method	Description
weka.core.Instances	determineOutputFormat(weka.core.Instances inputFormat)	Returns the new output format.
String[]	getOptions()	Gets the current settings of the filter.
double	getWeight()	Gets the current weight.
String	globalInfo()	Returns a string describing this scheme.
Enumeration<weka.core.Option>	listOptions()	Returns an enumeration describing the available options.
void	setOptions(String[] options)	Parses a given list of options.
void	setWeight(double value)	Sets the weight to use.
String	weightTipText()	Returns the tip text for this property.

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

doNotCheckCapabilitiesTipText, getCapabilities, getCapabilities, getDoNotCheckCapabilities, modifyInstanceWeights, setDoNotCheckCapabilities

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

getRowIndices, rowIndicesTipText, setRowIndices

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedValue

public FixedValue()

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 AbstractRangeBasedInstanceWeightsModifier

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 AbstractRangeBasedInstanceWeightsModifier

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 AbstractRangeBasedInstanceWeightsModifier

Returns:

an array of strings suitable for passing to setOptions

setWeight

public void setWeight(double value)

Sets the weight to use.

Parameters:

value - the weight

getWeight

public double getWeight()

Gets the current weight.

Returns:

the weight

weightTipText

public String weightTipText()

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