Name

adams.flow.transformer.SpreadSheetHistogramRanges

Synopsis

Outputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming adams.data.spreadsheet.SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.

Additional information

Flow input/output:
- input: adams.data.spreadsheet.SpreadSheet
- output: java.lang.String

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	SpreadSheetHistogramRanges

  
  
• 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

  
  
• outputArray
  

  If enabled, the ranges are output as array rather than one by one.

  command-line	-output-array <boolean>
  default	false

  
  
• dataType
  

  Whether to retrieve rows or columns from the Instances object.

  command-line	-type <ROW_BY_INDEX|COLUMN_BY_INDEX|COLUMN_BY_REGEXP>
  default	COLUMN_BY_INDEX

  
  
• locations
  

  The locations of the data, depending on the chosen data type that can be either indices, column names or regular expressions on the column names.

  command-line	-location <adams.core.base.BaseString> [-location ...]
  default

  
  
• binCalculation
  

  Defines how the number of bins are calculated.

  command-line	-bin-calc <MANUAL|FREQUENCY|DENSITY|STURGES|SCOTT|SQRT>
  default	MANUAL

  
  
• numBins
  

  The number of bins to use in case of manual bin calculation.

  command-line	-num-bins <int>
  default	50
  minimum	1

  
  
• binWidth
  

  The bin width to use for some of the calculations.

  command-line	-bin-width <double>
  default	1.0
  minimum	1.0E-5

  
  
• normalize
  

  If set to true the data gets normalized first before the histogram is calculated.

  command-line	-normalize <boolean>
  default	false

  
  
• useFixedMinMax
  

  If enabled, then the user-specified min/max values are used for the bin calculation rather than the min/max from the data (allows comparison of histograms when generating histograms over a range of arrays).

  command-line	-use-fixed-min-max <boolean>
  default	false

  
  
• manualMin
  

  The minimum to use when using manual binning with user-supplied min/max enabled.

  command-line	-manual-min <double>
  default	0.0

  
  
• manualMax
  

  The maximum to use when using manual binning with user-supplied max/max enabled.

  command-line	-manual-max <double>
  default	1.0

  
  
• numDecimals
  

  The number of decimals to show in the bin descriptions.

  command-line	-num-decimals <int>
  default	3
  minimum	0