Class AddCluster

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

    public class AddCluster
    extends AbstractClusterMembershipPostProcessor
    Just adds the predicted cluster (or distribution) to the original dataset.
    Stored in container under: Clustered dataset

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -output-distribution <boolean> (property: outputDistribution)
        If enabled, the cluster distribution is output instead of the cluster index.
        default: false
     
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_OutputDistribution

        protected boolean m_OutputDistribution
        output distribution instead of cluster index.
    • Constructor Detail

      • AddCluster

        public AddCluster()
    • 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
      • setOutputDistribution

        public void setOutputDistribution​(boolean value)
        Sets whether to output the cluster distribution instead of the cluster index.
        Parameters:
        value - true if to output distribution
      • getOutputDistribution

        public boolean getOutputDistribution()
        Returns whether to output the cluster distribution instead of the cluster index.
        Returns:
        true if to output distribution
      • outputDistributionTipText

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