Package adams.data.spreadsheet.rowstatistic

Class StandardDeviation

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowstatistic.AbstractRowStatistic

adams.data.spreadsheet.rowstatistic.AbstractDoubleArrayRowStatistic

adams.data.spreadsheet.rowstatistic.StandardDeviation

All Implemented Interfaces:

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

public class StandardDeviation
extends AbstractDoubleArrayRowStatistic

Calculates the standard deviation (population or sample).

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

-is-sample <boolean> (property: isSample)
    If set to true, the columns are treated as samples and not as populations.
    default: true
 

Version:

$Revision: 9765 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_IsSample	whether the arrays are samples or populations.

Fields inherited from class adams.data.spreadsheet.rowstatistic.AbstractDoubleArrayRowStatistic

m_Values

Fields inherited from class adams.data.spreadsheet.rowstatistic.AbstractRowStatistic

m_ColumnIndices, m_Columns, 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
StandardDeviation()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getIsSample()	Returns whether the columns represent samples instead of populations.
String	globalInfo()	Returns a string describing the object.
String	isSampleTipText()	Returns the tip text for this property.
protected SpreadSheet	postVisit(SpreadSheet sheet, int rowIndex)	Finishes up the stats generation after all the cells have been visited.
void	setIsSample(boolean value)	Sets whether the columns represent samples instead of populations.

Methods inherited from class adams.data.spreadsheet.rowstatistic.AbstractDoubleArrayRowStatistic

doVisit, preVisit

Methods inherited from class adams.data.spreadsheet.rowstatistic.AbstractRowStatistic

check, columnsTipText, createOutputHeader, doGenerate, generate, getColumns, getLastError, hasLastError, reset, setColumns

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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

Field Detail

m_IsSample

protected boolean m_IsSample

whether the arrays are samples or populations.

Constructor Detail

StandardDeviation

public StandardDeviation()

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 AbstractRowStatistic

setIsSample

public void setIsSample(boolean value)

Sets whether the columns represent samples instead of populations.

Parameters:

value - true if columns are samples and not populations

getIsSample

public boolean getIsSample()

Returns whether the columns represent samples instead of populations.

Returns:

true if columns are samples and not populations

isSampleTipText

public String isSampleTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

postVisit

protected SpreadSheet postVisit(SpreadSheet sheet,
                                int rowIndex)

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

Specified by:

postVisit in class AbstractRowStatistic

Parameters:

sheet - the spreadsheet to generate the stats for

rowIndex - the row index

Returns:

the generated stats