Package adams.flow.transformer.plotgenerator

Class XYWithErrorsPlotGenerator

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable
    public class XYWithErrorsPlotGenerator
extends AbstractPlotGenerator
    Generator for X/Y plots (with X optional) that attaches error information for Y and optionally X as well. If only one error column is defined, this is interpreted as 'error-delta'; providing two columns is interpreted as 'low' and 'high'. 

    -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: 
 
    -y-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: YColumn)
    The column to use for Y; An index is a number starting with 1; column names 
    (case-sensitive) as well as the following placeholders can be used: first,
     second, third, last_2, last_1, last
    default: 
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last
 
    -x-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: XColumn)
    The (optional) index of the column which values to use as X values in the 
    plot; An index is a number starting with 1; column names (case-sensitive
    ) as well as the following placeholders can be used: first, second, third,
     last_2, last_1, last
    default: 
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last
 
    -y-error-columns <adams.data.spreadsheet.SpreadSheetColumnRange> (property: YErrorColumns)
    The range of columns to use for Y error information (1=delta, 2=low/high
    ); 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: 
    example: 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
 
    -x-error-columns <adams.data.spreadsheet.SpreadSheetColumnRange> (property: XErrorColumns)
    The (optional) range of columns to use for X error information (1=delta, 
    2=low/high); 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: 
    example: 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
 
    -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

    • Constructor Detail

      • XYWithErrorsPlotGenerator

        public XYWithErrorsPlotGenerator()

    • Method Detail

      • setYColumn

        public void setYColumn​(SpreadSheetColumnIndex value)
        Sets the y column to use in the plot.
        Parameters:
        value - the column

      • getYColumn

        public SpreadSheetColumnIndex getYColumn()
        Returns the y column to use in the plot.
        Returns:
        the column

      • YColumnTipText

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

      • setXColumn

        public void setXColumn​(SpreadSheetColumnIndex value)
        Sets the index of the column which values to use as X values.
        Parameters:
        value - the column index

      • getXColumn

        public SpreadSheetColumnIndex getXColumn()
        Returns the index of the column which values to use as X values.
        Returns:
        the column index

      • XColumnTipText

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

      • setYErrorColumns

        public void setYErrorColumns​(SpreadSheetColumnRange value)
        Sets the column range to use for Y error information (1=delta, 2=low/high).
        Parameters:
        value - the column range

      • getYErrorColumns

        public SpreadSheetColumnRange getYErrorColumns()
        Returns the column range to use for Y error information (1=delta, 2=low/high).
        Returns:
        the column range

      • YErrorColumnsTipText

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

      • setXErrorColumns

        public void setXErrorColumns​(SpreadSheetColumnRange value)
        Sets the column range to use for X error information (1=delta, 2=low/high).
        Parameters:
        value - the column range

      • getXErrorColumns

        public SpreadSheetColumnRange getXErrorColumns()
        Returns the column range to use for X error information (1=delta, 2=low/high).
        Returns:
        the column range

      • XErrorColumnsTipText

        public String XErrorColumnsTipText()
        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.