Name

adams.flow.transformer.SetSpectrumAmplitude

Synopsis

Sets the amplitude for the specified wave number.
Can either be used to replace an existing spectrum point or simply to insert another one.

Additional information

Flow input/output:
- input: adams.data.spectrum.Spectrum
- output: adams.data.spectrum.Spectrum

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	SetSpectrumAmplitude

  
  
• 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 spectrum is created before processing it.

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

  
  
• type
  

  How to set the amplitude.

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

  
  
• index
  

  The index of the amplitude to set.

  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 set.

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

  
  
• amplitude
  

  The amplitude to set.

  command-line	-amplitude <float>
  default	0.0