Name

adams.flow.transformer.MakePlotContainer

Synopsis

Creates a named container for the SequencePlotter actor.
In case of Double arrays arriving at the input, they must have length 2 for X and Y, 4 for X/Y/Y-Error (low/high) or 6 X/Y/X-Error (low-high)/Y-Error (low-high).
Integer arrays can only have the length 2.
It is also possible, depending on the plotter sink setup, to use strings for x and/or y.
In order to force an update of the plot, overriding the current plot-updater setup, you can create a special plot container of type UPDATE and send that to the plot (can be triggered with a null-token, e.g., from a adams.flow.source.Start source). Useful if you want to take a screenshot at a specific time, but avoid costly screen refreshs.

Additional information

Flow input/output:
- input: java.lang.Double, java.lang.Double[], java.lang.Integer, java.lang.Integer[], java.lang.String, java.lang.String[], java.lang.Object[]
- output: adams.flow.container.SequencePlotterContainer

Container information:
- adams.flow.container.SequencePlotterContainer:
   - PlotName: name of the plot; java.lang.String
   - X: X value; java.lang.Comparable
   - Y: Y value; java.lang.Comparable
   - Content type: type of plot; adams.flow.container.SequencePlotterContainer$ContentType
   - Error X: X error; java.lang.Double[]
   - Error Y: Y error; java.lang.Double[]
   - MetaData: mapping of meta-data (String/Object); java.util.HashMap

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	MakePlotContainer

  
  
• 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

  
  
• plotName
  

  The name for the plot.

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

  
  
• type
  

  The type of plot container to create.

  command-line	-type <PLOT|MARKER|OVERLAY|UPDATE>
  default	PLOT