AbstractAutoCorrelation (adams-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.autocorrelation.AbstractAutoCorrelation

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

BruteForce, FFT
```
public abstract class AbstractAutoCorrelation
extends AbstractOptionHandler
```
Ancestor for autocorrelatin algorithms..

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- 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

AbstractAutoCorrelation()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`check(double[] data)`	Hook method for checks.
`double[]`	`correlate(double[] data)`	Performs autocorrelation on the data.
`protected abstract double[]`	`doCorrelate(double[] data)`	Performs the actual autocorrelation on the data.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

- Constructor Detail
  - AbstractAutoCorrelation
```
public AbstractAutoCorrelation()
```
- Method Detail
  - check
```
protected void check(double[] data)
```
    Hook method for checks.
    Default implementation does nothing.
    
    Parameters:
    
    data - the data to check
  - doCorrelate
```
protected abstract double[] doCorrelate(double[] data)
```
    Performs the actual autocorrelation on the data.
    
    Parameters:
    
    data - the data to process
    
    Returns:
    
    the processed data
  - correlate
```
public double[] correlate(double[] data)
```
    Performs autocorrelation on the data.
    
    Parameters:
    
    data - the data to process
    
    Returns:
    
    the processed data