weka.filters.unsupervised.attribute

Class PropositionalToMultiInstance

java.lang.Object

weka.filters.Filter

weka.filters.unsupervised.attribute.PropositionalToMultiInstance

All Implemented Interfaces:

Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler, UnsupervisedFilter

public class PropositionalToMultiInstance
extends Filter
implements OptionHandler, UnsupervisedFilter

Converts the propositional instance dataset into multi-instance dataset (with relational attribute). When normalize or standardize a multi-instance dataset, a MIToSingleInstance filter can be applied first to convert the multi-instance dataset into propositional instance dataset. After normalization or standardization, may use this PropositionalToMultiInstance filter to convert the data back to multi-instance format.

Note: the first attribute of the original propositional instance dataset must be a nominal attribute which is expected to be bagId attribute.

Valid options are:

 -S <num>
  The seed for the randomization of the order of bags. (default 1)

 -R
  Randomizes the order of the produced bags after the generation. (default off)

Version:

$Revision: 5547 $

Author:

Lin Dong (ld21@cs.waikato.ac.nz)

See Also:

MultiInstanceToPropositional, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected RelationalLocator	m_BagRelAtts Indices of relational attributes in the bag
protected StringLocator	m_BagStringAtts Indices of string attributes in the bag
protected boolean	m_Randomize whether to randomize the output data
protected int	m_Seed the seed for randomizing, default is 1

Fields inherited from class weka.filters.Filter

m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
PropositionalToMultiInstance()

Method Summary

Modifier and Type	Method and Description
protected void	addBag(Instances input, Instances output, Instances bagInsts, int bagIndex, double classValue, double bagWeight) adds a new bag out of the given data and adds it to the output
boolean	batchFinished() Signify that this batch of input to the filter is finished.
Capabilities	getCapabilities() Returns the Capabilities of this filter.
String[]	getOptions() Gets the current settings of the classifier.
boolean	getRandomize() Gets whether the order of the generated is randomized
String	getRevision() Returns the revision string.
int	getSeed() Returns the current seed value for randomizing the order of the generated data
String	globalInfo() Returns a string describing this filter
Enumeration	listOptions() Returns an enumeration describing the available options
static void	main(String[] args) Main method for running this filter.
protected void	push(Instance instance) Adds an output instance to the queue.
String	randomizeTipText() Returns the tip text for this property
String	seedTipText() Returns the tip text for this property
boolean	setInputFormat(Instances instanceInfo) Sets the format of the input instances.
void	setOptions(String[] options) Parses a given list of options.
void	setRandomize(boolean value) Sets whether the order of the generated data is randomized
void	setSeed(int value) Sets the new seed for randomizing the order of the generated data

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, filterFile, flushInput, getCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, input, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputFormatPeek, outputPeek, resetQueue, runFilter, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Seed

protected int m_Seed

the seed for randomizing, default is 1

m_Randomize

protected boolean m_Randomize

whether to randomize the output data

m_BagStringAtts

protected StringLocator m_BagStringAtts

Indices of string attributes in the bag

m_BagRelAtts

protected RelationalLocator m_BagRelAtts

Indices of relational attributes in the bag

Constructor Detail

PropositionalToMultiInstance

public PropositionalToMultiInstance()

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

listOptions

public Enumeration listOptions()

Returns an enumeration describing the available options

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a given list of options.

Valid options are:

 -S <num>
  The seed for the randomization of the order of bags. (default 1)

 -R
  Randomizes the order of the produced bags after the generation. (default off)

Specified by:

setOptions in interface 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 classifier.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

seedTipText

public String seedTipText()

Returns the tip text for this property

Returns:

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

setSeed

public void setSeed(int value)

Sets the new seed for randomizing the order of the generated data

Parameters:

value - the new seed value

getSeed

public int getSeed()

Returns the current seed value for randomizing the order of the generated data

Returns:

the current seed value

setRandomize

public void setRandomize(boolean value)

Sets whether the order of the generated data is randomized

Parameters:

value - whether to randomize or not

getRandomize

public boolean getRandomize()

Gets whether the order of the generated is randomized

Returns:

true if the order is randomized

randomizeTipText

public String randomizeTipText()

Returns the tip text for this property

Returns:

tip text for this property 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

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 the input format can't be set successfully

addBag

protected void addBag(Instances input,
                      Instances output,
                      Instances bagInsts,
                      int bagIndex,
                      double classValue,
                      double bagWeight)

adds a new bag out of the given data and adds it to the output

Parameters:

input - the intput dataset

output - the dataset this bag is added to

bagInsts - the instances in this bag

bagIndex - the bagIndex of this bag

classValue - the associated class value

bagWeight - the weight of the bag

push

protected void push(Instance instance)

Adds an output instance to the queue. The derived class should use this method for each output instance it makes available.

Overrides:

push in class Filter

Parameters:

instance - the instance to be added to the queue.

batchFinished

public boolean batchFinished()

Signify that this batch of input to the filter is finished. If the filter requires all instances prior to filtering, output() may now be called to retrieve the filtered instances.

Overrides:

batchFinished in class Filter

Returns:

true if there are instances pending output

Throws:

IllegalStateException - if no input structure has been defined

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[] args)

Main method for running this filter.

Parameters:

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