neuroim20.8.1 package

Data Structures for Brain Imaging Data

AbstractSparseNeuroVec-class

AbstractSparseNeuroVec Class

add_dim-methods

Add a Dimension to an Object

AFNIMetaInfo

Create AFNI Format Metadata Object

anatomical_axes

Pre-defined anatomical axes

Arith-methods

Arithmetic Operations

Arith-NeuroVec-NeuroVol-method

Arithmetic Operations for NeuroVec and NeuroVol

Arith-NeuroVol-NeuroVec-method

Arithmetic Operations for NeuroVol and NeuroVec

Arith-ROIVol-ROIVol-method

This function performs arithmetic operations on two ROIVol objects.

ArrayLike3D-class

ArrayLike3D Class

ArrayLike4D-class

ArrayLike4D Class

ArrayLike5D-class

ArrayLike5D Class

as_nifti_header

Construct a Minimal NIfTI-1 Header from a NeuroVol

as-ClusteredNeuroVol-DenseNeuroVol

Convert ClusteredNeuroVol to DenseNeuroVol

as-DenseNeuroVol-array

Convert DenseNeuroVol to array

as.dense-methods

Coerce ROIVol to DenseNeuroVol using as.dense method

as.dense

Convert to dense representation

as.list-methods

Convert FileBackedNeuroVec to List

as.logical-methods

as.logical

as.mask-methods

Convert NeuroVol to a mask

as.mask

Convert to a LogicalNeuroVol

as.matrix-methods

convert a NeuroVec to a matrix

as.matrix

Generic as.matrix Method

as.numeric-methods

Convert SparseNeuroVol to numeric

as.raster

Generic Method for Converting Objects to Raster Format

as

conversion from NeuroVol to LogicalNeuroVol

as.sparse-methods

Convert DenseNeuroVec to sparse representation using mask

as.sparse

Convert to from dense to sparse representation

axes-methods

Extract Image Axes

AxisSet-class

AxisSet

AxisSet1D-class

AxisSet1D

AxisSet2D-class

AxisSet2D

AxisSet3D-class

AxisSet3D Class

AxisSet4D-class

AxisSet4D Class

AxisSet5D-class

AxisSet5D Class

BigNeuroVec-class

BigNeuroVec Class

BigNeuroVec-methods

Create a Memory-Mapped Neuroimaging Vector

bilateral_filter

Apply a bilateral filter to a volumetric image

BinaryReader-class

BinaryReader Class

BinaryReader

Create Binary Reader Object

BinaryWriter-class

BinaryWriter Class

BinaryWriter

Create Binary Writer Object

bootstrap_searchlight

Create a bootstrap spherical searchlight iterator

bounds-methods

Extract Spatial Bounds of an Image

centroid-methods

return the centroid of an object

centroids-methods

Return a matrix of centroids of an object

close-methods

Close a BinaryReader or BinaryWriter

clustered_searchlight

Create a clustered searchlight iterator

ClusteredNeuroVol-class

ClusteredNeuroVol Class

ColumnReader-class

ColumnReader

ColumnReader

Create Column Reader Object

Compare-methods

Comparison Operations

concat-methods

Concatenate two objects in the time dimension

conn_comp_3D

Extract Connected Components from a 3D Binary Mask

conn_comp-methods

Connected components

coord_to_grid-methods

convert n-dimensional real world coordinates to grid coordinates

coord_to_index-methods

convert n-dimensional real world coordinates to 1D indices

coords-methods

Extract Coordinates from an IndexLookupVol Object

coords

Extract coordinates from an object

createNIfTIHeader

Create an Empty NIfTI-1 Header List

cuboid_roi

Create A Cuboid Region of Interest

data_file_matches-methods

Generic function to test whether a file name conforms to the given a `...

data_file-methods

Generic function to get the name of the data file, given a file name a...

data_reader-methods

Create Data Reader for AFNI Format

data_reader

Create a Data Reader

DenseNeuroVec-class

DenseNeuroVec Class

DenseNeuroVol-class

DenseNeuroVol Class

dim_of-methods

Get the length of a given dimension of an object

dim-methods

Get Dimensions of FileMetaInfo Object

drop_dim-methods

Drop a Dimension from an Object

drop-methods

Drop a dimension

drop

Generic Drop Method

embed_kernel-methods

Generic function to position kernel in a position in image space

extract-methods

Extract or replace parts of an object

extractor3d

Array-like access for 3-dimensional data structures

extractor4d

Array-like access for 4-dimensional data structures

file_matches-methods

Generic function to test whether a file name conforms to the given `Fi...

