Package adams.data.heatmapfeatures

Class MultiFeatureGenerator

  • 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 MultiFeatureGenerator
extends AbstractHeatmapFeatureGenerator
    Applies multiple generators to the same heatmap and merges the generate a feature vectors side-by-side. If one of the generators should create fewer a feature vectors, missing values are used in that case. 

    -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: 
 
    -sub-generator <adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator> [-sub-generator ...] (property: subGenerators)
    The feature generators to apply to the image.
    default: 
 
    -prefix <java.lang.String> (property: prefix)
    The prefix to use for disambiguating the attribute names of the datasets 
    generated by the generators; use '#' for the 1-based index of the feature 
    generator; example '#-'
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Prefix

        protected String m_Prefix
        the prefix to use to disambiguate the attributes.

      • m_SubHeaders

        protected adams.data.featureconverter.HeaderDefinition[] m_SubHeaders
        the sub-headers.

    • Constructor Detail

      • MultiFeatureGenerator

        public MultiFeatureGenerator()

    • 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 AbstractHeatmapFeatureGenerator

      • setSubGenerators

        public void setSubGenerators​(AbstractHeatmapFeatureGenerator[] value)
        Sets the generators to use.
        Parameters:
        value - the generators

      • subGeneratorsTipText

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

      • setPrefix

        public void setPrefix​(String value)
        Sets the prefix to user for disambiguating the attributes.
        Parameters:
        value - the prefix

      • getPrefix

        public String getPrefix()
        Returns the prefix to use for disambiguating the attributes.
        Returns:
        the prefix

      • prefixTipText

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

      • createPrefix

        protected String createPrefix​(int index)
        Generates the prefix for the specified flattener.
        Parameters:
        index - the index of the flattener
        Returns:
        the prefix

      • createHeader

        public adams.data.featureconverter.HeaderDefinition createHeader​(Heatmap map)
        Creates the header from a template image.
        Specified by:
        createHeader in class AbstractHeatmapFeatureGenerator
        Parameters:
        map - the image to act as a template
        Returns:
        the generated header