Name

adams.flow.transformer.SpreadSheetRowBinning

Synopsis

Applies a binning algorithm to the values from the specified binning column to filter the rows into specific bins.
A new column is then added containing the corresponding bin index.

Additional information

Flow input/output:
- input: adams.data.spreadsheet.SpreadSheet
- output: 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	SpreadSheetRowBinning

  
  
• 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

  
  
• noCopy
  

  If enabled, no copy of the spreadsheet is created before processing it.

  command-line	-no-copy <boolean>
  default	false

  
  
• binningColumn
  

  The column to obtain the numeric values from to use for binning.

  command-line	-binning-column <adams.data.spreadsheet.SpreadSheetColumnIndex>
  default	first
  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.

  
  
• algorithm
  

  The binning algorithm to apply.

  command-line	-algorithm <adams.data.binning.algorithm.BinningAlgorithm>
  default	adams.data.binning.algorithm.ManualBinning

  
  
• postProcessing
  

  The post-processing algorithm to apply to the bins.

  command-line	-post-processing <adams.data.binning.postprocessing.BinPostProcessing>
  default	adams.data.binning.postprocessing.PassThrough

  
  
• position
  

  The position where to insert the column; 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.

  command-line	-position <adams.data.spreadsheet.SpreadSheetColumnIndex>
  default	last
  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.

  
  
• after
  

  If enabled, the column is inserted after the position instead of at the position.

  command-line	-after <boolean>
  default	false

  
  
• header
  

  The name of the new column.

  command-line	-header <java.lang.String>
  default	Bin