/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 *    MathExpression.java
 *    Copyright (C) 2004 Prados Julien
 *    Copyright (C) 2002-2012 University of Waikato, Hamilton, New Zealand
 */

package weka.filters.unsupervised.attribute;

import java.util.Collections;
import java.util.Enumeration;
import java.util.Vector;

import weka.core.*;
import weka.core.Capabilities.Capability;
import weka.core.expressionlanguage.common.IfElseMacro;
import weka.core.expressionlanguage.common.JavaMacro;
import weka.core.expressionlanguage.common.MacroDeclarationsCompositor;
import weka.core.expressionlanguage.common.MathFunctions;
import weka.core.expressionlanguage.common.Primitives.DoubleExpression;
import weka.core.expressionlanguage.common.SimpleVariableDeclarations;
import weka.core.expressionlanguage.common.SimpleVariableDeclarations.VariableInitializer;
import weka.core.expressionlanguage.common.VariableDeclarationsCompositor;
import weka.core.expressionlanguage.core.Node;
import weka.core.expressionlanguage.parser.Parser;
import weka.core.expressionlanguage.weka.InstancesHelper;
import weka.core.expressionlanguage.weka.StatsHelper;
import weka.experiment.Stats;
import weka.filters.UnsupervisedFilter;

/**
 *  Modify numeric attributes according to a given
 * mathematical expression. Supported operators are +, -, *,
 * /, pow, log, abs, cos, exp, sqrt, tan, sin, ceil, floor, rint, (, ), MEAN, MAX, MIN, SD, COUNT, SUM,
 * SUMSQUARED, ifelse. The 'A' letter refers to the value of the attribute being processed. Other attribute
 * values (numeric only) can be accessed through the variables A1, A2, A3, ...
 *
 * Example: pow(A,6)/(MEAN+MAX)*ifelse(A<0,0,sqrt(A))+ifelse(![A>9 && A<15])
 * 

* * * Valid options are: *

* *

 * -unset-class-temporarily
 *  Unsets the class index temporarily before the filter is
 *  applied to the data.
 *  (default: no)
 * 
* *
 * -E <expression>
 *  Specify the expression to apply.
 * 
* *
 * -R <index1,index2-index4,...>
 *  Specify list of columns to ignore. First and last are valid
 *  indexes. (default none)
 * 
* *
 * -V
 *  Invert matching sense (i.e. only modify specified columns)
 * 
* * * * @author Eibe Frank (eibe@cs.waikato.ac.nz) * @author Prados Julien (julien.prados@cui.unige.ch) * @version $Revision: 14508 $ */ public class MathExpression extends PotentialClassIgnorer implements UnsupervisedFilter, WeightedInstancesHandler, WeightedAttributesHandler { /** for serialization */ static final long serialVersionUID = -3713222714671997901L; /** Stores which columns to select as a funky range */ protected Range m_SelectCols = new Range(); /** The default modification expression */ public static final String m_defaultExpression = "(A-MIN)/(MAX-MIN)"; /** The modification expression */ private String m_expression = m_defaultExpression; /** The compiled modification expression */ private DoubleExpression m_CompiledExpression; /** Attributes statistics */ private Stats[] m_attStats; /** InstancesHelpers for different indices */ private InstancesHelper m_InstancesHelper; /** StatsHelpers for different indices */ private StatsHelper m_StatsHelper; /** VariableInitializer for the current value 'A' in an expression */ private VariableInitializer m_CurrentValue; /** * Constructor */ public MathExpression() { super(); setInvertSelection(false); } /** * Returns a string describing this filter * * @return a description of the filter suitable for displaying in the * explorer/experimenter gui */ public String globalInfo() { return "Modify numeric attributes according to a given mathematical expression. Supported operators are +, -, *, " + "/, pow, log, abs, cos, exp, sqrt, tan, sin, ceil, floor, rint, (, ), MEAN, MAX, MIN, SD, COUNT, SUM, " + "SUMSQUARED, ifelse. The 'A' letter refers to the value of the attribute being processed. Other attribute " + "values (numeric only) can be accessed through the variables A1, A2, A3, ... \n\nExample:" + "pow(A,6)/(MEAN+MAX)*ifelse(A<0,0,sqrt(A))+ifelse(![A>9 && A<15])"; } /** * Returns the Capabilities of this filter. * * @return the capabilities of this object * @see Capabilities */ @Override public Capabilities getCapabilities() { Capabilities result = super.getCapabilities(); result.disableAll(); // attributes result.enableAllAttributes(); result.enable(Capability.MISSING_VALUES); // class result.enableAllClasses(); result.enable(Capability.MISSING_CLASS_VALUES); result.enable(Capability.NO_CLASS); return result; } /** * Sets the format of the input instances. * * @param instanceInfo an Instances object containing the input instance * structure (any instances contained in the object are ignored - * only the structure is required). * @return true if the outputFormat may be collected immediately * @throws Exception if the input format can't be set successfully */ @Override public boolean setInputFormat(Instances instanceInfo) throws Exception { m_SelectCols.setUpper(instanceInfo.numAttributes() - 1); super.setInputFormat(instanceInfo); setOutputFormat(instanceInfo); m_attStats = new Stats[instanceInfo.numAttributes()]; for (int i = 0; i < instanceInfo.numAttributes(); i++) { if (m_SelectCols.isInRange(i) && instanceInfo.attribute(i).isNumeric() && (instanceInfo.classIndex() != i) || getIgnoreClass()) { m_attStats[i] = new Stats(); } } if (instanceInfo != null) compile(); return true; } /** * Compiles the expression * Requires that the input format is set and not null * * @throws Exception if a compilation error occurs */ private void compile() throws Exception { m_InstancesHelper = new InstancesHelper(getInputFormat()); m_StatsHelper = new StatsHelper(); SimpleVariableDeclarations currentValueDeclaration = new SimpleVariableDeclarations(); currentValueDeclaration.addDouble("A"); Node node = Parser.parse( // expression m_expression, // variables new VariableDeclarationsCompositor( m_InstancesHelper, m_StatsHelper, currentValueDeclaration ), // macros new MacroDeclarationsCompositor( m_InstancesHelper, new MathFunctions(), new IfElseMacro(), new JavaMacro() ) ); if (!(node instanceof DoubleExpression)) throw new Exception("Expression must be of type double!"); m_CurrentValue = currentValueDeclaration.getInitializer(); m_CompiledExpression = (DoubleExpression) node; } /** * Input an instance for filtering. Filter requires all training instances be * read before producing output. * * @param instance the input instance * @return true if the filtered instance may now be collected with output(). * @throws IllegalStateException if no input format has been set. */ @Override public boolean input(Instance instance) throws Exception { if (getInputFormat() == null) { throw new IllegalStateException("No input instance format defined"); } if (m_NewBatch) { resetQueue(); m_NewBatch = false; } if (!m_FirstBatchDone) { for (int i = 0; i < instance.numAttributes(); i++) { if (m_SelectCols.isInRange(i) && instance.attribute(i).isNumeric() && (getInputFormat().classIndex() != i) && (!instance.isMissing(i))) { m_attStats[i].add(instance.value(i), instance.weight()); } } bufferInput(instance); return false; } else { convertInstance(instance); return true; } } /** * Signify that this batch of input to the filter is finished. If the filter * requires all instances prior to filtering, output() may now be called to * retrieve the filtered instances. * * @return true if there are instances pending output * @throws IllegalStateException if no input structure has been defined */ @Override public boolean batchFinished() throws Exception { if (getInputFormat() == null) { throw new IllegalStateException("No input instance format defined"); } if (!m_FirstBatchDone) { Instances input = getInputFormat(); for (int i = 0; i < input.numAttributes(); i++) { if (m_SelectCols.isInRange(i) && input.attribute(i).isNumeric() && input.classIndex() != i) { m_attStats[i].calculateDerived(); } } // Convert pending input instances for (int i = 0; i < input.numInstances(); i++) { convertInstance(input.instance(i)); } } // Free memory flushInput(); m_NewBatch = true; m_FirstBatchDone = true; return (numPendingOutput() != 0); } /** * Convert a single instance over. The converted instance is added to the end * of the output queue. * * @param instance the instance to convert * @throws Exception if instance cannot be converted */ private void convertInstance(Instance instance) throws Exception { double[] vals = instance.toDoubleArray(); for (int i = 0; i < instance.numAttributes(); i++) { if ( m_SelectCols.isInRange(i) && instance.attribute(i).isNumeric() && !Utils.isMissingValue(vals[i]) && getInputFormat().classIndex() != i ) { // setup program m_InstancesHelper.setInstance(instance); m_StatsHelper.setStats(m_attStats[i]); if (m_CurrentValue.hasVariable("A")) m_CurrentValue.setDouble("A", vals[i]); // compute double value = m_CompiledExpression.evaluate(); // set new value if (Double.isNaN(value) || Double.isInfinite(value) || m_InstancesHelper.missingAccessed()) { System.err .println("WARNING:Error in evaluating the expression: missing value set"); vals[i] = Utils.missingValue(); } else { vals[i] = value; } } } Instance outInstance; if (instance instanceof SparseInstance) { outInstance = new SparseInstance(instance.weight(), vals); } else { outInstance = new DenseInstance(instance.weight(), vals); } outInstance.setDataset(instance.dataset()); push(outInstance, false); // No need to copy instance } /** * Parses a given list of options. *

* * Valid options are: *

* *

   * -unset-class-temporarily
   *  Unsets the class index temporarily before the filter is
   *  applied to the data.
   *  (default: no)
   * 
* *
   * -E <expression>
   *  Specify the expression to apply.
   * 
* *
   * -R <index1,index2-index4,...>
   *  Specify list of columns to ignore. First and last are valid
   *  indexes. (default none)
   * 
* *
   * -V
   *  Invert matching sense (i.e. only modify specified columns)
   * 
* * * * @param options the list of options as an array of strings * @throws Exception if an option is not supported */ @Override public void setOptions(String[] options) throws Exception { String expString = Utils.getOption('E', options); if (expString.length() != 0) { setExpression(expString); } else { setExpression(m_defaultExpression); } String ignoreList = Utils.getOption('R', options); if (ignoreList.length() != 0) { setIgnoreRange(ignoreList); } setInvertSelection(Utils.getFlag('V', options)); super.setOptions(options); Utils.checkForRemainingOptions(options); } /** * Gets the current settings of the filter. * * @return an array of strings suitable for passing to setOptions */ @Override public String[] getOptions() { Vector result = new Vector(); result.add("-E"); result.add(getExpression()); if (getInvertSelection()) { result.add("-V"); } if (!getIgnoreRange().equals("")) { result.add("-R"); result.add(getIgnoreRange()); } Collections.addAll(result, super.getOptions()); return result.toArray(new String[result.size()]); } /** * Returns an enumeration describing the available options. * * @return an enumeration of all the available options. */ @Override public Enumeration

Ads help maintain this website.