Package adams.data.spreadsheet.matrixstatistic

Class StandardDeviation

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.matrixstatistic.AbstractMatrixStatistic

adams.data.spreadsheet.matrixstatistic.StandardDeviation

All Implemented Interfaces:

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

public class StandardDeviation
extends AbstractMatrixStatistic

Determines the standard deviation of the numeric values in the matrix, skips NaN and infinite values.

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

-row <adams.core.Range> (property: rows)
    The rows of the subset to retrieve.
    default: first-last
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 

-col <adams.data.spreadsheet.SpreadSheetColumnRange> (property: columns)
    The columns of the subset to retrieve; A range is a comma-separated list 
    of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(..
    .)' inverts the range '...'; column names (case-sensitive) as well as the 
    following placeholders can be used: first, second, third, last_2, last_1,
     last; numeric indices can be enforced by preceding them with '#' (eg '#12'
    ); column names can be surrounded by double quotes.
    default: first-last
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 

-is-sample <boolean> (property: isSample)
    If set to true, the data is treated as sample and not as population.
    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 data is samples or populations.

Fields inherited from class adams.data.spreadsheet.matrixstatistic.AbstractMatrixStatistic

m_Columns, m_LastError, m_Rows

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.
protected SpreadSheet	doGenerate(SpreadSheet sheet)	Finishes up the stats generation after all the cells have been visited.
boolean	getIsSample()	Returns whether the data represents samples instead of populations.
String	globalInfo()	Returns a string describing the object.
String	isSampleTipText()	Returns the tip text for this property.
void	setIsSample(boolean value)	Sets whether the data represents samples instead of populations.

Methods inherited from class adams.data.spreadsheet.matrixstatistic.AbstractMatrixStatistic

check, columnsTipText, createOutputHeader, generate, getColumns, getLastError, getNumericValues, getRows, hasLastError, rowsTipText, setColumns, setRows

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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

Field Detail

m_IsSample

protected boolean m_IsSample

whether the data is 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 AbstractMatrixStatistic

setIsSample

public void setIsSample(boolean value)

Sets whether the data represents samples instead of populations.

Parameters:

value - true if data is samples and not populations

getIsSample

public boolean getIsSample()

Returns whether the data represents samples instead of populations.

Returns:

true if data is 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.

doGenerate

protected SpreadSheet doGenerate(SpreadSheet sheet)

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

Specified by:

doGenerate in class AbstractMatrixStatistic

Parameters:

sheet - the spreadsheet to generate the stats for

Returns:

the generated stats