java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.statistics.AbstractArrayStatistic<T>
      - adams.data.statistics.ArrayNormalizeRange<T>

Type Parameters:: T - the data to process

All Implemented Interfaces:: AdditionalInformationHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractArrayStatistic>, SizeOfHandler, EqualLengthArrayStatistic, Serializable

public class ArrayNormalizeRange<T extends Number>
extends AbstractArrayStatistic<T>
implements EqualLengthArrayStatistic

Normalizes the array(s) to the specified lower and upper bound.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING

-lower <double> (property: lower)
    The lower bound to use.
    default: 0.0

-upper <double> (property: upper)
    The upper bound to use.
    default: 1.0

Author:: fracpete (fracpete at waikato dot ac dot nz)
See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class adams.data.statistics.AbstractArrayStatistic
  AbstractArrayStatistic.StatisticContainer<T extends Serializable>

Field Summary

Fields
Modifier and Type Field Description

protected double m_Lower
the lower bound.

protected double m_Upper
the upper bound.
- Fields inherited from class adams.data.statistics.AbstractArrayStatistic
  m_Data
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

ArrayNormalizeRange()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected AbstractArrayStatistic.StatisticContainer`	`doCalculate()`	Generates the actual result.
`int`	`getLength()`	Returns the length of the stored arrays.
`double`	`getLower()`	Returns the lower bound in use.
`int`	`getMax()`	Returns the maximum number of arrays that need to be present.
`int`	`getMin()`	Returns the minimum number of arrays that need to be present.
`double`	`getUpper()`	Returns the upper bound in use.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`lowerTipText()`	Returns the tip text for this property.
`void`	`setLower(double value)`	Sets the lower bound to use.
`void`	`setUpper(double value)`	Sets the upper bound to use.
`String`	`upperTipText()`	Returns the tip text for this property.

Methods inherited from class adams.data.statistics.AbstractArrayStatistic
add, calculate, check, checkEqualLength, clear, forCommandLine, forName, get, getAdditionalInformation, getStatistics, initialize, remove, set, shallowCopy, shallowCopy, size, toString

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Lower
```
protected double m_Lower
```
    the lower bound.
  - m_Upper
```
protected double m_Upper
```
    the upper bound.
- Constructor Detail
  - ArrayNormalizeRange
```
public ArrayNormalizeRange()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setLower
```
public void setLower(double value)
```
    Sets the lower bound to use.
    
    Parameters:
    
    value - the bound
  - getLower
```
public double getLower()
```
    Returns the lower bound in use.
    
    Returns:
    
    the bound
  - lowerTipText
```
public String lowerTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setUpper
```
public void setUpper(double value)
```
    Sets the upper bound to use.
    
    Parameters:
    
    value - the bound
  - getUpper
```
public double getUpper()
```
    Returns the upper bound in use.
    
    Returns:
    
    the bound
  - upperTipText
```
public String upperTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getLength
```
public int getLength()
```
    Returns the length of the stored arrays.
    
    Specified by:
    
    getLength in interface EqualLengthArrayStatistic
    
    Returns:
    
    the length of the arrays, -1 if none stored
  - getMin
```
public int getMin()
```
    Returns the minimum number of arrays that need to be present. -1 for unbounded.
    
    Specified by:
    
    getMin in class AbstractArrayStatistic<T extends Number>
    
    Returns:
    
    the minimum number, -1 for unbounded
  - getMax
```
public int getMax()
```
    Returns the maximum number of arrays that need to be present. -1 for unbounded.
    
    Specified by:
    
    getMax in class AbstractArrayStatistic<T extends Number>
    
    Returns:
    
    the maximum number, -1 for unbounded
  - doCalculate
```
protected AbstractArrayStatistic.StatisticContainer doCalculate()
```
    Generates the actual result.
    
    Specified by:
    
    doCalculate in class AbstractArrayStatistic<T extends Number>
    
    Returns:
    
    the generated result

Modifier and Type	Field	Description
`protected double`	`m_Lower`	the lower bound.
`protected double`	`m_Upper`	the upper bound.

Class ArrayNormalizeRange<T extends Number>

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.statistics.AbstractArrayStatistic

Field Summary

Fields inherited from class adams.data.statistics.AbstractArrayStatistic

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.data.statistics.AbstractArrayStatistic

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Field Detail

m_Lower

m_Upper

Constructor Detail

ArrayNormalizeRange

Method Detail

globalInfo

defineOptions

setLower

getLower

lowerTipText

setUpper

getUpper

upperTipText

getLength

getMin

getMax

doCalculate