Package weka.filters.unsupervised.instance

Class 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 Detail

      • ROW_SELECTION

        protected static String ROW_SELECTION

      • SELECTION_PROCESSOR

        protected static String SELECTION_PROCESSOR

    • Constructor Detail

      • MultiRowProcessor

        public MultiRowProcessor()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing this filter.
        Specified by:
        globalInfo in class weka.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 interface weka.core.OptionHandler
        Overrides:
        listOptions in class weka.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 interface weka.core.OptionHandler
        Overrides:
        setOptions in class weka.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 interface weka.core.OptionHandler
        Overrides:
        getOptions in class weka.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 interface weka.core.CapabilitiesHandler
        Overrides:
        getCapabilities in class weka.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 class weka.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 class weka.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 interface weka.core.RevisionHandler
        Overrides:
        getRevision in class weka.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