Package adams.data.heatmapfeatures

Class StandardDeviation

  • 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 StandardDeviation
extends AbstractHeatmapFeatureGeneratorWithSkippableMissingValues
    Determines the standard deviation. 

    -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
 
    -is-sample <boolean> (property: isSample)
    If set to true, the arrays are treated as samples and not as populations.
    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 Detail

      • m_IsSample

        protected boolean m_IsSample
        whether the arrays are samples or populations.

    • Constructor Detail

      • StandardDeviation

        public StandardDeviation()

    • 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

      • setIsSample

        public void setIsSample​(boolean value)
        Sets whether the arrays represent samples instead of populations.
        Parameters:
        value - true if arrays are samples and not populations

      • getIsSample

        public boolean getIsSample()
        Returns whether the arrays represent samples instead of populations.
        Returns:
        true if arrays are samples and not populations

      • isSampleTipText

        public String isSampleTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • 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