Build a lazy fmri_frame from NIfTI files

Wraps fmridataset::nifti_array_source(), so headers and the mask are read at construction but no BOLD volumes are read until the fit needs them. For fMRIPrep derivatives see fmridataset::read_bids_bold().

Usage

nifti_frame(
  scans,
  mask,
  TR,
  run_length = NULL,
  event_table = NULL,
  censor = NULL,
  base_path = ".",
  assay = "bold"
)

scans: Character vector of NIfTI paths, one per run, all on the same grid.
mask: A NIfTI mask path, a neuroim2::LogicalNeuroVol, or a fmridataset::volume_space().
TR: Repetition time in seconds; one value, or one per run.
run_length: Volumes per run; defaults to the fourth header dimension of each file.
event_table, censor: As in matrix_frame().
base_path: Directory that relative scans and mask paths are resolved against.
assay: Name of the assay.

An fmri_frame over the NIfTI source's volume_space.