Package: neuroim2 0.13.0

Bradley R Buchsbaum

neuroim2: Data Structures for Brain Imaging Data

A collection of data structures and methods for handling volumetric brain imaging data, with a focus on functional magnetic resonance imaging (fMRI). Provides efficient representations for three-dimensional and four-dimensional neuroimaging data through sparse and dense array implementations, memory-mapped file access for large datasets, and spatial transformation capabilities. Implements methods for image resampling, spatial filtering, region of interest analysis, and connected component labeling. General introduction to fMRI analysis can be found in Poldrack et al. (2024, "Handbook of functional MRI data analysis", <ISBN:9781108795760>).

Authors:Bradley R Buchsbaum [aut, cre, cph]

neuroim2_0.13.0.tar.gz
neuroim2_0.13.0.tar.gz(r-4.7-arm64)neuroim2_0.13.0.tar.gz(r-4.7-x86_64)neuroim2_0.13.0.tar.gz(r-4.6-arm64)neuroim2_0.13.0.tar.gz(r-4.6-x86_64)
neuroim2_0.13.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
card.svg |card.png
neuroim2/json (API)
NEWS

# Install 'neuroim2' in R:
install.packages('neuroim2', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/bbuchsbaum/neuroim2/issues

Pkgdown/docs site:https://bbuchsbaum.github.io

Uses libs:
  • c++– GNU Standard C++ Library v3
  • openmp– GCC OpenMP (GOMP) support library

On CRAN:

Conda:

cppopenmp

6.24 score 8 packages 261 scripts 519 downloads 213 exports 62 dependencies

Last updated from:5916b19cc7. Checks:6 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-arm64OK308
linux-devel-x86_64OK305
source / vignettesOK325
linux-release-arm64OK296
linux-release-x86_64OK372
wasm-releaseOK185

Exports:add_dimaffine_to_axcodesaffine_to_orientationannotate_orientationANT_POSTappend_diagapply_affineapply_orientationArithas_canonicalas_mmapas_nifti_headeras.arrayas.denseas.listas.maskas.matrixas.sparseaxcodesaxcodes_to_orientationaxesBigNeuroVecbilateral_filterbilateral_filter_4dBinaryReaderBinaryWriterblobby_shapebootstrap_searchlightboundscentroidcentroidscgb_filtercgb_make_graphcgb_smoothcgb_smooth_loroclosecluster_searchlight_seriesclustered_searchlightClusteredNeuroVecClusteredNeuroVolColumnReaderCompareconcatconn_compconn_comp_3Dcoord_to_gridcoord_to_indexcoordscreateNIfTIHeadercube_shapecuboid_roidata_filedata_file_matchesdata_readerDenseNeuroVecDenseNeuroVoldeobliquedim_ofdot_reducedownsampledropdrop_dimecode_nameellipsoid_shapeembed_kernelextensionextensionsfile_matchesFileBackedNeuroVecfindAnatomy3Dfrom_matvecgaussian_blurget_afni_attributegrid_to_coordgrid_to_gridgrid_to_indexguided_filterhas_extensionsheaderheader_fileheader_file_matchesimageindex_to_coordindex_to_gridIndexLookupVolindicesINF_SUPinverse_transKernellabelslaplace_enhanceLEFT_RIGHTlinear_accesslist_afni_attributesload_dataLogicLogicalNeuroVollookupmake_time_weightsmap_valuesmapfMappedNeuroVecMappedNeuroVecSourcemapToColorsmaskmatricized_accessmatrixToQuaternmeanmeta_infoMetaInfondimNeuroHyperVecNeuroSliceNeuroSpaceNeuroVecNeuroVecSeqNeuroVolNeuroVolSourceNiftiExtensionNiftiExtensionCodesNIFTIMetaInfoNoneNullAxisnum_clustersobliquityorientation_inverse_affineorientation_to_axcodesorientation_transformOrientationList2DOrientationList3Doriginoutput_aligned_spaceparse_afni_extensionparse_extensionpartitionpatch_setperm_matplotplot_montageplot_orthoplot_overlayPOST_ANTprepare_confoundsquaternToMatrixrandom_searchlightread_columnsread_elementsread_headerread_hyper_vecread_imageread_meta_inforead_vecread_volread_vol_listreorientresampleresample_toresampled_searchlightrescale_affineresolve_cmapRIGHT_LEFTROICoordsROIVecROIVolscalescale_fill_neuroscale_seriessearchlightsearchlight_coordsseriesseries_roishowsimulate_fmrisliceslice_to_volume_affineslice2volumeslicesspacespacingSparseNeuroVecSparseNeuroVolspherical_roispherical_roi_setsplit_blockssplit_clusterssplit_fillsplit_reducesplit_scalesquare_roistrip_extensionsub_clusterssub_vectorsummarySummarySUP_INFtemporal_accesstheme_neuroTIMETimeAxisto_matvectransvaluesvec_from_volsvectorsvolsvolume_labelsvox2out_voxvoxel_sizesvoxelswhich_dimwrite_elementswrite_vecwrite_vol

Dependencies:assertthatbigassertrbigparallelrbigstatsrbitcachemclicodetoolscowplotcpp11dbscandeflistdigestdoParallelfarverfastmapffflockforeachfuturefuture.applygenericsggplot2globalsgluegtableisobanditeratorslabelinglatticelifecyclelistenvmagrittrMatrixmemoisemmapparallellypillarpkgconfigpspurrrR6RColorBrewerRcppRcppArmadilloRcppEigenRcppParallelRhpcBLASctlrlangrmioRNiftiRNiftyRegRSpectraS7scalesstringistringrtibbleutf8vctrsviridisLitewithr

Advanced 3D Volume Patterns

Rendered fromImageVolumes.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2025-04-10

Advanced NeuroVec Patterns

Rendered fromNeuroVector.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2025-04-10

Advanced ROI Construction

Rendered fromregionOfInterest.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2025-04-10

Advanced Split, Map, and Reduce

Rendered frompipelines.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2025-04-10

Choosing a Backend

Rendered fromChoosingBackends.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-04-16

ClusteredNeuroVec: Parcel-based 4D Analysis

Rendered fromclustered-neurovec.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-01-14

Coordinate Systems and Spatial Transforms

Rendered fromcoordinate-systems.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-04-16

neuroim2 Cookbook

Rendered fromCookbook.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-01-14

Overview: Getting Started with neuroim2

Rendered fromOverview.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-01-14

Resampling, downsampling, and reorientation

Rendered fromResampling.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-01-14

ROIs, Searchlights, and Pipelines

Rendered fromAnalysisWorkflows.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-04-16

Slice visualization with neuroim2

Rendered fromslice-visualization.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-04-16

Smoothing and filtering with neuroim2

Rendered fromSmoothing.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-01-14

Working with Volumes and Vectors

Rendered fromVolumesAndVectors.Rmdusingknitr::rmarkdownon Jun 15 2026.

Last update: 2026-04-16
Started: 2026-04-16

Readme and manuals

Help Manual

Help pageTopics
neuroim2: neuroimaging data structures for analysisneuroim2-package neuroim2
[[[ [,AbstractSparseNeuroVec,numeric,numeric,ANY-method [,DenseNeuroVol,integer,missing,ANY-method [,DenseNeuroVol,numeric,missing,ANY-method [,DenseNeuroVol,ROIVol,missing,ANY-method [,NeuroVol,ROICoords,missing,ANY-method [,NeuroVol,ROIVol,missing,ANY-method [,ROICoords,numeric,missing,ANY-method [,ROIVol,logical,missing,ANY-method [,ROIVol,logical,numeric,ANY-method [,ROIVol,matrix,missing,ANY-method [,ROIVol,matrix,numeric,ANY-method [,ROIVol,missing,missing,ANY-method [,ROIVol,missing,numeric,ANY-method [,ROIVol,numeric,missing,ANY-method [,ROIVol,numeric,numeric,ANY-method [,ROIVol,ROICoords,missing,ANY-method [,ROIVol,ROICoords,numeric,ANY-method [,SparseNeuroVol,numeric,numeric,ANY-method [[,NeuroVec,character-method [[,NeuroVec,numeric-method
[[[[,AbstractSparseNeuroVec,numeric-method
Extract Element from NeuroVecSeq[[,NeuroVecSeq,numeric-method
AbstractSparseNeuroVec ClassAbstractSparseNeuroVec-class
Add a Dimension to an Objectadd_dim add_dim,NeuroSpace,numeric-method
Affine utility functionsaffine_utils append_diag apply_affine dot_reduce from_matvec obliquity rescale_affine to_matvec voxel_sizes
Pre-defined anatomical axesanatomical_axes ANT_POST INF_SUP LEFT_RIGHT POST_ANT RIGHT_LEFT SUP_INF
Add L/R and A/P/S/I annotations (optional)annotate_orientation
Arithmetic OperationsArith,ClusteredNeuroVol,ClusteredNeuroVol-method Arith,ClusteredNeuroVol,NeuroVol-method Arith,ClusteredNeuroVol,numeric-method Arith,DenseNeuroVec,DenseNeuroVec-method Arith,DenseNeuroVol,DenseNeuroVol-method Arith,DenseNeuroVol,numeric-method Arith,NeuroVec,NeuroVec-method Arith,NeuroVec,NeuroVol-method Arith,NeuroVol,ClusteredNeuroVol-method Arith,NeuroVol,NeuroVec-method Arith,NeuroVol,SparseNeuroVol-method Arith,numeric,ClusteredNeuroVol-method Arith,numeric,DenseNeuroVol-method Arith,numeric,SparseNeuroVol-method Arith,ROIVol,ROIVol-method Arith,SparseNeuroVec,SparseNeuroVec-method Arith,SparseNeuroVol,NeuroVol-method Arith,SparseNeuroVol,numeric-method Arith,SparseNeuroVol,SparseNeuroVol-method Arith-methods
ArrayLike3D ClassArrayLike3D-class
ArrayLike4D ClassArrayLike4D-class
ArrayLike5D ClassArrayLike5D-class
Reorient Image to Canonical (RAS+) Orientationas_canonical
Convert a NeuroVec to a memory-mapped representationas_mmap as_mmap,FileBackedNeuroVec-method as_mmap,MappedNeuroVec-method as_mmap,NeuroVec-method as_mmap,SparseNeuroVec-method as_mmap-methods
Construct a Minimal NIfTI-1 Header from a NeuroVolas_nifti_header
Convert ClusteredNeuroVol to DenseNeuroVolas-ClusteredNeuroVol-DenseNeuroVol coerce,ClusteredNeuroVol,DenseNeuroVol-method
Generic as.array Methodas.array
Convert ClusteredNeuroVol to a base arrayas.array,ClusteredNeuroVol-method as.array,SparseNeuroVec-method as.array,SparseNeuroVol-method
Convert to dense representationas.dense
Convert a NeuroVecSeq to a DenseNeuroVecas.dense,ClusteredNeuroVol-method as.dense,DenseNeuroVol-method as.dense,NeuroVecSeq-method as.dense,ROIVol-method as.dense,SparseNeuroVec-method as.dense,SparseNeuroVol-method
Convert FileBackedNeuroVec to Listas.list,FileBackedNeuroVec-method as.list,NeuroVec-method as.list,SparseNeuroVec-method
as.logicalas.logical as.logical,NeuroVol-method as.logical,ROIVol-method
Convert to a LogicalNeuroVolas.mask
Convert NeuroVol to a maskas.mask,NeuroVol,missing-method as.mask,NeuroVol,numeric-method
Generic as.matrix Methodas.matrix
convert a 'NeuroVec' to a matrixas.matrix,AbstractSparseNeuroVec-method as.matrix,ClusteredNeuroVec-method as.matrix,DenseNeuroVec-method as.matrix,MappedNeuroVec-method as.matrix,NeuroVec-method as.matrix,NeuroVecSeq-method as.matrix,ROIVec-method
Convert SparseNeuroVol to numericas.numeric,ROIVol-method as.numeric,SparseNeuroVol-method
Generic Method for Converting Objects to Raster Formatas.raster
Convert to from dense to sparse representationas.sparse
Convert DenseNeuroVec to sparse representation using maskas.sparse,DenseNeuroVec,LogicalNeuroVol-method as.sparse,DenseNeuroVec,numeric-method as.sparse,DenseNeuroVol,LogicalNeuroVol-method as.sparse,DenseNeuroVol,numeric-method as.sparse,ROIVol,ANY-method
Convert SparseNeuroVol to a base vectoras.vector,SparseNeuroVol-method
Get Orientation Axis Codesaxcodes axcodes,matrix-method axcodes,NeuroObj-method axcodes,NeuroSpace-method
Extract Image Axesaxes axes,NeuroSpace-method
AxisSetAxisSet-class
AxisSet1DAxisSet1D-class
AxisSet2DAxisSet2D-class
AxisSet3D ClassAxisSet3D-class
AxisSet4D ClassAxisSet4D-class
AxisSet5D ClassAxisSet5D-class
Create a Memory-Mapped Neuroimaging VectorBigNeuroVec
BigNeuroVec ClassBigNeuroVec-class
Apply a bilateral filter to a volumetric imagebilateral_filter
Apply a 4D bilateral filter to a NeuroVecbilateral_filter_4d
Create Binary Reader ObjectBinaryReader
BinaryReader ClassBinaryReader-class
Create Binary Writer ObjectBinaryWriter
BinaryWriter ClassBinaryWriter-class
Extract Spatial Bounds of an Imagebounds bounds,NeuroSpace-method
return the centroid of an objectcentroid centroid,NeuroSpace-method centroid,ROICoords-method
Return a matrix of centroids of an objectcentroids centroids,ClusteredNeuroVec-method centroids,ClusteredNeuroVol-method
Correlation-guided bilateral filtering (convenience wrapper)cgb_filter
Build a correlation-guided bilateral (CGB) graphcgb_make_graph
Apply a precomputed CGB graph to volumetric datacgb_smooth
Leave-one-run-out smoothing helpercgb_smooth_loro
Close a BinaryReader or BinaryWriterclose,BinaryReader-method close,BinaryWriter-method
Cluster-centroid searchlight over cluster time-seriescluster_searchlight_series
Create a clustered searchlight iteratorclustered_searchlight
ClusteredNeuroVec: Cluster-aware 4D neuroimaging dataClusteredNeuroVec
ClusteredNeuroVec ClassClusteredNeuroVec-class
ClusteredNeuroVol ClassClusteredNeuroVol ClusteredNeuroVol-class
Create Column Reader ObjectColumnReader
ColumnReaderColumnReader-class
Comparison OperationsCompare,DenseNeuroVol,DenseNeuroVol-method Compare,DenseNeuroVol,numeric-method Compare,NeuroVec,NeuroVec-method Compare,numeric,DenseNeuroVol-method Compare,numeric,SparseNeuroVol-method Compare,SparseNeuroVol,numeric-method Compare-methods
Concatenate two objects in the time dimensionconcat concat,AbstractSparseNeuroVec,missing-method concat,DenseNeuroVol,DenseNeuroVol-method concat,DenseNeuroVol,missing-method concat,NeuroVec,NeuroVec-method concat,NeuroVec,NeuroVol-method concat,NeuroVol,NeuroVec-method concat,ROIVec,ROIVec-method concat,SparseNeuroVec,SparseNeuroVec-method
Connected componentsconn_comp conn_comp,NeuroVol-method
Extract Connected Components from a 3D Binary Maskconn_comp_3D
convert n-dimensional real world coordinates to grid coordinatescoord_to_grid coord_to_grid,NeuroSpace,matrix-method coord_to_grid,NeuroSpace,numeric-method coord_to_grid,NeuroVol,matrix-method coord_to_grid,NeuroVol,numeric-method
convert n-dimensional real world coordinates to 1D indicescoord_to_index coord_to_index,NeuroSpace,matrix-method coord_to_index,NeuroSpace,numeric-method coord_to_index,NeuroVol,matrix-method
Extract coordinates from an objectcoords
Extract Coordinates from an IndexLookupVol Objectcoords,AbstractSparseNeuroVec-method coords,IndexLookupVol-method coords,ROICoords-method coords,ROIVol-method
Create an Empty NIfTI-1 Header ListcreateNIfTIHeader
Create A Cuboid Region of Interestcuboid_roi
Generic function to get the name of the data file, given a file name and a 'FileFormat' instance.data_file data_file,FileFormat,character-method
Generic function to test whether a file name conforms to the given a 'FileFormat' instance. Will test for match to data file onlydata_file_matches data_file_matches,FileFormat,character-method
Create a Data Readerdata_reader
Create Data Reader for AFNI Formatdata_reader,AFNIMetaInfo-method data_reader,NIFTIMetaInfo-method
DenseNeuroVec ClassDenseNeuroVec DenseNeuroVec-class
DenseNeuroVol ClassDenseNeuroVol DenseNeuroVol-class
Deoblique a Neuroimaging Space or Volumedeoblique
Get the length of a given dimension of an objectdim_of dim_of,NeuroSpace,NamedAxis-method
Get Dimensions of FileMetaInfo Objectdim,ClusteredNeuroVec-method dim,FileMetaInfo-method dim,NeuroHyperVec-method dim,NeuroObj-method dim,NeuroSpace-method dim,ROICoords-method dim,ROIVol-method
Downsample an Imagedownsample downsample,DenseNeuroVec-method downsample,DenseNeuroVol-method downsample,NeuroVec-method downsample,NeuroVol-method downsample,SparseNeuroVec-method
Generic Drop Methoddrop
Drop a Dimension from an Objectdrop_dim drop_dim,AxisSet2D,missing-method drop_dim,AxisSet2D,numeric-method drop_dim,AxisSet3D,missing-method drop_dim,AxisSet3D,numeric-method drop_dim,NeuroSpace,missing-method drop_dim,NeuroSpace,numeric-method
Drop a dimensiondrop,NeuroVec-method
Get Extension Code Nameecode_name
Generic function to position kernel in a position in image spaceembed_kernel embed_kernel,Kernel,NeuroSpace,numeric-method
Get Extension by Codeextension extension,NiftiExtensionList,numeric-method
Get Extensions from an Objectextensions
Array-like access for 3-dimensional data structuresextractor3d [,ArrayLike3D,matrix,missing,ANY-method [,ArrayLike3D,missing,missing,ANY-method [,ArrayLike3D,missing,numeric,ANY-method [,ArrayLike3D,numeric,missing,ANY-method
Array-like access for 4-dimensional data structuresextractor4d [,ArrayLike4D,integer,missing,ANY-method [,ArrayLike4D,matrix,missing,ANY-method [,ArrayLike4D,missing,missing,ANY-method [,ArrayLike4D,missing,numeric,ANY-method [,ArrayLike4D,numeric,missing,ANY-method [,ArrayLike4D,numeric,numeric,ANY-method [,ClusteredNeuroVec,missing,missing,ANY-method [,ClusteredNeuroVec,numeric,numeric,ANY-method
Generic function to test whether a file name conforms to the given 'FileFormat' instance. Will test for match to either header file or data filefile_matches file_matches,FileFormat,character-method
Create a File-Backed Neuroimaging VectorFileBackedNeuroVec
FileBackedNeuroVec ClassFileBackedNeuroVec-class
FileFormat ClassFileFormat-class
File Format Operations for Neuroimaging DataFileFormat-operations
FileMetaInfo ClassAFNIMetaInfo-class FileMetaInfo-class NIFTIMetaInfo-class
FileSource ClassFileSource-class
Find 3D anatomical orientation from axis abbreviationsfindAnatomy3D
Gaussian Blur for Volumetric Imagesgaussian_blur
Get AFNI Attribute from Extensionget_afni_attribute
Generic function to convert N-dimensional grid coordinates to real world coordinatesgrid_to_coord grid_to_coord,NeuroSpace,matrix-method grid_to_coord,NeuroSpace,numeric-method grid_to_coord,NeuroVol,matrix-method
Generic function to convert voxel coordinates in the reference space (LPI) to native array space.grid_to_grid grid_to_grid,matrix,matrix-method grid_to_grid,NeuroSpace,matrix-method
Generic function to convert N-dimensional grid coordinates to 1D indicesgrid_to_index grid_to_index,NeuroSlice,matrix-method grid_to_index,NeuroSlice,numeric-method grid_to_index,NeuroSpace,matrix-method grid_to_index,NeuroSpace,numeric-method grid_to_index,NeuroVol,matrix-method grid_to_index,NeuroVol,numeric-method
Edge-Preserving Guided Filter for Volumetric Imagesguided_filter
Check if Extensions are Presenthas_extensions has_extensions,list-method has_extensions,NiftiExtensionList-method
Access NIfTI Header Informationheader header,character-method header,FileMetaInfo-method
Generic function to get the name of the header file, given a file name and a 'FileFormat' instance.header_file header_file,FileFormat,character-method
Generic function to test whether a file name conforms to the given 'FileFormat' instance. Will test for match to header file onlyheader_file_matches header_file_matches,FileFormat,character-method
Generic Image Method for Creating Visual Representationsimage
convert 1d indices to n-dimensional real world coordinatesindex_to_coord index_to_coord,NeuroSpace,integer-method index_to_coord,NeuroSpace,numeric-method index_to_coord,NeuroVec,integer-method index_to_coord,NeuroVol,integer-method
Convert 1d indices to n-dimensional grid coordinatesindex_to_grid index_to_grid,NeuroSlice,numeric-method index_to_grid,NeuroSpace,numeric-method index_to_grid,NeuroVec,index-method index_to_grid,NeuroVec,integer-method index_to_grid,NeuroVol,index-method index_to_grid,NeuroVol,integer-method
IndexLookupVol ClassIndexLookupVol IndexLookupVol-class
Extract indicesindices
Get Indices from an IndexLookupVol Objectindices,AbstractSparseNeuroVec-method indices,IndexLookupVol-method indices,ROIVec-method indices,ROIVol-method
Extract inverse image coordinate transformationinverse_trans inverse_trans,NeuroSpace-method
Create a Kernel object from a function of distance from kernel centerKernel
KernelKernel-class
Get Labels from ClusteredNeuroVeclabels,ClusteredNeuroVec-method
Laplacian Enhancement Filter for Volumetric Imageslaplace_enhance
Get length of NeuroVec objectlength,ClusteredNeuroVec-method length,NeuroVec-method length,NeuroVecSeq-method length,ROICoords-method length,ROIVol-method
Extract values from an array-like object using linear indexing.linear_access
Linear Access Method for FileBackedNeuroVeclinear_access,AbstractSparseNeuroVec,numeric-method linear_access,DenseNeuroVec,integer-method linear_access,DenseNeuroVec,numeric-method linear_access,DenseNeuroVol,integer-method linear_access,DenseNeuroVol,numeric-method linear_access,FileBackedNeuroVec,numeric-method linear_access,MappedNeuroVec,numeric-method linear_access,NeuroHyperVec,ANY-method linear_access,NeuroVecSeq,numeric-method linear_access,SparseNeuroVol,numeric-method
List AFNI Attributes in Extensionlist_afni_attributes
Load image data from a NeuroVecSource objectload_data,MappedNeuroVecSource-method load_data,NeuroVecSource-method load_data,NeuroVolSource-method load_data,SparseNeuroVecSource-method
Logic Operations for Neuroimaging VolumesLogic,DenseNeuroVol,DenseNeuroVol-method Logic,logical,NeuroVol-method Logic,NeuroVol,logical-method Logic,NeuroVol,SparseNeuroVol-method Logic,SparseNeuroVol,NeuroVol-method Logic,SparseNeuroVol,SparseNeuroVol-method Logic-methods
LogicalNeuroVol ClassLogicalNeuroVol LogicalNeuroVol-class
Index Lookup operationlookup
Lookup Values in an IndexLookupVol Objectlookup,AbstractSparseNeuroVec,numeric-method lookup,IndexLookupVol,numeric-method
Build smooth time weights from motion/outlier metricsmake_time_weights
Map Values from One Set to Another Using a User-supplied Lookup Tablemap_values map_values,NeuroVol,list-method map_values,NeuroVol,matrix-method
Apply a function to an object.mapf mapf,NeuroVol,Kernel-method
MappedNeuroVec ClassMappedNeuroVec MappedNeuroVec-class
MappedNeuroVecSource ClassMappedNeuroVecSource MappedNeuroVecSource-class
Map intensity values to colorsmapToColors
Extract Mask from Neuroimaging Objectmask mask,AbstractSparseNeuroVec-method mask,ClusteredNeuroVol-method mask,DenseNeuroVec-method mask,DenseNeuroVol-method mask,FileBackedNeuroVec-method mask,LogicalNeuroVol-method mask,MappedNeuroVec-method mask,NeuroHyperVec-method mask,NeuroSlice-method mask,SparseNeuroVecSource-method
Extract values from a 4D tensor using a matrix of time-space indices.matricized_access matricized_access,BigNeuroVec,integer-method matricized_access,BigNeuroVec,matrix-method matricized_access,BigNeuroVec,numeric-method matricized_access,SparseNeuroVec,integer-method matricized_access,SparseNeuroVec,matrix-method matricized_access,SparseNeuroVec,numeric-method
Convert a Transformation Matrix to a Quaternion RepresentationmatrixToQuatern
Temporal Mean of a NeuroVecmean,DenseNeuroVec-method mean,NeuroVec-method mean,SparseNeuroVec-method mean-methods
Lightweight metadata for neuroimaging filesmeta_info meta_info,character-method meta_info,FileMetaInfo-method
Create Neuroimaging Metadata ObjectMetaInfo
MetaInfo ClassMetaInfo-class
NamedAxisNamedAxis-class
Extract the number of dimensions of an objectndim ndim,AxisSet-method ndim,ClusteredNeuroVec-method ndim,NeuroHyperVec-method ndim,NeuroObj-method ndim,NeuroSpace-method
Downsampling Methods for Neuroimaging Objectsneuro-downsample
Arithmetic and Comparison Operations for Neuroimaging Objectsneuro-ops
Resampling Methods for Neuroimaging Objectsneuro-resample
NeuroBucketNeuroBucket-class
Constructor for NeuroHyperVec classNeuroHyperVec
NeuroHyperVec ClassNeuroHyperVec-class [,NeuroHyperVec,ANY,ANY,ANY-method [.NeuroHyperVec
NeuroObj ClassNeuroObj-class
NeuroSlice: 2D Neuroimaging Data ContainerNeuroSlice
NeuroSlice ClassNeuroSlice-class
NeuroSpace: Spatial Reference System for Neuroimaging DataNeuroSpace
NeuroSpace ClassNeuroSpace-class
NeuroVec ClassNeuroVec NeuroVec-class
NeuroVecSeq: A Container for Sequential NeuroVec ObjectsNeuroVecSeq
NeuroVecSeq ClassNeuroVecSeq-class
NeuroVecSourceNeuroVecSource
NeuroVecSource ClassNeuroVecSource-class
NeuroVol: 3D Neuroimaging Volume ClassNeuroVol
NeuroVol ClassNeuroVol-class
Constructor for NeuroVolSourceNeuroVolSource
Create a NIfTI ExtensionNiftiExtension
NiftiExtension ClassNiftiExtension-class show,NiftiExtension-method
Known NIfTI Extension CodesNiftiExtensionCodes
NiftiExtensionList ClassNiftiExtensionList-class show,NiftiExtensionList-method
Create NIFTI Format Metadata ObjectNIFTIMetaInfo
Pre-defined null axisNone
Logical Negation for Neuroimaging Volumes!,DenseNeuroVol-method !,SparseNeuroVol-method not-methods
Pre-defined null axis setNullAxis
Number of Clustersnum_clusters num_clusters,ClusteredNeuroVec-method num_clusters,ClusteredNeuroVol-method
numericOrMatrix UnionnumericOrMatrix-class
Orientation utility functionsaffine_to_axcodes affine_to_orientation apply_orientation axcodes_to_orientation orientation_inverse_affine orientation_to_axcodes orientation_transform orientation_utils
Pre-defined 2D orientation configurationsOrientationList2D
Pre-defined 3D orientation configurationsOrientationList3D
Extract Image Originorigin origin,NeuroHyperVec-method origin,NeuroSpace-method origin,NeuroVec-method origin,NeuroVol-method
Parse AFNI Extensionparse_afni_extension
Parse NIfTI Extension Dataparse_extension
Partition an image into a set of disjoint clusterspartition partition,DenseNeuroVol,numeric-method partition,LogicalNeuroVol,integer-method partition,LogicalNeuroVol,numeric-method
Generate a set of coordinate "patches" of fixed size from an image object.patch_set
Create a patch set from a NeuroVol objectpatch_set,NeuroVol,numeric,LogicalNeuroVol-method patch_set,NeuroVol,numeric,missing-method
Extract permutation matrix associated with an imageperm_mat perm_mat,AxisSet2D-method perm_mat,AxisSet3D-method perm_mat,NeuroSpace-method
Plot a montage of axial (or any-plane) slices using facettingplot_montage
Orthogonal three-plane view with optional crosshairsplot_ortho
Composite an overlay map on a structural backgroundplot_overlay
Plot a NeuroSliceplot,NeuroSlice,ANY-method plot,NeuroSlice-method plot,NeuroVol,missing-method plot,NeuroVol,NeuroVol-method plot,NeuroVol-method
Prepare weighted nuisance projectors for each runprepare_confounds
Convert Quaternion Parameters to a Transformation MatrixquaternToMatrix
Create a spherical random searchlight iteratorrandom_searchlight
read header information of an image fileread_header
Read a 5D image as a NeuroHyperVecread_hyper_vec
read_imageread_image
Generic function to read image meta info given a fileread_meta_info read_meta_info,AFNIFormat-method read_meta_info,NIFTIFormat-method
read_vecread_vec
Load a single 3D image volume from a fileread_vol
read_vol_listread_vol_list
Remap the grid-to-world coordinates mapping of an image.reorient reorient,NeuroSpace,character-method
Resample an Image to Match the Space of Another Imageresample resample,ClusteredNeuroVol,NeuroSpace-method resample,ClusteredNeuroVol,NeuroVol-method resample,NeuroVol,NeuroSpace-method resample,NeuroVol,NeuroVol-method
Resample an image with readable method namesresample_to
Create a resampled searchlight iteratorbootstrap_searchlight resampled_searchlight
Neuroimaging color palettes and helpersresolve_cmap
ROIROI-class
Create ROI Coordinates ObjectROICoords
ROICoordsROICoords-class
Create an instance of class 'ROIVec'ROIVec
ROIVecROIVec-class
ROIVecWindowROIVecWindow-class
Create ROI Volume ObjectROIVol
ROIVolROIVol-class
ROIVolWindowROIVolWindow-class
Generic Scale Methodscale
A ggplot2 fill scale with neuroimaging-friendly defaultsscale_fill_neuro
Generic functions to scale (center and/or normalize by standard deviation) each series of a 4D image That is, if the 4th dimension is 'time' each series is a 1D time series.scale_series scale_series,DenseNeuroVec,logical,logical-method scale_series,NeuroVec,logical,logical-method scale_series,NeuroVec,logical,missing-method scale_series,NeuroVec,missing,logical-method scale_series,NeuroVec,missing,missing-method scale_series,SparseNeuroVec,logical,logical-method
Create an exhaustive searchlight iteratorsearchlight
Create an exhaustive searchlight iterator for voxel coordinates using spherical_roisearchlight_coords
Convenience shape generators for 'resampled_searchlight()'blobby_shape cube_shape ellipsoid_shape searchlight_shape_functions
Searchlight Analysis Methodssearchlight-methods
Extract one or more series from objectseries series,AbstractSparseNeuroVec,integer-method series,AbstractSparseNeuroVec,matrix-method series,AbstractSparseNeuroVec,numeric-method series,AbstractSparseNeuroVec,ROICoords-method series,ClusteredNeuroVec,numeric-method series,DenseNeuroVec,integer-method series,DenseNeuroVec,matrix-method series,NeuroHyperVec,ANY-method series,NeuroVec,integer-method series,NeuroVec,LogicalNeuroVol-method series,NeuroVec,matrix-method series,NeuroVec,NeuroVol-method series,NeuroVec,numeric-method series,NeuroVec,ROICoords-method series,NeuroVecSeq,integer-method series,NeuroVecSeq,matrix-method series,NeuroVecSeq,numeric-method series_roi,NeuroVec,LogicalNeuroVol-method series_roi,NeuroVec,matrix-method series_roi,NeuroVec,numeric-method series_roi,NeuroVec,ROICoords-method series_roi,NeuroVecSeq,matrix-method
Extract time series from specific voxel coordinates and return as ROI objectseries_roi
Show method for NamedAxis objectsshow,AxisSet1D-method show,AxisSet2D-method show,AxisSet3D-method show,AxisSet4D-method show,ClusteredNeuroVec-method show,ClusteredNeuroVol-method show,DenseNeuroVec-method show,DenseNeuroVol-method show,FileMetaInfo-method show,IndexLookupVol-method show,Kernel-method show,MappedNeuroVec-method show,NamedAxis-method show,NeuroHyperVec-method show,NeuroSlice-method show,NeuroSpace-method show,NeuroVec-method show,NeuroVecSeq-method show,NeuroVecSource-method show,NeuroVol-method show,ROICoords-method show,ROIVec-method show,ROIVol-method show,SparseNeuroVec-method show,SparseNeuroVol-method
Simulate fMRI Datasimulate_fmri
Extract image sliceslice slice,NeuroVol,numeric,NeuroSpace,AxisSet3D-method slice,NeuroVol,numeric,numeric,missing-method
Extract an ordered series of 2D slices from a 3D or 4D objectslices slices,NeuroVol-method
Extract Geometric Properties of an Imagespace space,ClusteredNeuroVec-method space,IndexLookupVol-method space,NeuroHyperVec-method space,NeuroObj-method space,NeuroSpace-method space,ROICoords-method
Space utility functionsoutput_aligned_space slice2volume slice_to_volume_affine space_utils vox2out_vox
Extract Voxel Dimensions of an Imagespacing spacing,NeuroHyperVec-method spacing,NeuroObj-method spacing,NeuroSpace-method spacing,ROICoords-method
SparseNeuroVec ClassSparseNeuroVec SparseNeuroVec-class
SparseNeuroVecSource ClassSparseNeuroVecSource-class
SparseNeuroVol ClassSparseNeuroVol SparseNeuroVol-class
Spatial Filtering Methods for Neuroimaging Dataspatial-filter
Create a Spherical Region of Interestspherical_roi
Create Multiple Spherical Regions of Interestspherical_roi_set
Cut a vector-valued object into a list of sub-blockssplit_blocks split_blocks,NeuroVec,factor-method split_blocks,NeuroVec,integer-method
Cut an object into a list of spatial or spatiotemporal clusterssplit_clusters split_clusters,ClusteredNeuroVol,missing-method split_clusters,NeuroVec,ClusteredNeuroVol-method split_clusters,NeuroVec,integer-method split_clusters,NeuroVec,numeric-method split_clusters,NeuroVol,ClusteredNeuroVol-method split_clusters,NeuroVol,integer-method split_clusters,NeuroVol,numeric-method
Fill Disjoint Sets of Values with the Output of a Functionsplit_fill split_fill,NeuroVol,factor,function-method
Summarize Subsets of an Object by Splitting by Row and Applying a Summary Functionsplit_reduce split_reduce,matrix,factor,function-method split_reduce,matrix,factor,missing-method split_reduce,matrix,integer,function-method split_reduce,NeuroVec,factor,function-method split_reduce,NeuroVec,factor,missing-method
Center and/or Scale Row-subsets of a Matrix or Matrix-like Objectsplit_scale split_scale,DenseNeuroVec,factor,logical,logical-method split_scale,DenseNeuroVec,factor,logical,missing-method split_scale,DenseNeuroVec,factor,missing,missing-method split_scale,matrix,factor,logical,logical-method split_scale,matrix,factor,missing,missing-method
Create a square region of interestsquare_roi
Generic function to strip extension from file name, given a 'FileFormat' instance.strip_extension strip_extension,FileFormat,character-method
Select a Subset of Clusterssub_clusters sub_clusters,ClusteredNeuroVec,character-method sub_clusters,ClusteredNeuroVec,integer-method sub_clusters,ClusteredNeuroVec,numeric-method sub_clusters,ClusteredNeuroVol,character-method sub_clusters,ClusteredNeuroVol,integer-method sub_clusters,ClusteredNeuroVol,numeric-method
Generic function to extract a sub-vector from a 'NeuroVec' object.sub_vector sub_vector,AbstractSparseNeuroVec,numeric-method sub_vector,FileBackedNeuroVec,numeric-method sub_vector,NeuroVec,character-method sub_vector,NeuroVec,numeric-method sub_vector,NeuroVecSeq,numeric-method
Summary Methods for Neuroimaging ObjectsSummary,DenseNeuroVol-method Summary,SparseNeuroVec-method Summary,SparseNeuroVol-method Summary-methods
Summary of Neuroimaging Objectssummary,DenseNeuroVec-method summary,NeuroVol-method summary,SparseNeuroVec-method summary-neuro-methods
Extract full sparse rows across time.temporal_access temporal_access,BigNeuroVec,integer-method temporal_access,BigNeuroVec,numeric-method temporal_access,SparseNeuroVec,integer-method temporal_access,SparseNeuroVec,numeric-method
A minimal, publication-friendly theme for image slicestheme_neuro
Time axisTIME
Time axis setTimeAxis
Extract image coordinate transformationtrans trans,MetaInfo-method trans,NeuroHyperVec-method trans,NeuroObj-method trans,NeuroSpace-method trans,NIFTIMetaInfo-method
Extract Data Values of an Objectvalues values,ClusteredNeuroVec-method values,DenseNeuroVol-method values,ROIVec-method values,ROIVol-method values,SparseNeuroVol-method
Create NeuroVec from list of NeuroVol objectsvec_from_vols
Extract an ordered list of 1D vectors.vectors vectors,DenseNeuroVec,missing-method vectors,matrix,integer-method vectors,matrix,missing-method vectors,matrix,numeric-method vectors,NeuroVec,logical-method vectors,NeuroVec,missing-method vectors,NeuroVec,numeric-method vectors,NeuroVecSeq,logical-method vectors,NeuroVecSeq,missing-method vectors,NeuroVecSeq,numeric-method vectors,ROIVec,integer-method vectors,ROIVec,logical-method vectors,ROIVec,missing-method vectors,ROIVec,numeric-method vectors,SparseNeuroVec,missing-method
Extract an ordered series of 3D volumes.vols vols,NeuroVec,missing-method vols,NeuroVec,numeric-method
Get per-volume labels for a 'NeuroVec'.volume_labels volume_labels,NeuroVec-method
extract voxel coordinatesvoxels voxels,Kernel-method
Find Dimensions of a Given Axiswhich_dim which_dim,NeuroSpace,NamedAxis-method
Write a sequence of elements from an input sourcewrite_elements write_elements,BinaryWriter,numeric-method
Write a 4d image vector to diskwrite_vec write_vec,NeuroHyperVec,character,character,missing-method write_vec,NeuroHyperVec,character,missing,character,ANY-method write_vec,NeuroHyperVec,character,missing,character-method write_vec,NeuroHyperVec,character,missing,missing-method write_vec,NeuroVec,character,character,missing-method write_vec,NeuroVec,character,missing,character,ANY-method write_vec,NeuroVec,character,missing,character-method write_vec,NeuroVec,character,missing,missing-method write_vec,ROIVec,character,missing,missing-method
Write a 3d image volume to diskwrite_vol write_vol,ClusteredNeuroVol,character,missing,missing-method write_vol,NeuroVol,character,character,missing-method write_vol,NeuroVol,character,missing,character-method write_vol,NeuroVol,character,missing,missing-method write_vol,ROIVol,character,character,missing-method