Package weka.filters.unsupervised.attribute

Class Copy

  • All Implemented Interfaces:
    java.io.Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler, StreamableFilter, UnsupervisedFilter
    public class Copy
extends Filter
implements UnsupervisedFilter, StreamableFilter, OptionHandler
    An instance filter that copies a range of attributes in the dataset. This is used in conjunction with other filters that overwrite attribute values during the course of their operation -- this filter allows the original attributes to be kept as well as the new attributes.

    Valid options are: 

     -R <index1,index2-index4,...>
  Specify list of columns to copy. First and last are valid
  indexes. (default none)
     -V
  Invert matching sense (i.e. copy all non-specified columns)
    Version:
    $Revision: 6996 $
    Author:
    Len Trigg (trigg@cs.waikato.ac.nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • Copy

        public Copy()

    • Method Detail

      • listOptions

        public java.util.Enumeration listOptions()
        Returns an enumeration describing the available options.
        Specified by:
        listOptions in interface OptionHandler
        Returns:
        an enumeration of all the available options.

      • setOptions

        public void setOptions​(java.lang.String[] options)
                throws java.lang.Exception
        Parses a given list of options.

        Valid options are: 

         -R <index1,index2-index4,...>
  Specify list of columns to copy. First and last are valid
  indexes. (default none)
         -V
  Invert matching sense (i.e. copy all non-specified columns)
        Specified by:
        setOptions in interface OptionHandler
        Parameters:
        options - the list of options as an array of strings
        Throws:
        java.lang.Exception - if an option is not supported

      • getOptions

        public java.lang.String[] getOptions()
        Gets the current settings of the filter.
        Specified by:
        getOptions in interface OptionHandler
        Returns:
        an array of strings suitable for passing to setOptions

      • setInputFormat

        public boolean setInputFormat​(Instances instanceInfo)
                       throws java.lang.Exception
        Sets the format of the input instances.
        Overrides:
        setInputFormat in class Filter
        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:
        java.lang.Exception - if a problem occurs setting the input format

      • input

        public boolean input​(Instance instance)
        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:
        input in class Filter
        Parameters:
        instance - the input instance
        Returns:
        true if the filtered instance may now be collected with output().
        Throws:
        java.lang.IllegalStateException - if no input format has been defined.

      • globalInfo

        public java.lang.String globalInfo()
        Returns a string describing this filter
        Returns:
        a description of the filter suitable for displaying in the explorer/experimenter gui

      • invertSelectionTipText

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

      • getInvertSelection

        public boolean getInvertSelection()
        Get whether the supplied columns are to be removed or kept
        Returns:
        true if the supplied columns will be kept

      • setInvertSelection

        public void setInvertSelection​(boolean invert)
        Set whether selected columns should be removed or kept. If true the selected columns are kept and unselected columns are copied. If false selected columns are copied and unselected columns are kept.
        Note: use this method before you call setInputFormat(Instances), since the output format is determined in that method.
        Parameters:
        invert - the new invert setting

      • getAttributeIndices

        public java.lang.String getAttributeIndices()
        Get the current range selection
        Returns:
        a string containing a comma separated list of ranges

      • attributeIndicesTipText

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

      • setAttributeIndices

        public void setAttributeIndices​(java.lang.String rangeList)
                         throws java.lang.Exception
        Set which attributes are to be copied (or kept if invert is true)
        Parameters:
        rangeList - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from 1.
        eg: first-3,5,6-last
        Note: use this method before you call setInputFormat(Instances), since the output format is determined in that method.
        Throws:
        java.lang.Exception - if an invalid range list is supplied

      • setAttributeIndicesArray

        public void setAttributeIndicesArray​(int[] attributes)
                              throws java.lang.Exception
        Set which attributes are to be copied (or kept if invert is true)
        Parameters:
        attributes - an array containing indexes of attributes to select. Since the array will typically come from a program, attributes are indexed from 0.
        Note: use this method before you call setInputFormat(Instances), since the output format is determined in that method.
        Throws:
        java.lang.Exception - if an invalid set of ranges is supplied

      • main

        public static void main​(java.lang.String[] argv)
        Main method for testing this class.
        Parameters:
        argv - should contain arguments to the filter: use -h for help