spant (version 1.14.0)

rats: Robust Alignment to a Target Spectrum (RATS).

Description

Robust Alignment to a Target Spectrum (RATS).

Usage

rats(
  mrs_data,
  ref = NULL,
  xlim = c(4, 0.5),
  max_shift = 20,
  p_deg = 2,
  sp_N = 2,
  sp_deg = 3,
  max_t = 0.2,
  basis_type = "poly",
  rescale_output = TRUE,
  phase_corr = TRUE
)

Arguments

mrs_data

MRS data to be corrected.

ref

optional MRS data to use as a reference, the mean of all dynamics is used if this argument is not supplied.

xlim

optional frequency range to perform optimisation, set to NULL to use the full range.

max_shift

maximum allowable frequency shift in Hz.

p_deg

polynomial degree used for baseline modelling. Negative values disable baseline modelling.

sp_N

number of spline functions, note the true number will be sp_N + sp_deg.

sp_deg

degree of spline functions.

max_t

truncate the FID when longer than max_t to reduce time taken, set to NULL to use the entire FID.

basis_type

may be one of "poly" or "spline".

rescale_output

rescale the bl_matched_spec and bl output to improve consistency between dynamic scans.

phase_corr

apply phase correction (in addition to frequency). TRUE by default.

Value

a list containing the corrected data; phase and shift values in units of degrees and Hz respectively.