Package adams.data.binning.algorithm

Class ManualBinning

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

All Implemented Interfaces:

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

public class ManualBinning
extends AbstractEqualWidthBinningAlgorithm
implements FixedNumBinsBinningAlgorithm

Generates a predefined number of equal sized bins.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_ManualMax	the manual maximum.
protected double	m_ManualMin	the manual minimum.
protected int	m_NumBins	the number of bins.
protected boolean	m_UseFixedMinMax	whether to use fixed min/max for manual bin calculation.

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

Method Summary

Modifier and Type	Method	Description
protected <T> String	check(List<Binnable<T>> objects)	Hook method for performing checks before binning.
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	getManualMax()	Returns the maximum to use with user-supplied max/max enabled.
double	getManualMin()	Returns the minimum to use with user-supplied min/max enabled.
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.
boolean	getUseFixedMinMax()	Returns whether to use user-supplied min/max for bin calculation rather than obtain min/max from data.
String	globalInfo()	Returns a string describing the object.
String	manualMaxTipText()	Returns the tip text for this property.
String	manualMinTipText()	Returns the tip text for this property.
String	numBinsTipText()	Returns the tip text for this property.
void	setManualMax(double value)	Sets the maximum to use with user-supplied max/max enabled.
void	setManualMin(double value)	Sets the minimum to use with user-supplied min/max enabled.
void	setNumBins(int value)	Sets the number of bins to use.
void	setUseFixedMinMax(boolean value)	Sets whether to use user-supplied min/max for bin calculation rather than obtain min/max from data.
String	useFixedMinMaxTipText()	Returns the tip text for this property.

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

doGenerateBins, doGenerateBins, doGenerateBins, doGenerateBins, doGenerateBins, doGenerateBins

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

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.

m_UseFixedMinMax

protected boolean m_UseFixedMinMax

whether to use fixed min/max for manual bin calculation.

m_ManualMin

protected double m_ManualMin

the manual minimum.

m_ManualMax

protected double m_ManualMax

the manual maximum.

Constructor Detail

ManualBinning

public ManualBinning()

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

setUseFixedMinMax

public void setUseFixedMinMax(boolean value)

Sets whether to use user-supplied min/max for bin calculation rather than obtain min/max from data.

Parameters:

value - true if to use user-supplied min/max

getUseFixedMinMax

public boolean getUseFixedMinMax()

Returns whether to use user-supplied min/max for bin calculation rather than obtain min/max from data.

Returns:

true if to use user-supplied min/max

useFixedMinMaxTipText

public String useFixedMinMaxTipText()

Returns the tip text for this property.

Returns:

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

setManualMin

public void setManualMin(double value)

Sets the minimum to use with user-supplied min/max enabled.

Parameters:

value - the minimum

getManualMin

public double getManualMin()

Returns the minimum to use with user-supplied min/max enabled.

Returns:

the minimum

manualMinTipText

public String manualMinTipText()

Returns the tip text for this property.

Returns:

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

setManualMax

public void setManualMax(double value)

Sets the maximum to use with user-supplied max/max enabled.

Parameters:

value - the maximum

getManualMax

public double getManualMax()

Returns the maximum to use with user-supplied max/max enabled.

Returns:

the maximum

manualMaxTipText

public String manualMaxTipText()

Returns the tip text for this property.

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

check

protected <T> String check(List<Binnable<T>> objects)

Hook method for performing checks before binning.

Overrides:

check in class AbstractBinningAlgorithm

Parameters:

objects - the objects to bin

Returns:

null if successful, otherwise error message

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