Class PartitionMembership
java.lang.Object
weka.filters.Filter
weka.filters.supervised.attribute.PartitionMembership
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,TechnicalInformationHandler,WeightedInstancesHandler,SupervisedFilter
public class PartitionMembership
extends Filter
implements SupervisedFilter, OptionHandler, RevisionHandler, TechnicalInformationHandler, WeightedInstancesHandler
* A filter that uses a PartitionGenerator to generate partition membership values; filtered instances are composed of these values plus the class attribute (if set in the input data) and rendered as sparse instances. See Section 3 of
* Eibe Frank, Bernhard Pfahringer: Propositionalisation of Multi-instance Data Using Random Forests. In: AI 2013: Advances in Artificial Intelligence, 362-373, 2013. *
* Valid options are:
* Eibe Frank, Bernhard Pfahringer: Propositionalisation of Multi-instance Data Using Random Forests. In: AI 2013: Advances in Artificial Intelligence, 362-373, 2013. *
* Valid options are:
* *
-W <name of partition generator> * Full name of partition generator to use, e.g.: * weka.classifiers.trees.J48 * Additional options after the '--'. * (default: weka.classifiers.trees.J48)* Options after the -- are passed on to the clusterer.
- Version:
- $Revision: 14534 $
- Author:
- Eibe Frank (eibe@cs.waikato.ac.nz), Mark Hall (mhall@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanSignify that this batch of input to the filter is finished.Returns the Capabilities of this filter.String[]Gets the current settings of the filter.Get the generator used by this filterReturns the revision string.Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.Returns a string describing this filterbooleanInput an instance for filtering.Returns an enumeration describing the available options.static voidMain method for testing this class.Returns a description of this option suitable for display as a tip text in the gui.booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetOptions(String[] options) Parses a given list of options.voidsetPartitionGenerator(PartitionGenerator newPartitionGenerator) Set the generator for use in filteringMethods inherited from class weka.filters.Filter
batchFilterFile, 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
-
Constructor Details
-
PartitionMembership
public PartitionMembership()
-
-
Method Details
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormatin classFilter- 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 inputFormat can't be set successfully
-
batchFinished
Signify that this batch of input to the filter is finished.- Overrides:
batchFinishedin classFilter- Returns:
- true if there are instances pending output
- Throws:
IllegalStateException- if no input structure has been definedNullPointerException- if no input structure has been defined,Exception- if there was a problem finishing the batch.
-
input
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:
inputin classFilter- 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 defined.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.
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. * Valid options are:* *
-W <name of partition generator> * Full name of partition generator to use, e.g.: * weka.classifiers.trees.J48 * Additional options after the '--'. * (default: weka.classifiers.trees.J48)
* Options after the -- are passed on to the clusterer.- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of the filter.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
globalInfo
Returns a string describing this filter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
getTechnicalInformation
Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.- Specified by:
getTechnicalInformationin interfaceTechnicalInformationHandler- Returns:
- the technical information about this class
-
partitionGeneratorTipText
Returns a description of this option suitable for display as a tip text in the gui.- Returns:
- description of this option
-
setPartitionGenerator
Set the generator for use in filtering- Parameters:
newPartitionGenerator- the generator to use
-
getPartitionGenerator
Get the generator used by this filter- Returns:
- the generator used
-
main
Main method for testing this class.- Parameters:
argv- should contain arguments to the filter: use -h for help
-
getRevision
Description copied from class:FilterReturns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classFilter- Returns:
- the revision
-