Class PartitionedMultiFilter

java.lang.Object
weka.filters.Filter
weka.filters.SimpleFilter
weka.filters.SimpleBatchFilter
weka.filters.unsupervised.attribute.PartitionedMultiFilter
All Implemented Interfaces:
Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler

public class PartitionedMultiFilter extends SimpleBatchFilter implements WeightedInstancesHandler, WeightedAttributesHandler
A filter that applies filters on subsets of attributes and assembles the output into a new dataset. Attributes that are not covered by any of the ranges can be either retained or removed from the output.

Valid options are:

 -D
  Turns on output of debugging information.
 
 -F <classname [options]>
  A filter to apply (can be specified multiple times).
 
 -R <range>
  An attribute range (can be specified multiple times).
  For each filter a range must be supplied. 'first' and 'last'
  are valid indices. 'inv(...)' around the range denotes an
  inverted range.
 
 -U
  Flag for leaving unused attributes out of the output, by default
  these are included in the filter output.
 
Version:
$Revision: 14508 $
Author:
FracPete (fracpete at waikato dot ac dot nz)
See Also:
  • Constructor Details

    • PartitionedMultiFilter

      public PartitionedMultiFilter()
  • Method Details

    • globalInfo

      public String globalInfo()
      Returns a string describing this filter.
      Specified by:
      globalInfo in class SimpleFilter
      Returns:
      a description of the filter suitable for displaying in the explorer/experimenter gui
    • listOptions

      public Enumeration<Option> listOptions()
      Returns an enumeration describing the available options.
      Specified by:
      listOptions in interface OptionHandler
      Overrides:
      listOptions in class Filter
      Returns:
      an enumeration of all the available options.
    • setOptions

      public void setOptions(String[] options) throws Exception
      Parses a list of options for this object.

      Valid options are:

       -D
        Turns on output of debugging information.
       
       -F <classname [options]>
        A filter to apply (can be specified multiple times).
       
       -R <range>
        An attribute range (can be specified multiple times).
        For each filter a range must be supplied. 'first' and 'last'
        are valid indices. 'inv(...)' around the range denotes an
        inverted range.
       
       -U
        Flag for leaving unused attributes out of the output, by default
        these are included in the filter output.
       
      Specified by:
      setOptions in interface OptionHandler
      Overrides:
      setOptions in class 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 filter.
      Specified by:
      getOptions in interface OptionHandler
      Overrides:
      getOptions in class Filter
      Returns:
      an array of strings suitable for passing to setOptions
    • setRemoveUnused

      public void setRemoveUnused(boolean value)
      Sets whether unused attributes (ones that are not covered by any of the ranges) are removed from the output.
      Parameters:
      value - if true then the unused attributes get removed
    • getRemoveUnused

      public boolean getRemoveUnused()
      Gets whether unused attributes (ones that are not covered by any of the ranges) are removed from the output.
      Returns:
      true if unused attributes are removed
    • removeUnusedTipText

      public String removeUnusedTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setFilters

      public void setFilters(Filter[] filters)
      Sets the list of possible filters to choose from. Also resets the state of the filter (this reset doesn't affect the options).
      Parameters:
      filters - an array of filters with all options set.
      See Also:
      • SimpleFilter.reset()
    • getFilters

      public Filter[] getFilters()
      Gets the list of possible filters to choose from.
      Returns:
      the array of Filters
    • filtersTipText

      public String filtersTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • getFilter

      public Filter getFilter(int index)
      Gets a single filter from the set of available filters.
      Parameters:
      index - the index of the filter wanted
      Returns:
      the Filter
    • setRanges

      public void setRanges(Range[] Ranges)
      Sets the list of possible Ranges to choose from. Also resets the state of the Range (this reset doesn't affect the options).
      Parameters:
      Ranges - an array of Ranges with all options set.
      See Also:
      • SimpleFilter.reset()
    • getRanges

      public Range[] getRanges()
      Gets the list of possible Ranges to choose from.
      Returns:
      the array of Ranges
    • rangesTipText

      public String rangesTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • getRange

      public Range getRange(int index)
      Gets a single Range from the set of available Ranges.
      Parameters:
      index - the index of the Range wanted
      Returns:
      the Range
    • 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 executing this class.
      Parameters:
      args - should contain arguments for the filter: use -h for help