Package adams.data.binning.algorithm

Class FrequencyBinning

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.binning.algorithm.AbstractBinningAlgorithm

adams.data.binning.algorithm.FrequencyBinning

All Implemented Interfaces:

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

public class FrequencyBinning
extends AbstractBinningAlgorithm
implements TechnicalInformationHandler, FixedNumBinsBinningAlgorithm

Performs frequency binning.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NumBins	the number of bins.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected <T> List<Bin<T>>	doGenerateBins(List<Binnable<T>> objects)	Performs the actual bin generation on the provided objects.
int	getNumBins()	Returns the number of bins to use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
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.
String	numBinsTipText()	Returns the tip text for this property.
void	setNumBins(int value)	Sets the number of bins to use.

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

check, fillBins, generateBins, getMinMax, getNumDecimals, 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.data.binning.algorithm.BinningAlgorithm

generateBins

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

Field Detail

m_NumBins

protected int m_NumBins

the number of bins.

Constructor Detail

FrequencyBinning

public FrequencyBinning()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractBinningAlgorithm

setNumBins

public void setNumBins(int value)

Sets the number of bins to use.

Specified by:

setNumBins in interface FixedNumBinsBinningAlgorithm

Parameters:

value - the number of bins

getNumBins

public int getNumBins()

Returns the number of bins to use.

Specified by:

getNumBins in interface FixedNumBinsBinningAlgorithm

Returns:

the number of bins

numBinsTipText

public String numBinsTipText()

Returns the tip text for this property.

Specified by:

numBinsTipText in interface FixedNumBinsBinningAlgorithm

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractBinningAlgorithm

Returns:

null if no info available, otherwise short string

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