Class MultiRowProcessor
- java.lang.Object
-
- weka.filters.Filter
-
- weka.filters.SimpleFilter
-
- weka.filters.SimpleBatchFilter
-
- weka.filters.unsupervised.instance.MultiRowProcessor
-
- All Implemented Interfaces:
Serializable
,weka.core.CapabilitiesHandler
,weka.core.CapabilitiesIgnorer
,weka.core.CommandlineRunnable
,weka.core.OptionHandler
,weka.core.RevisionHandler
public class MultiRowProcessor extends weka.filters.SimpleBatchFilter
Uses the specified row selection scheme to identify groups of rows in the data coming through and then applies the selected row processor to these subsets.
Valid options are:-row-selection <value> The scheme for identifying the row subsets to process. (default: weka.filters.unsupervised.instance.multirowprocessor.selection.IndividualRows)
-selection-processor <value> The scheme for processing the identified row subsets. (default: weka.filters.unsupervised.instance.multirowprocessor.processor.PassThrough)
-output-debug-info If set, filter is run in debug mode and may output additional info to the console
-do-not-check-capabilities If set, filter capabilities are not checked before filter is built (use with caution).
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected AbstractRowSelection
m_RowSelection
the row selection scheme.protected AbstractSelectionProcessor
m_SelectionProcessor
the row processing scheme.protected static String
ROW_SELECTION
protected static String
SELECTION_PROCESSOR
-
Constructor Summary
Constructors Constructor Description MultiRowProcessor()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
debugMsg(String msg)
Outputs a debugging message on stderr.protected weka.core.Instances
determineOutputFormat(weka.core.Instances inputFormat)
Determines the output format based on the input format and returns this.weka.core.Capabilities
getCapabilities()
Returns the Capabilities of this filter.protected AbstractRowSelection
getDefaultRowSelection()
Returns the default row selection scheme.protected AbstractSelectionProcessor
getDefaultSelectionProcessor()
Returns the default selection processor.String[]
getOptions()
Gets the current settings of the classifier.String
getRevision()
Returns the revision string.AbstractRowSelection
getRowSelection()
Returns the row selection scheme in use.AbstractSelectionProcessor
getSelectionProcessor()
Returns the selection processor scheme in use.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 weka.core.Instances
process(weka.core.Instances instances)
Processes the given data (may change the provided dataset) and returns the modified version.String
rowSelectionTipText()
Returns the tip text for this property.String
selectionProcessorTipText()
Returns the tip text for this property.void
setOptions(String[] options)
Parses a given list of options.void
setRowSelection(AbstractRowSelection value)
Sets the row selection scheme to use.void
setSelectionProcessor(AbstractSelectionProcessor value)
Sets the selection processor scheme to use.-
Methods inherited from class weka.filters.SimpleBatchFilter
allowAccessToFullInputFormat, batchFinished, hasImmediateOutputFormat, input
-
Methods inherited from class weka.filters.Filter
batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper
-
-
-
-
Field Detail
-
ROW_SELECTION
protected static String ROW_SELECTION
-
m_RowSelection
protected AbstractRowSelection m_RowSelection
the row selection scheme.
-
SELECTION_PROCESSOR
protected static String SELECTION_PROCESSOR
-
m_SelectionProcessor
protected AbstractSelectionProcessor m_SelectionProcessor
the row processing scheme.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing this filter.- Specified by:
globalInfo
in classweka.filters.SimpleFilter
- 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 interfaceweka.core.OptionHandler
- Overrides:
listOptions
in classweka.filters.Filter
- 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 interfaceweka.core.OptionHandler
- Overrides:
setOptions
in classweka.filters.Filter
- 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 interfaceweka.core.OptionHandler
- Overrides:
getOptions
in classweka.filters.Filter
- Returns:
- an array of strings suitable for passing to setOptions
-
getDefaultRowSelection
protected AbstractRowSelection getDefaultRowSelection()
Returns the default row selection scheme.- Returns:
- the default
-
setRowSelection
public void setRowSelection(AbstractRowSelection value)
Sets the row selection scheme to use.- Parameters:
value
- the scheme
-
getRowSelection
public AbstractRowSelection getRowSelection()
Returns the row selection scheme in use.- Returns:
- the scheme
-
rowSelectionTipText
public String rowSelectionTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getDefaultSelectionProcessor
protected AbstractSelectionProcessor getDefaultSelectionProcessor()
Returns the default selection processor.- Returns:
- the processor
-
setSelectionProcessor
public void setSelectionProcessor(AbstractSelectionProcessor value)
Sets the selection processor scheme to use.- Parameters:
value
- the scheme
-
getSelectionProcessor
public AbstractSelectionProcessor getSelectionProcessor()
Returns the selection processor scheme in use.- Returns:
- the scheme
-
selectionProcessorTipText
public String selectionProcessorTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
debugMsg
protected void debugMsg(String msg)
Outputs a debugging message on stderr.- Parameters:
msg
- the message
-
getCapabilities
public weka.core.Capabilities getCapabilities()
Returns the Capabilities of this filter.- Specified by:
getCapabilities
in interfaceweka.core.CapabilitiesHandler
- Overrides:
getCapabilities
in classweka.filters.Filter
- Returns:
- the capabilities of this object
- See Also:
Capabilities
-
determineOutputFormat
protected weka.core.Instances determineOutputFormat(weka.core.Instances inputFormat) throws Exception
Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., immediateOutputFormat() returns false, then this method will be called from batchFinished().- Specified by:
determineOutputFormat
in classweka.filters.SimpleFilter
- Parameters:
inputFormat
- the input format to base the output format on- Returns:
- the output format
- Throws:
Exception
- in case the determination goes wrong- See Also:
SimpleBatchFilter.hasImmediateOutputFormat()
,SimpleBatchFilter.batchFinished()
-
process
protected weka.core.Instances process(weka.core.Instances instances) throws Exception
Processes the given data (may change the provided dataset) and returns the modified version. This method is called in batchFinished().- Specified by:
process
in classweka.filters.SimpleFilter
- Parameters:
instances
- the data to process- Returns:
- the modified data
- Throws:
Exception
- in case the processing goes wrong- See Also:
SimpleBatchFilter.batchFinished()
-
getRevision
public String getRevision()
Returns the revision string.- Specified by:
getRevision
in interfaceweka.core.RevisionHandler
- Overrides:
getRevision
in classweka.filters.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
-
-