CorrelationCoefficient (adams-pom 24.4.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.summarystatistics.AbstractSummaryStatistic
      - adams.flow.transformer.summarystatistics.AbstractNumericSummaryStatistic
        
        adams.flow.transformer.summarystatistics.CorrelationCoefficient

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, NumericSummaryStatistic, SummaryStatistic, Serializable
```
public class CorrelationCoefficient
extends AbstractNumericSummaryStatistic
```
Calculates the correlation coefficient.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.flow.transformer.summarystatistics.AbstractNumericSummaryStatistic
  m_NumericActual, m_NumericPredicted
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel
- Fields inherited from interface adams.flow.transformer.summarystatistics.NumericSummaryStatistic
  MISSING_NUMERIC

Constructor Summary

Constructors
Constructor Description

CorrelationCoefficient()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected double[]`	`doCalculate()`	Calculates the summary statistics.
`String[]`	`getNames()`	Returns the names of the statistics.
`String`	`globalInfo()`	Returns a string describing the object.

Methods inherited from class adams.flow.transformer.summarystatistics.AbstractNumericSummaryStatistic
check, clear, getNumericActual, getNumericPredicted, setNumericActual, setNumericPredicted

Methods inherited from class adams.flow.transformer.summarystatistics.AbstractSummaryStatistic
calculate

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

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

Methods inherited from interface adams.flow.transformer.summarystatistics.SummaryStatistic
calculate

- Constructor Detail
  - CorrelationCoefficient
```
public CorrelationCoefficient()
```
- 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
  - getNames
```
public String[] getNames()
```
    Returns the names of the statistics.
    
    Returns:
    
    the names
  - doCalculate
```
protected double[] doCalculate()
```
    Calculates the summary statistics.
    
    Specified by:
    
    doCalculate in class AbstractSummaryStatistic
    
    Returns:
    
    the statistics