getHRF: getHRF

In bbuchsbaum/fmrireg: R package for the anlysis of fmri data

getHRF

Description

This function retrieves a specified hemodynamic response function (HRF) by name and creates an HRF object with specified properties.

Usage

getHRF(
  name = c("gam", "gamma", "spmg1", "spmg2", "spmg3", "bspline", "gaussian", "tent",
    "bs"),
  nbasis = 5,
  span = 24,
  lag = 0,
  width = 0,
  summate = TRUE,
  normalize = FALSE,
  ...
)

Arguments

name	The name of the HRF function. Available options: "gamma", "spmg1", "spmg2", "spmg3", "bspline", "gaussian", "tent", "bs".
nbasis	The number of basis functions (if relevant, default: 5).
span	The temporal window over which the basis sets span (default: 24).
lag	The time lag parameter (default: 0).
width	The width parameter (default: 0).
summate	Whether the HRF response increases its amplitude as a function of stimulus duration (default: TRUE).
normalize	Whether to scale output so that the peak is 1 (default: FALSE).
...	Additional arguments passed to the gen_hrf function.

Value

An HRF object with the specified properties.

Examples

hrf_obj <- getHRF(name = "gamma", nbasis = 5, span = 24)

bbuchsbaum/fmrireg documentation built on May 16, 2023, 10:56 a.m.