Package adams.flow.transformer.plotgenerator

Class AndrewsCurvesGenerator

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, TechnicalInformationHandler, Serializable
    public class AndrewsCurvesGenerator
extends AbstractPlotGenerator
implements TechnicalInformationHandler
    Generates plot containers from row-based data for Andrews Curves.
    César Ignacio García Osorio, Colin Fyfe (2003). AN EXTENSION OF ANDREWS CURVES FOR DATA ANALYSIS. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -default-cell-value <double> (property: defaultCellValue)
    The default value for missing or non-numeric cells.
    default: -1.0
 
    -plot-name-range <java.lang.String> (property: plotNameRange)
    The range of columns to use for generating the plot name (overrides any 
    plot generator specific names); A range is a comma-separated list of single 
    1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts 
    the range '...'; column names (case-sensitive) as well as the following 
    placeholders can be used: first, second, third, last_2, last_1, last
    default: 
 
    -plot-name-separator <java.lang.String> (property: plotNameSeparator)
    The separator to use when constructing the plot name from cell values.
    default: 
 
    -num-points <int> (property: numPoints)
    The number of points to generate for the curves.
    default: 100
    minimum: 1
 
    -prefix <java.lang.String> (property: prefix)
    The prefix to use for the plot names.
    default: 
 
    -columns <java.lang.String> (property: plotColumns)
    The range of columns to include in the curves; A range is a comma-separated 
    list of single 1-based indices or sub-ranges of indices ('start-end'); '
    inv(...)' inverts the range '...'; column names (case-sensitive) as well 
    as the following placeholders can be used: first, second, third, last_2, 
    last_1, last
    default: 
 
    -meta-data-columns <java.lang.String> (property: metaDataColumns)
    The range of columns to add as meta-data in the plot; A range is a comma-separated 
    list of single 1-based indices or sub-ranges of indices ('start-end'); '
    inv(...)' inverts the range '...'; column names (case-sensitive) as well 
    as the following placeholders can be used: first, second, third, last_2, 
    last_1, last
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_NumPoints

        protected int m_NumPoints
        the number of data points.

      • m_Prefix

        protected String m_Prefix
        the prefix for the plots.

    • Constructor Detail

      • AndrewsCurvesGenerator

        public AndrewsCurvesGenerator()

    • Method Detail

      • getTechnicalInformation

        public TechnicalInformation getTechnicalInformation()
        Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
        Specified by:
        getTechnicalInformation in interface TechnicalInformationHandler
        Returns:
        the technical information about this class

      • setNumPoints

        public void setNumPoints​(int value)
        Sets the number of points to generate.
        Parameters:
        value - the number of points

      • getNumPoints

        public int getNumPoints()
        Returns the number of points to generate.
        Returns:
        the number of points

      • numPointsTipText

        public String numPointsTipText()
        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 for the plot names.
        Parameters:
        value - the prefix

      • getPrefix

        public String getPrefix()
        Returns the prefix for the plot names.
        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.

      • setPlotColumns

        public void setPlotColumns​(String value)
        Sets the column range to use in the curves.
        Parameters:
        value - the column range

      • getPlotColumns

        public String getPlotColumns()
        Returns the current column range to use in the curves.
        Returns:
        the column range

      • plotColumnsTipText

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

      • setMetaDataColumns

        public void setMetaDataColumns​(String value)
        Sets the column range to add as meta-data in the plot.
        Parameters:
        value - the column range

      • getMetaDataColumns

        public String getMetaDataColumns()
        Returns the current column range to add as meta-data in the plot.
        Returns:
        the column range

      • metaDataColumnsTipText

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