Package adams.data.spreadsheet.colstatistic

Class SignalToNoiseRatio

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.colstatistic.AbstractColumnStatistic

adams.data.spreadsheet.colstatistic.AbstractDoubleArrayColumnStatistic

adams.data.spreadsheet.colstatistic.SignalToNoiseRatio

All Implemented Interfaces:

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

public class SignalToNoiseRatio
extends AbstractDoubleArrayColumnStatistic
implements TechnicalInformationHandler

Calculates the signal to noise ratio for a numeric column.
For more information, see:
WikiPedia. Signal-to-noise ratio.

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

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.spreadsheet.colstatistic.AbstractDoubleArrayColumnStatistic

m_Values

Fields inherited from class adams.data.spreadsheet.colstatistic.AbstractColumnStatistic

m_LastError

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
SignalToNoiseRatio()

Method Summary

Modifier and Type	Method	Description
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
String	globalInfo()	Returns a string describing the object.
protected SpreadSheet	postVisit(SpreadSheet sheet, int colIndex)	Finishes up the stats generation after all the cells have been visited.

Methods inherited from class adams.data.spreadsheet.colstatistic.AbstractDoubleArrayColumnStatistic

doVisit, preVisit

Methods inherited from class adams.data.spreadsheet.colstatistic.AbstractColumnStatistic

check, createOutputHeader, doGenerate, generate, getLastError, hasLastError

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

Constructor Detail

SignalToNoiseRatio

public SignalToNoiseRatio()

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

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Returns:

the technical information about this class

postVisit

protected SpreadSheet postVisit(SpreadSheet sheet,
                                int colIndex)

Finishes up the stats generation after all the cells have been visited.

Specified by:

postVisit in class AbstractColumnStatistic

Parameters:

sheet - the spreadsheet to generate the stats for

colIndex - the column index

Returns:

the generated stats