Package adams.data.heatmapfeatures

Class Mean

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

adams.data.heatmapfeatures.AbstractHeatmapFeatureGeneratorWithSkippableMissingValues

adams.data.heatmapfeatures.Mean

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractHeatmapFeatureGenerator>, adams.core.SizeOfHandler, Serializable, Comparable

public class Mean
extends AbstractHeatmapFeatureGeneratorWithSkippableMissingValues

Determines the mean.

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

-converter <adams.data.featureconverter.AbstractFeatureConverter> (property: converter)
    The feature converter to use to produce the output data.
    default: adams.data.featureconverter.SpreadSheet -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.SpreadSheet
 

-field <adams.data.report.Field> [-field ...] (property: fields)
    The fields to add to the output.
    default: 
 

-notes <adams.core.base.BaseString> [-notes ...] (property: notes)
    The notes to add as attributes to the generated data, eg 'PROCESS INFORMATION'
    .
    default: 
 

-skip-missing <boolean> (property: skipMissing)
    If enabled, missing values get skipped when collecting the values for the 
    histogram.
    default: false
 

Version:

$Revision: 9598 $

Author:

fracpete (fracpete at waikato dot ac dot nz), Dale (dale at cs dot waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.heatmapfeatures.AbstractHeatmapFeatureGeneratorWithSkippableMissingValues

m_SkipMissing

Fields inherited from class adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

m_Converter, m_Fields, m_Notes

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

Method Summary

Modifier and Type	Method	Description
adams.data.featureconverter.HeaderDefinition	createHeader(Heatmap map)	Creates the header from a template heatmap.
List<Object>[]	generateRows(Heatmap map)	Performs the actual feature generation.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.data.heatmapfeatures.AbstractHeatmapFeatureGeneratorWithSkippableMissingValues

defineOptions, getSkipMissing, setSkipMissing, skipMissingTipText

Methods inherited from class adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

checkData, cleanUp, compareTo, converterTipText, destroy, equals, fieldsTipText, generate, getConverter, getDatasetFormat, getFields, getNotes, getQuickInfo, getRowFormat, notesTipText, postProcessHeader, postProcessRow, postProcessRows, reset, setConverter, setFields, setNotes, 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

Constructor Detail

Mean

public Mean()

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

createHeader

public adams.data.featureconverter.HeaderDefinition createHeader(Heatmap map)

Creates the header from a template heatmap.

Specified by:

createHeader in class AbstractHeatmapFeatureGenerator

Parameters:

map - the heatmap to act as a template

Returns:

the generated header

generateRows

public List<Object>[] generateRows(Heatmap map)

Performs the actual feature generation.

Specified by:

generateRows in class AbstractHeatmapFeatureGenerator

Parameters:

map - the heatmap to process

Returns:

the generated features