Package adams.data.heatmapfeatures

Class CountValues

  • 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 CountValues
extends AbstractMetaHeatmapFeatureGenerator
    Meta-feature-generator that counts numeric values that satisfy the specified min/max range. 

    -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: 
 
    -generator <adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator> (property: generator)
    The base feature generator to use for generating data to be used as input 
    for the counts.
    default: adams.data.heatmapfeatures.Values -converter \"adams.data.featureconverter.SpreadSheet -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.SpreadSheet\"
 
    -minimum <double> (property: minimum)
    The minimum value that the values must satisfy; use NaN (not a number) to 
    ignore minimum.
    default: NaN
 
    -minimum-included <boolean> (property: minimumIncluded)
    If enabled, then the minimum value gets included (testing '<=' rather than 
    '<').
    default: false
 
    -maximum <double> (property: maximum)
    The maximum value that the values must satisfy; use NaN (not a number) to 
    ignore maximum.
    default: NaN
 
    -maximum-included <boolean> (property: maximumIncluded)
    If enabled, then the maximum value gets included (testing '>=' rather than 
    '>').
    default: false
 
    -label <java.lang.String> (property: label)
    The optional label to use; otherwise min/max are used to construct label.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Minimum

        protected double m_Minimum
        the minimum value.

      • m_MinimumIncluded

        protected boolean m_MinimumIncluded
        whether the minimum value is included.

      • m_Maximum

        protected double m_Maximum
        the maximum value.

      • m_MaximumIncluded

        protected boolean m_MaximumIncluded
        whether the maximum value is included.

      • m_Label

        protected String m_Label
        the optional label for the generated feature.

    • Constructor Detail

      • CountValues

        public CountValues()

    • 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

      • setMinimum

        public void setMinimum​(double value)
        Sets the minimum.
        Parameters:
        value - the minimum

      • getMinimum

        public double getMinimum()
        Returns the minimum.
        Returns:
        the minimum

      • minimumTipText

        public String minimumTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setMinimumIncluded

        public void setMinimumIncluded​(boolean value)
        Sets whether to exclude the minimum.
        Parameters:
        value - true to exclude minimum

      • getMinimumIncluded

        public boolean getMinimumIncluded()
        Returns whether the minimum is included.
        Returns:
        true if minimum included

      • minimumIncludedTipText

        public String minimumIncludedTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setMaximum

        public void setMaximum​(double value)
        Sets the maximum.
        Parameters:
        value - the maximum

      • getMaximum

        public double getMaximum()
        Returns the maximum.
        Returns:
        the maximum

      • maximumTipText

        public String maximumTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setMaximumIncluded

        public void setMaximumIncluded​(boolean value)
        Sets whether to exclude the maximum.
        Parameters:
        value - true to exclude maximum

      • getMaximumIncluded

        public boolean getMaximumIncluded()
        Returns whether the maximum is included.
        Returns:
        true if maximum included

      • maximumIncludedTipText

        public String maximumIncludedTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setLabel

        public void setLabel​(String value)
        Sets the custom label to use.
        Parameters:
        value - the label to use

      • getLabel

        public String getLabel()
        Returns the custom label to use.
        Returns:
        the label to use

      • labelTipText

        public String labelTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractMetaHeatmapFeatureGenerator
        Returns:
        null if no info available, otherwise short string

      • 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