Package adams.data.filter

Class TimeseriesHistogram

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractHistogram<Timeseries>

adams.data.filter.TimeseriesHistogram

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Filter>, SizeOfHandler, Filter<Timeseries>, Serializable, Comparable

public class TimeseriesHistogram
extends AbstractHistogram<Timeseries>

Generates a histogram from the timeseries.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 

-histogram <adams.data.statistics.ArrayHistogram> (property: histogram)
    The array histogram setup to use for generating the histogram data.
    default: adams.data.statistics.ArrayHistogram
 

Version:

$Revision: 1286 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

AbstractFilter.FilterJob<T extends DataContainer>

Field Summary

Fields inherited from class adams.data.filter.AbstractHistogram

m_Histogram

Fields inherited from class adams.data.filter.AbstractFilter

m_DontUpdateID

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

Method Summary

Modifier and Type	Method	Description
protected double	getY(DataPoint point)	Obtains the Y value from the given data point.
String	globalInfo()	Returns a string describing the object.
protected DataPoint	newDataPoint(int index, double y)	Creates a new data point from the X and Y values.

Methods inherited from class adams.data.filter.AbstractHistogram

defineOptions, getDefaultHistogram, getHistogram, histogramTipText, processData, setHistogram

Methods inherited from class adams.data.filter.AbstractFilter

checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Constructor Detail

TimeseriesHistogram

public TimeseriesHistogram()

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

getY

protected double getY(DataPoint point)

Obtains the Y value from the given data point.

Specified by:

getY in class AbstractHistogram<Timeseries>

Parameters:

point - the data point to extract the Y value from

Returns:

the Y value

newDataPoint

protected DataPoint newDataPoint(int index,
                                 double y)

Creates a new data point from the X and Y values.

Specified by:

newDataPoint in class AbstractHistogram<Timeseries>

Parameters:

index - the index of the bin

y - the raw Y value

Returns:

the data point