Package adams.data.binning.algorithm

Class SquareRootChoiceBinning

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.binning.algorithm.AbstractBinningAlgorithm

adams.data.binning.algorithm.AbstractEqualWidthBinningAlgorithm

adams.data.binning.algorithm.SquareRootChoiceBinning

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, TechnicalInformationHandler, BinningAlgorithm, Serializable

public class SquareRootChoiceBinning
extends AbstractEqualWidthBinningAlgorithm
implements TechnicalInformationHandler

Takes the square root of the number of data points in the sample used by Excel histograms and many others) and rounds to the next integer.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.binning.algorithm.AbstractBinningAlgorithm

m_NumDecimals

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

Method Summary

Modifier and Type	Method	Description
protected <T> List<Bin<T>>	doGenerateBins(List<Binnable<T>> objects)	Performs the actual bin generation on the provided objects.
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.

Methods inherited from class adams.data.binning.algorithm.AbstractEqualWidthBinningAlgorithm

doGenerateBins, doGenerateBins, doGenerateBins, doGenerateBins, doGenerateBins, doGenerateBins

Methods inherited from class adams.data.binning.algorithm.AbstractBinningAlgorithm

check, defineOptions, fillBins, generateBins, getMinMax, getNumDecimals, getQuickInfo, numDecimalsTipText, setNumDecimals

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Constructor Detail

SquareRootChoiceBinning

public SquareRootChoiceBinning()

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

doGenerateBins

protected <T> List<Bin<T>> doGenerateBins(List<Binnable<T>> objects)

Performs the actual bin generation on the provided objects.

Specified by:

doGenerateBins in class AbstractBinningAlgorithm

Parameters:

objects - the objects to bin

Returns:

the generated bins

Throws:

IllegalStateException - if binning fails