Package adams.flow.transformer.threewaydatamerge

Class CollapseX

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.threewaydatamerge.AbstractThreeWayDataMerge

adams.flow.transformer.threewaydatamerge.CollapseX

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class CollapseX
extends AbstractThreeWayDataMerge

Calculates the mean/median/stdev data across the X layers. This only works if the data containers share the same Y/Z values.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollapseX.StatisticType	the statistic to calculate from the data values.

Field Summary

Fields

Modifier and Type	Field	Description
protected CollapseX.StatisticType	m_Statistic	the type of statistic to calculate.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected ThreeWayData	doMerge(ThreeWayData[] data)	Merges the data containers into a single one.
CollapseX.StatisticType	getStatistic()	Returns the type of statistic to calculate.
String	globalInfo()	Returns a string describing the object.
void	setStatistic(CollapseX.StatisticType value)	Sets the type of statistic to calculate.
String	statisticTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.threewaydatamerge.AbstractThreeWayDataMerge

check, merge

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

getLoggingLevel

Field Detail

m_Statistic

protected CollapseX.StatisticType m_Statistic

the type of statistic to calculate.

Constructor Detail

CollapseX

public CollapseX()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setStatistic

public void setStatistic(CollapseX.StatisticType value)

Sets the type of statistic to calculate.

Parameters:

value - the type

getStatistic

public CollapseX.StatisticType getStatistic()

Returns the type of statistic to calculate.

Returns:

the type

statisticTipText

public String statisticTipText()

Returns the tip text for this property.

Returns:

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

doMerge

protected ThreeWayData doMerge(ThreeWayData[] data)

Merges the data containers into a single one.

Specified by:

doMerge in class AbstractThreeWayDataMerge

Parameters:

data - the data to merge

Returns:

the merged container