Package adams.data.binning.algorithm

Class DensityBinning

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

All Implemented Interfaces:

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

public class DensityBinning
extends AbstractEqualWidthBinningAlgorithm
implements TechnicalInformationHandler, FixedBinWidthBinningAlgorithm

Performs density-based binning.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_BinWidth	the bin width.

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

Method Summary

Modifier and Type	Method	Description
String	binWidthTipText()	Returns the tip text for this property.
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.
double	getBinWidth()	Returns the bin width in 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.
void	setBinWidth(double value)	Sets the bin width to use.

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

protected double m_BinWidth

the bin width.

Constructor Detail

DensityBinning

public DensityBinning()

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

setBinWidth

public void setBinWidth(double value)

Sets the bin width to use.

Specified by:

setBinWidth in interface FixedBinWidthBinningAlgorithm

Parameters:

value - the bin width

getBinWidth

public double getBinWidth()

Returns the bin width in use.

Specified by:

getBinWidth in interface FixedBinWidthBinningAlgorithm

Returns:

the bin width

binWidthTipText

public String binWidthTipText()

Returns the tip text for this property.

Specified by:

binWidthTipText in interface FixedBinWidthBinningAlgorithm

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