Name

adams.flow.sink.ActualVsPredictedPlot

Synopsis

Plots actual vs predicted columns obtained from a spreadsheet.

Additional information

Flow input/output:
- input: adams.data.spreadsheet.SpreadSheet

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	ActualVsPredictedPlot

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• shortTitle
  

  If enabled uses just the name for the title instead of the actor's full name.

  command-line	-short-title <boolean>
  default	false

  
  
• displayType
  

  Determines how to show the display, eg as standalone frame (default) or in the Flow editor window.

  command-line	-display-type <adams.flow.core.displaytype.AbstractDisplayType>
  default	adams.flow.core.displaytype.Default
  min-user-mode	Expert

  
  
• width
  

  The width of the dialog.

  command-line	-width <int>
  default	800
  minimum	-1

  
  
• height
  

  The height of the dialog.

  command-line	-height <int>
  default	350
  minimum	-1

  
  
• x
  

  The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right).

  command-line	-x <int>
  default	-1
  minimum	-3

  
  
• y
  

  The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom).

  command-line	-y <int>
  default	-1
  minimum	-3

  
  
• writer
  

  The writer to use for generating the graphics output.

  command-line	-writer <adams.gui.print.JComponentWriter>
  default	adams.gui.print.NullWriter

  
  
• showFlowControlSubMenu
  

  If enabled, adds a flow control sub-menu to the menubar.

  command-line	-show-flow-control-submenu <boolean>
  default	false
  min-user-mode	Expert

  
  
• actual
  

  The column with the actual values.

  command-line	-actual <adams.data.spreadsheet.SpreadSheetColumnIndex>
  default	Actual
  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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• actualMin
  

  The minimum to use for the display of the actual axis; use NaN for unlimited.

  command-line	-actual-min <double>
  default	-Infinity

  
  
• actualMax
  

  The maximum to use for the display of the actual axis; use NaN for unlimited.

  command-line	-actual-max <double>
  default	Infinity

  
  
• predicted
  

  The column with the predicted values.

  command-line	-predicted <adams.data.spreadsheet.SpreadSheetColumnIndex>
  default	Predicted
  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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• predictedMin
  

  The minimum to use for the display of the predicted axis; use NaN for unlimited.

  command-line	-predicted-min <double>
  default	-Infinity

  
  
• predictedMax
  

  The maximum to use for the display of the predicted axis; use NaN for unlimited.

  command-line	-predicted-max <double>
  default	Infinity

  
  
• error
  

  The column with the error values.

  command-line	-error <adams.data.spreadsheet.SpreadSheetColumnIndex>
  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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• additional
  

  The additional columns to add to the plot containers.

  command-line	-additional <adams.data.spreadsheet.SpreadSheetColumnRange>
  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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• useColumnNamesAsTitles
  

  If enabled, the column titles in the spreadsheet are used as axes titles.

  command-line	-use-column-names-as-titles <boolean>
  default	false

  
  
• swapAxes
  

  If enabled, the axes get swapped.

  command-line	-swap-axes <boolean>
  default	false

  
  
• title
  

  The (optional) title of the plot.

  command-line	-title <java.lang.String>
  default

  
  
• plotName
  

  The (optional) name for the plot.

  command-line	-plot-name <java.lang.String>
  default

  
  
• limit
  

  The type of limit to impose on the axes; NONE just uses the range determined from the data; ACTUAL uses the min/max from the actual column for both axes; SPECIFIED uses the specified limits or, if a value is 'infinity' then the corresponding value from the determine range.

  command-line	-limit <NONE|ACTUAL|SPECIFIED>
  default	NONE

  
  
• showSidePanel
  

  If enabled, the side panel gets displayed which allows access to the underlying data for the plot.

  command-line	-show-side-panel <boolean>
  default	true

  
  
• diameter
  

  The diameter of the cross in pixels (if no error data supplied).

  command-line	-diameter <int>
  default	7
  minimum	1

  
  
• antiAliasingEnabled
  

  If enabled, uses anti-aliasing for drawing.

  command-line	-anti-aliasing-enabled <boolean>
  default	true

  
  
• metaDataColor
  

  The scheme to use for extracting the color from the meta-data; ignored if adams.gui.visualization.sequence.metadatacolor.Dummy.

  command-line	-meta-data-color <adams.gui.visualization.sequence.metadatacolor.AbstractMetaDataColor>
  default	adams.gui.visualization.sequence.metadatacolor.Dummy

  
  
• useCustomPaintlet
  

  If enabled, the custom paintlet is used instead of cross/error paintlet, anti-aliasing and meta-data color scheme.

  command-line	-use-custom-paintlet <boolean>
  default	false

  
  
• customPaintlet
  

  The custom paintlet to use instead of cross/error paintlet, anti-aliasing and meta-data color scheme.

  command-line	-custom-paintlet <adams.gui.visualization.sequence.XYSequencePaintlet>
  default	adams.gui.visualization.sequence.MetaDataValuePaintlet -meta-data-color adams.gui.visualization.sequence.metadatacolor.Dummy

  
  
• overlays
  

  The overlays to use in the plot.

  command-line	-overlay <adams.gui.visualization.sequence.XYSequencePaintlet> [-overlay ...]
  default	adams.gui.visualization.sequence.StraightLineOverlayPaintlet