Name

adams.flow.transformer.GetSpectrumAmplitude

Synopsis

Retrieves the spectrum's amplitude either via its index or wave number.

Additional information

Flow input/output:
- input: adams.data.spectrum.Spectrum
- output: java.lang.Double

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	GetSpectrumAmplitude

  
  
• 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

  
  
• type
  

  How to retrieve the amplitude.

  command-line	-type <INDEX|WAVE_NUMBER|WAVE_NUMBER_CLOSEST>
  default	INDEX

  
  
• index
  

  The index of the amplitude to retrieve.

  command-line	-index <adams.core.Index>
  default	first
  example	An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last

  
  
• waveNumber
  

  The wave number of the amplitude to retrieve.

  command-line	-wave-number <float>
  default	0.0