org.joone.util

Class UnNormalizerOutputPlugIn

java.lang.Object

org.joone.util.AbstractConverterPlugIn

org.joone.util.OutputConverterPlugIn

org.joone.util.UnNormalizerOutputPlugIn

All Implemented Interfaces:

java.io.Serializable, PlugInListener

public class UnNormalizerOutputPlugIn
extends OutputConverterPlugIn

UnNormalizes the input data within a predefined range. To enable the UnNormalizer to find the min and max within the input data specify zero values for setInDataMin and setInDataMax. To set user defined values for the input data max and min in a serie then specify non-zero values for setInDataMin and setInDataMax.

The PlugIn supports two modes - Buffered and UnBuffered.

Buffered Mode

If the StreamOutputSynapse that this PlugIn is attached to is in buffered mode then the PlugIn can either search for input data min/max values if getInDataMin()==0 and getInDataMax()==0 or if either of these methods returns a non-zero value then it will use these values.

UnBuffered Mode

If the StreamOutputSynapse that this PlugIn is attached to is not in buffered mode then one of the methods setInDataMin or setInDataMax should have been called with a non-zero value. If this is not the case then this converter will not convert any data.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnNormalizerOutputPlugIn() The default UnNormalizerOutputPlugIn constructor.
UnNormalizerOutputPlugIn(java.lang.String newAdvSerieSel, double newInDataMin, double newInDataMax, double newOutDataMin, double newOutDataMax) This constructor enables a new UnNormalizerOutputPlugin to be fully constructed during initialisation.

Method Summary

Modifier and Type	Method and Description
double	getInDataMax() Gets the max value of the input data set
double	getInDataMin() Gets the min value of the input data set
double	getOutDataMax() Gets the max output value
double	getOutDataMin() Gets the min output value
void	setInDataMax(double newMax) Sets the max value of the input data set
void	setInDataMin(double newMin) Sets the min value of the input data set
void	setOutDataMax(double newMax) Sets the new max value for the output data set.
void	setOutDataMin(double newMin) Sets the new min value for the output data set.

Methods inherited from class org.joone.util.OutputConverterPlugIn

addOutputPluginListener, convertAllPatterns, convertPattern, removeOutputPluginListener, setPattern

Methods inherited from class org.joone.util.AbstractConverterPlugIn

addPlugIn, addPlugInListener, check, convertPatterns, dataChanged, getAdvancedSerieSelector, getName, getNextPlugIn, isConnected, removeAllPlugIns, removePlugInListener, setAdvancedSerieSelector, setConnected, setInputVector, setName, setNextPlugin, setNextPlugIn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnNormalizerOutputPlugIn

public UnNormalizerOutputPlugIn()

The default UnNormalizerOutputPlugIn constructor.

UnNormalizerOutputPlugIn

public UnNormalizerOutputPlugIn(java.lang.String newAdvSerieSel,
                                double newInDataMin,
                                double newInDataMax,
                                double newOutDataMin,
                                double newOutDataMax)

This constructor enables a new UnNormalizerOutputPlugin to be fully constructed during initialisation. The format of the Advanced Serie Selector parameter newAdvSerieSel can be found in the javadoc documentation for setAdvancedSerieSelector in the OutputConverterPlugIn class.

Parameters:

newAdvSerieSel - The new range of serie that should be converted by this plugin.

newInDataMin - The minimum value to be found in the input data.

newInDataMax - The maximum value to be found in the input data.

newOutDataMin - The minimum value of the unnormalised output data.

newOutDataMax - The maximum value of the unnormalised output data.

Method Detail

getOutDataMax

public double getOutDataMax()

Gets the max output value

Returns:

double The max output value

getOutDataMin

public double getOutDataMin()

Gets the min output value

Returns:

double The min output value

setOutDataMax

public void setOutDataMax(double newMax)

Sets the new max value for the output data set.

Parameters:

newMax - double The new max value of the output data serie.

setOutDataMin

public void setOutDataMin(double newMin)

Sets the new min value for the output data set.

Parameters:

newMin - double The new min value of the output data serie.

getInDataMax

public double getInDataMax()

Gets the max value of the input data set

Returns:

double The max value of the input data set

getInDataMin

public double getInDataMin()

Gets the min value of the input data set

Returns:

double The min value of the input data set

setInDataMax

public void setInDataMax(double newMax)

Sets the max value of the input data set

Parameters:

newMax - double The new max value of the input data serie.

setInDataMin

public void setInDataMin(double newMin)

Sets the min value of the input data set

Parameters:

newMin - double The new min value of the input data serie.