Package adams.data.statistics

Class ArrayStandardScores<T extends Number>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.statistics.AbstractArrayStatistic<T>

adams.data.statistics.AbstractOptionalSampleArrayStatistic<T>

adams.data.statistics.ArrayStandardScores<T>

Type Parameters:

T - the data to process

All Implemented Interfaces:

AdditionalInformationHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractArrayStatistic>, SizeOfHandler, EqualLengthArrayStatistic, OptionalSampleArrayStatistic, Serializable

public class ArrayStandardScores<T extends Number>
extends AbstractOptionalSampleArrayStatistic<T>
implements EqualLengthArrayStatistic

Calculates the standard scores (or z scores) of the provided arrays.The arrays must be numeric, of course.

Valid options are:

-always-first-stats (property: useAlwaysFirstStats)
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.statistics.AbstractArrayStatistic

AbstractArrayStatistic.StatisticContainer<T extends Serializable>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_UseAlwaysFirstStats	whether to always use the mean/stdev from the first array.

Fields inherited from class adams.data.statistics.AbstractOptionalSampleArrayStatistic

m_IsSample

Fields inherited from class adams.data.statistics.AbstractArrayStatistic

m_Data

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected AbstractArrayStatistic.StatisticContainer	doCalculate()	Generates the actual result.
int	getLength()	Returns the length of the stored arrays.
int	getMax()	Returns the maximum number of arrays that need to be present.
int	getMin()	Returns the minimum number of arrays that need to be present.
boolean	getUseAlwaysFirstStats()	Returns whether to always use the mean/stdev of the first array.
String	globalInfo()	Returns a string describing the object.
void	setUseAlwaysFirstStats(boolean value)	Sets whether to always use the mean/stdev of the first array.
String	useAlwaysFirstStatsTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.statistics.AbstractOptionalSampleArrayStatistic

getIsSample, isSampleTipText, setIsSample

Methods inherited from class adams.data.statistics.AbstractArrayStatistic

add, calculate, check, checkEqualLength, clear, forCommandLine, forName, get, getAdditionalInformation, getStatistics, initialize, remove, set, shallowCopy, shallowCopy, size, toString

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

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_UseAlwaysFirstStats

protected boolean m_UseAlwaysFirstStats

whether to always use the mean/stdev from the first array.

Constructor Detail

ArrayStandardScores

public ArrayStandardScores()

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 AbstractOptionalSampleArrayStatistic<T extends Number>

setUseAlwaysFirstStats

public void setUseAlwaysFirstStats(boolean value)

Sets whether to always use the mean/stdev of the first array.

Parameters:

value - if true then the mean/stdev of the first array is always used

getUseAlwaysFirstStats

public boolean getUseAlwaysFirstStats()

Returns whether to always use the mean/stdev of the first array.

Returns:

true if the mean/stdev of first array is always used

useAlwaysFirstStatsTipText

public String useAlwaysFirstStatsTipText()

Returns the tip text for this property.

Returns:

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

getLength

public int getLength()

Returns the length of the stored arrays.

Specified by:

getLength in interface EqualLengthArrayStatistic

Returns:

the length of the arrays, -1 if none stored

getMin

public int getMin()

Returns the minimum number of arrays that need to be present. -1 for unbounded.

Specified by:

getMin in class AbstractArrayStatistic<T extends Number>

Returns:

the minimum number, -1 for unbounded

getMax

public int getMax()

Returns the maximum number of arrays that need to be present. -1 for unbounded.

Specified by:

getMax in class AbstractArrayStatistic<T extends Number>

Returns:

the maximum number, -1 for unbounded

doCalculate

protected AbstractArrayStatistic.StatisticContainer doCalculate()

Generates the actual result.

Specified by:

doCalculate in class AbstractArrayStatistic<T extends Number>

Returns:

the generated result