FileBackedNeuroVec-class

FileBackedNeuroVec Class

FileBackedNeuroVec

Create a File-Backed Neuroimaging Vector

FileFormat-class

FileFormat Class

FileFormat-operations

File Format Operations for Neuroimaging Data

FileMetaInfo-class

FileMetaInfo Class

FileSource-class

FileSource Class

findAnatomy3D

Find 3D anatomical orientation from axis abbreviations

gaussian_blur

Gaussian Blur for Volumetric Images

grid_to_coord-methods

Generic function to convert N-dimensional grid coordinates to real wor...

grid_to_grid-methods

Generic function to convert voxel coordinates in the reference space (...

grid_to_index-methods

Generic function to convert N-dimensional grid coordinates to 1D indic...

guided_filter

Edge-Preserving Guided Filter for Volumetric Images

header_file_matches-methods

Generic function to test whether a file name conforms to the given `Fi...

header_file-methods

Generic function to get the name of the header file, given a file name...

image

Generic Image Method for Creating Visual Representations

index_to_coord-methods

convert 1d indices to n-dimensional real world coordinates

index_to_grid-methods

Convert 1d indices to n-dimensional grid coordinates

IndexLookupVol-class

IndexLookupVol Class

indices-methods

Get Indices from an IndexLookupVol Object

indices

Extract indices

inverse_trans-methods

Extract inverse image coordinate transformation

Kernel-class

Kernel

Kernel

Create a Kernel object from a function of distance from kernel center

laplace_enhance

Laplacian Enhancement Filter for Volumetric Images

length-methods

Get length of NeuroVec object

linear_access-methods

Linear Access Method for FileBackedNeuroVec

linear_access

Extract values from an array-like object using linear indexing.

load_data-methods

Load image data from a NeuroVecSource object

load_data

Read data from a data source.

LogicalNeuroVol-class

LogicalNeuroVol Class

lookup-methods

Lookup Values in an IndexLookupVol Object

lookup

Index Lookup operation

map_values-methods

Map Values from One Set to Another Using a User-supplied Lookup Table

map-methods

Apply a function to an object.

MappedNeuroVec-class

MappedNeuroVec Class

MappedNeuroVecSource-class

MappedNeuroVecSource Class

matricized_access-methods

Extract values from a 4D tensor using a matrix of time-space indices.

matrixToQuatern

Convert a Transformation Matrix to a Quaternion Representation

MetaInfo-class

MetaInfo Class

MetaInfo

Create Neuroimaging Metadata Object

NamedAxis-class

NamedAxis

ndim-AxisSet-method

Get number of dimensions in axis set

ndim-methods

Extract the number of dimensions of an object

neuro-ops

Arithmetic and Comparison Operations for Neuroimaging Objects

neuro-resample

Resampling Methods for Neuroimaging Objects

NeuroBucket-class

NeuroBucket

NeuroHyperVec-class

NeuroHyperVec Class

NeuroHyperVec

Constructor for NeuroHyperVec class

neuroim2-package

neuroim2: neuroimaging data structures for analysis

NeuroObj-class

NeuroObj Class

NeuroSlice-class

NeuroSlice Class

NeuroSlice

NeuroSlice: 2D Neuroimaging Data Container

NeuroSpace-class

NeuroSpace Class

NeuroSpace

NeuroSpace: Spatial Reference System for Neuroimaging Data

NeuroVec-class

NeuroVec Class

NeuroVecSeq-class

NeuroVecSeq Class

NeuroVecSeq-methods

Extract Element from NeuroVecSeq

NeuroVecSeq

NeuroVecSeq: A Container for Sequential NeuroVec Objects

NeuroVecSource-class

NeuroVecSource Class

NeuroVecSource

NeuroVecSource

NeuroVol-class

NeuroVol Class

NeuroVol

NeuroVol: 3D Neuroimaging Volume Class

NeuroVolSource-class

Constructor for NeuroVolSource

NIFTIMetaInfo

Create NIFTI Format Metadata Object

None

Pre-defined null axis

NullAxis

Pre-defined null axis set

num_clusters-methods

Number of Clusters

numericOrMatrix-class

numericOrMatrix Union

OrientationList2D

Pre-defined 2D orientation configurations

OrientationList3D

Pre-defined 3D orientation configurations

origin-methods

Extract Image Origin

partition-methods

Partition an image into a set of disjoint clusters

patch_set-methods

Create a patch set from a NeuroVol object

patch_set

Generate a set of coordinate "patches" of fixed size from an image obj...

perm_mat-AxisSet2D-method

Get permutation matrix from axis set

perm_mat-AxisSet3D-method

Get permutation matrix from axis set

perm_mat-methods

Extract permutation matrix associated with an image

plot-methods

Plot a NeuroSlice

quaternToMatrix

Convert Quaternion Parameters to a Transformation Matrix

random_searchlight

Create a spherical random searchlight iterator

read_columns-methods

Read a set of column vector from an input source (e.g. ColumnReader)

read_elements-BinaryReader-numeric-method

Read Elements from Binary Reader

read_elements-methods

Read a sequence of elements from an input source

read_header

read header information of an image file

read_meta_info-methods

Generic function to read image meta info given a file

read_vec

read_vec

read_vol_list

read_vol_list

read_vol

Load an image volume from a file

reorient-methods

Remap the grid-to-world coordinates mapping of an image.

resample-methods

Resample an Image to Match the Space of Another Image

ROI-class

ROI

ROICoords-class

ROICoords

ROICoords

Create ROI Coordinates Object

ROIVec-class

ROIVec

ROIVec

Create an instance of class ROIVec

ROIVecWindow-class

ROIVecWindow

ROIVol-class

ROIVol

ROIVol

Create ROI Volume Object

ROIVolWindow-class

ROIVolWindow

scale_series-methods

Generic functions to scale (center and/or normalize by standard deviat...

scale

Generic Scale Method

searchlight_coords

Create an exhaustive searchlight iterator for voxel coordinates using ...

searchlight-methods

Searchlight Analysis Methods

searchlight

Create an exhaustive searchlight iterator

series_roi

Extract time series from specific voxel coordinates and return as ROI ...

series-methods

Extract one or more series from object

series-NeuroHyperVec-ANY-method

Series method for NeuroHyperVec

show-methods

Show method for NamedAxis objects

slice-methods

Extract image slice

slices-methods

Extract an ordered series of 2D slices from a 3D or 4D object

space-methods

Extract Geometric Properties of an Image

spacing-methods

Extract Voxel Dimensions of an Image

SparseNeuroVec-class

SparseNeuroVec Class

SparseNeuroVec-methods

[[

SparseNeuroVecSource-class

SparseNeuroVecSource Class

SparseNeuroVol-array

Convert SparseNeuroVol to array

SparseNeuroVol-class

SparseNeuroVol Class

SparseNeuroVol-numeric

Convert SparseNeuroVol to numeric

spatial-filter

Spatial Filtering Methods for Neuroimaging Data

spherical_roi_set

Create Multiple Spherical Regions of Interest

spherical_roi

Create a Spherical Region of Interest

split_blocks-methods

Cut a vector-valued object into a list of sub-blocks

split_clusters-methods

Cut an object into a list of spatial or spatiotemporal clusters

split_fill-methods

Fill Disjoint Sets of Values with the Output of a Function

split_reduce-methods

Summarize Subsets of an Object by Splitting by Row and Applying a Summ...

split_scale-methods

Center and/or Scale Row-subsets of a Matrix or Matrix-like Object

square_roi

Create a square region of interest

strip_extension-methods

Generic function to strip extension from file name, given a `FileForma...

sub_vector-methods

Generic function to extract a sub-vector from a NeuroVec object.

sub-AbstractSparseNeuroVec-numeric-numeric-ANY-method

Extractor Method for AbstractSparseNeuroVec

sub-sub-NeuroVec-numeric-method

[[

Summary-methods

Summary method for Neuroimaging objects

TIME

Time axis

TimeAxis

Time axis set

trans-methods

Extract image coordinate transformation

values-methods

Extract Data Values of an Object

vectors-methods

Extract an ordered list of 1D vectors.

vols-methods

Extract an ordered series of 3D volumes.

voxels-methods

extract voxel coordinates

which_dim-methods

Find Dimensions of a Given Axis

write_elements-methods

Write a sequence of elements from an input source

write_vec-methods

Write a 4d image vector to disk

write_vol-methods

Write a 3d image volume to disk

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>).

  • Maintainer: Bradley R Buchsbaum
  • License: MIT + file LICENSE
  • Last published: 2025-04-10