R/baseline_arpls.R

Defines functions baseline_arpls

Documented in baseline_arpls

#' @title Asymmetrically Reweighted Penalized Least Squares
#'
#' @author Christian L. Goueguel
#'
#' @description
#' Baseline correction based on asymmetrically reweighted penalized least
#' squares smoothing algorithm as proposed by Baek *et al.* (2015).
#'
#' @details
#' The algorithm estimates a baseline curve by iteratively updating weights based
#' on the residuals and minimizing a penalized least squares criterion. The
#' resulting baseline curve is subtracted from the input data, providing a
#' baseline-corrected version.
#'
#' The penalized system is pentadiagonal and is solved in C++ with a banded
#' Cholesky decomposition, so the cost grows linearly with the number of
#' spectral channels.
#'
#' @references
#'  - Baek, S.-J., Park, A., Ahn, Y.-J., Choo, J., (2015).
#'    Baseline correction using asymmetrically reweighted penalized least squares smoothing.
#'    Analyst, 140(1):250–257.
#'
#' @param x A numeric matrix or data frame, with one spectrum per row.
#' @param lambda A numeric value specifying the smoothing parameter, which controls the amount of curvature allowed for the baseline. The smaller the lambda, the more curvature in the baseline fitting. Default is 1000.
#' @param ratio A numeric value specifying the convergence ratio for the iterative algorithm. The algorithm stops when the relative change in the weights is less than this ratio. Typical values are between 0.01 and 0.1. Default is 0.05.
#' @param max_iter Maximum number of iterations for the algorithm. Default is 10.
#' @param max.iter `r lifecycle::badge("deprecated")` Use `max_iter`.
#'
#' @return A list containing two tibbles:
#' \itemize{
#'   \item \code{correction}: The baseline-corrected spectral matrix.
#'   \item \code{background}: The fitted background emission.
#' }
#'
#' @export baseline_arpls
#'
#' @examples
#' data(forageLIBS)
#' spectrum <- forageLIBS[1, -(1:14)]
#' wl <- as.numeric(names(spectrum))
#' in_region <- wl > 240 & wl < 300
#' region <- spectrum[in_region]
#' res <- baseline_arpls(region, lambda = 1e5)
#' oldpar <- par(mfrow = c(2, 1), mar = c(4, 4, 2, 1))
#' # the spectrum and its fitted baseline
#' plot(wl[in_region], unlist(region), type = "l", col = "grey40", ylim = c(800, 3000),
#'      xlab = "Wavelength (nm)", ylab = "Counts", main = "Spectrum and baseline")
#' lines(wl[in_region], unlist(res$background), col = "red")
#' # the corrected spectrum: the background is now around zero
#' plot(wl[in_region], unlist(res$correction), type = "l", col = "grey40",
#'      ylim = c(-200, 2000), xlab = "Wavelength (nm)", ylab = "Counts",
#'      main = "Corrected spectrum")
#' abline(h = 0, col = "red", lty = 2)
#' par(oldpar)
baseline_arpls <- function(x, lambda = 1e3, ratio = 0.05, max_iter = 10,
                           max.iter = deprecated()) {
  max_iter <- renamed_arg(max.iter, max_iter, "baseline_arpls", "max.iter", "max_iter")
  if (missing(x)) {
    stop("Missing 'x' argument.")
  }
  if (!is.numeric(lambda) || length(lambda) != 1) {
    stop("'lambda' must be a single numeric value.")
  }
  if (!is.numeric(ratio) || length(ratio) != 1) {
    stop("'ratio' must be a single numeric value.")
  }
  if (ratio <= 0) {
    stop("'ratio' must be positive.")
  }
  if (!is.numeric(max_iter) || length(max_iter) != 1) {
    stop("'max_iter' must be a single numeric value.")
  }
  baseline_fit(x, lambda, ratio, max_iter, method = 1L)
}

Try the specProc package in your browser

Any scripts or data that you put into this service are public.

specProc documentation built on Nov. 20, 2026, 5:11 p.m.