Man pages for fMRItools
Routines for Common fMRI Processing Tasks

all_binaryAll binary?
all_integersAll integers?
as.matrix_iftiConvert CIFTI, NIFTI, or GIFTI input to T \times V matrix
bandstop_filterBandstop filter
carpetplotCarpetplot
carpetplot_stackStacked carpetplot
check_req_ifti_pkgCheck required packages for the data format
colCenterCenter matrix columns
color_paletteColor palette
CompCorAnatomical CompCor
CompCor_HCPAnatomical CompCor for HCP NIFTI and CIFTI data
CompCor.noise_compsCompCor: get noise components
coordlist_to_volConvert coordinate list to 3D array
cor_matUn-vectorize correlation matrix
crop_volCrop a 3D array
data_CompCor_ParamsfMRI data for 'scrub' and 'CompCor'
dct_basesGenerate cosine bases for the DCT
dct_convertDCT and frequency conversion
despike_3D3dDespike from AFNI
despike_3D.interpolate3dDespike from AFNI, step 2
despike_3D.qreg3dDespike from AFNI, step 1
dilate_mask_volDilate 3D mask
dim_reducePCA-based Dimension Reduction and Prewhitening
dual_regDual Regression
dual_reg_parcMultiple regression for parcel data
erode_mask_volErode 3D mask
expand_RPsExpand realignment parameters (RPs)
fft_detrendFFT detrending
fMRItoolsfMRItools: Routines for Common fMRI Processing Tasks
format_dataFormat data for pscrub and CompCor
format_pathFormat a path
fsl_bptf'bptf' function from FSL
get_FORMATGet FORMAT from format
get_kwargsGet kwargs
get_NIFTI_ROI_masksGet NIFTI ROI masks
hat_matrixHat matrix
image_scaleimage_scale
infer_format_iftiInfer fMRI data format
infer_format_ifti_vecInfer fMRI data format for several inputs
is_1Is this object the expected data type, and length one?
is_constantIs this numeric vector constant?
is.fnameIs this an existing file path?
is_integerIs this an integer?
is_posNumIs this object a positive number? (Or non-negative)
make_maskCreate a mask based on vertices that are invalid
mat2UTMatrix to Upper Triangular Vector
match_exactlyDo these character vectors match exactly?
match_inputMatch user inputs to expected values
mean_squaresCompute mean squares from variance decomposition
merge_kwargsMerges two kwargs
ModeMode of data vector
noise_Paramsnoise parameters for CompCor
norm_BOLDNormalize BOLD data
nuisance_regressionNuisance regression
pad_volPad 3D Array
PCAPCA for tall matrix
pct_sigConvert data values to percent signal.
plot_FCPlot FC
read_niftiWrapper to functions for reading NIFTIs
rowMedians2Row medians
scale_design_matScale a design matrix
scale_medRobust scaling
scale_timeseriesScale the BOLD timeseries
sign_flipSign match ICA results
skew_posPositive skew?
sum_neighbors_volSum of each voxel's neighbors
sys_pathFormat a path for 'system'
temporal_filterTemporal filtering (bandpass, highpass, lowpass) with DCT or...
unmask_matUnmask matrix data
unvec_matTransform vector data to image
unvec_volConvert vectorized data back to volume
UT2matUpper Triangular Vector to Matrix
validate_design_matValidate design matrix
var_decompCompute variance decomposition
vox_locationsGet coordinates of each voxel in a mask
fMRItools documentation built on April 12, 2025, 1:32 a.m.