spant (version 1.6.0)

sim_resonances: Simulate a MRS data object containing a set of simulated resonances.

Description

Simulate a MRS data object containing a set of simulated resonances.

Usage

sim_resonances(
  freq = 0,
  amp = 1,
  lw = 0,
  lg = 0,
  phase = 0,
  freq_ppm = TRUE,
  acq_paras = def_acq_paras()
)

Arguments

freq

resonance frequency.

amp

resonance amplitude.

lw

line width in Hz.

lg

Lorentz-Gauss lineshape parameter (between 0 and 1).

phase

phase in degrees.

freq_ppm

frequencies are given in ppm units if set to TRUE, otherwise Hz are assumed.

acq_paras

list of acquisition parameters. See def_acq_paras

Value

MRS data object.

Examples

# NOT RUN {
sim_data <- sim_resonances(freq = 2, lw = 5)
# }