Package weka.filters.unsupervised.attribute

Class SAX

  • All Implemented Interfaces:
    Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, weka.core.RevisionHandler, weka.filters.StreamableFilter
    public class SAX
extends weka.filters.SimpleStreamFilter
    A simple filter that retains only every nth attribute.

    Valid options are: 

     -nth <int>
  Only every n-th point will be output (>0).
  (default: 1)
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_bins
      number of gaussian bins.
      protected double[] m_bps
      breakpoints.
      protected boolean m_OutputNominal
      If true output nominal, false output numeric .
      protected int m_windows
      number of windows.

      • Fields inherited from class weka.filters.Filter

        m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

    • Constructor Summary

      Constructors 
      Constructor Description
      SAX()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String binsPointTipText()
      Returns the tip text for this property.
      protected weka.core.Instances determineOutputFormat​(weka.core.Instances inputFormat)
      Determines the output format based on the input format and returns this.
      int getBins()
      Returns the nth point setting.
      weka.core.Capabilities getCapabilities()
      Returns the Capabilities of this filter.
      protected double[] getMeanStdev​(weka.core.Instance in)
      Return an array where the 1st value is the mean, and the 2nd the standard deviation of the attribute values.
      boolean getNominal()
      Gets whether output numeric or nominal values.
      String[] getOptions()
      Gets the current settings of the filter.
      String getRevision()
      Returns the revision string.
      int getWindows()
      Returns the nth point setting.
      String globalInfo()
      Returns a string describing this classifier.
      Enumeration listOptions()
      Returns an enumeration describing the available options.
      static void main​(String[] args)
      Main method for testing this class.
      String nominalTipText()
      Returns the tip text for this property.
      protected weka.core.Instance process​(weka.core.Instance instance)
      processes the given instance (may change the provided instance) and returns the modified version.
      void setBins​(int value)
      Sets the nth point setting.
      void setNominal​(boolean nominal)
      Sets whether to output nominal or numeric values.
      void setOptions​(String[] options)
      Parses a list of options for this object.
      void setWindows​(int value)
      Sets the nth point setting.
      String windowsPointTipText()
      Returns the tip text for this property.

      • Methods inherited from class weka.filters.SimpleStreamFilter

        batchFinished, hasImmediateOutputFormat, input, preprocess, process

      • Methods inherited from class weka.filters.SimpleFilter

        reset, setInputFormat

      • Methods inherited from class weka.filters.Filter

        batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCopyOfInputFormat, 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

      • m_bins

        protected int m_bins
        number of gaussian bins. (labels)

      • m_windows

        protected int m_windows
        number of windows.

      • m_OutputNominal

        protected boolean m_OutputNominal
        If true output nominal, false output numeric .

      • m_bps

        protected double[] m_bps
        breakpoints.

    • Constructor Detail

      • SAX

        public SAX()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing this classifier.
        Specified by:
        globalInfo in class weka.filters.SimpleFilter
        Returns:
        a description of the classifier 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 list of options for this object. Also resets the state of the filter (this reset doesn't affect the 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
        See Also:
        SimpleFilter.reset()

      • getOptions

        public String[] getOptions()
        Gets the current settings of the filter.
        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

      • nominalTipText

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

      • setNominal

        public void setNominal​(boolean nominal)
        Sets whether to output nominal or numeric values.
        Parameters:
        dontNormalize - if true the values are not normalized

      • getNominal

        public boolean getNominal()
        Gets whether output numeric or nominal values.
        Returns:
        false if values get normalized

      • setBins

        public void setBins​(int value)
        Sets the nth point setting.
        Parameters:
        value - the nth point

      • setWindows

        public void setWindows​(int value)
        Sets the nth point setting.
        Parameters:
        value - the nth point

      • getBins

        public int getBins()
        Returns the nth point setting.
        Returns:
        the order

      • getWindows

        public int getWindows()
        Returns the nth point setting.
        Returns:
        the order

      • binsPointTipText

        public String binsPointTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • windowsPointTipText

        public String windowsPointTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getCapabilities

        public weka.core.Capabilities getCapabilities()
        Returns the Capabilities of this filter. Derived filters have to override this method to enable capabilities.
        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., hasImmediateOutputFormat() returns false, then this method will called from batchFinished() after the call of preprocess(Instances), in which, e.g., statistics for the actual processing step can be gathered.
        Specified by:
        determineOutputFormat in class weka.filters.SimpleStreamFilter
        Parameters:
        inputFormat - the input format to base the output format on
        Returns:
        the output format
        Throws:
        Exception - in case the determination goes wrong

      • getMeanStdev

        protected double[] getMeanStdev​(weka.core.Instance in)
        Return an array where the 1st value is the mean, and the 2nd the standard deviation of the attribute values.
        Parameters:
        in - instance
        Returns:
        mean, stdev

      • process

        protected weka.core.Instance process​(weka.core.Instance instance)
                              throws Exception
        processes the given instance (may change the provided instance) and returns the modified version.
        Specified by:
        process in class weka.filters.SimpleStreamFilter
        Parameters:
        instance - the instance to process
        Returns:
        the modified data
        Throws:
        Exception - in case the processing goes wrong

      • 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 testing this class.
        Parameters:
        args - should contain arguments to the filter: use -h for help