Name

adams.flow.control.PlotProcessor

Synopsis

Applies the specified processing algorithm to the stream of plot containers passing through. Injects any additionally created plot containers into the stream.

Additional information

Flow input/output:
- input: adams.flow.container.SequencePlotterContainer
- 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	PlotProcessor

  
  
• 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

  
  
• processor
  

  The plot processor to apply to the stream of plot containers passing through.

  command-line	-processor <adams.flow.control.plotprocessor.AbstractPlotProcessor>
  default	adams.flow.control.plotprocessor.PassThrough

  
  
• type
  

  The type of plot container to create.

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

  
  
• dropInput
  

  If enabled, then the input plot container is dropped.

  command-line	-drop-input <boolean>
  default	false