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

Description Usage Arguments Value Examples

View source: R/mrs_data_proc.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
sim_resonances(
  freq = 0,
  amp = 1,
  lw = 0,
  lg = 0,
  phase = 0,
  freq_ppm = TRUE,
  acq_paras = def_acq_paras(),
  fp_scale = TRUE,
  back_extrap_pts = 0
)

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

fp_scale

multiply the first data point by 0.5.

back_extrap_pts

number of data points to back extrapolate.

Value

MRS data object.

Examples

1
sim_data <- sim_resonances(freq = 2, lw = 5)

neuroconductor/spant documentation built on May 25, 2021, 1:49 a.m.