org.knime.base.data.normalize
Class AffineTransConfiguration

java.lang.Object
  extended by org.knime.base.data.normalize.AffineTransConfiguration

public final class AffineTransConfiguration
extends Object

Configuration object for a AffineTransTable.

Author:
Bernd Wiswedel, University of Konstanz

Constructor Summary
AffineTransConfiguration()
          Default, no normalization on columns.
AffineTransConfiguration(String[] names, double[] scales, double[] translations, double[] min, double[] max, String summary)
           
 
Method Summary
 double[] getMax()
           
 double[] getMin()
           
 String[] getNames()
           
 double[] getScales()
           
 String getSummary()
           
 double[] getTranslations()
           
static AffineTransConfiguration load(ModelContentRO settings)
          Restores content.
protected  void save(ModelContentWO model)
          Saves this object to the argument model content.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AffineTransConfiguration

public AffineTransConfiguration()
Default, no normalization on columns.


AffineTransConfiguration

public AffineTransConfiguration(String[] names,
                                double[] scales,
                                double[] translations,
                                double[] min,
                                double[] max,
                                String summary)
Parameters:
names - The names of the columns being normalized
scales - the scale parameters (same order as names)
translations - the translation parameters
min - the minimum values (for sanity checks). If the normalized value is slightly off the desired minimum value because of rounding errors, it is set to this bounding value. Can be Double.NaN, then no checks are performed.
max - the maximum values (for sanity checks). If the normalized value is slightly off the desired maximum value because of rounding errors, it is set to this bounding value. Can be Double.NaN, then no checks are performed.
summary - Port summary
Throws:
NullPointerException - if any argument is null
IllegalArgumentException - if the arrays don't have the same length or the scales or translations arguments contain NaN.
Method Detail

getNames

public String[] getNames()
Returns:
The names of the columns being normalized (in order of the other array getters).

getScales

public double[] getScales()
Returns:
the scales

getTranslations

public double[] getTranslations()
Returns:
the translations

getMin

public double[] getMin()
Returns:
the min

getMax

public double[] getMax()
Returns:
the max

getSummary

public String getSummary()
Returns:
the summary

save

protected void save(ModelContentWO model)
Saves this object to the argument model content.

Parameters:
model - To write to.

load

public static AffineTransConfiguration load(ModelContentRO settings)
                                     throws InvalidSettingsException
Restores content.

Parameters:
settings - To load from.
Returns:
A new configuration object
Throws:
InvalidSettingsException - If that fails.


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.