Man pages for bbuchsbaum/neuroim2
Data Structures and IO for Neuroimaging Data with an Emphasis on Functional Magnetic Resonance Imaging (FMRI)

AbstractSparseNeuroVec-classAbstractSparseNeuroVec Class
add_dim-methodsAdd a Dimension to an Object
AFNIMetaInfoCreate AFNI Format Metadata Object
anatomical_axesPre-defined anatomical axes
Arith-methodsPerform arithmetic operations between two SparseNeuroVol...
Arith-NeuroVec-NeuroVol-methodArithmetic Operations for NeuroVec and NeuroVol
Arith-NeuroVol-NeuroVec-methodArithmetic Operations for NeuroVol and NeuroVec
Arith-ROIVol-ROIVol-methodThis function performs arithmetic operations on two ROIVol...
asconversion from 'NeuroVol' to 'LogicalNeuroVol'
as.denseConvert to dense representation
as.dense-methodsCoerce ROIVol to DenseNeuroVol using as.dense method
as-DenseNeuroVol-arrayConvert DenseNeuroVol to array
as.list-methodsConvert FileBackedNeuroVec to List
as.logical-methodsas.logical
as.maskConvert to a LogicalNeuroVol
as.mask-methodsConvert NeuroVol to a mask
as.matrix-methodsconvert a 'NeuroVec' to a matrix
as.numeric-methodsConvert SparseNeuroVol to numeric
as.sparseConvert to from dense to sparse representation
as.sparse-methodsConvert DenseNeuroVec to sparse representation using mask
axes-methodsExtract Image Axes
AxisSet1DCreate a one-dimensional axis set
AxisSet1D-classAxisSet1D
AxisSet2DCreate a two-dimensional axis set
AxisSet2D-classAxisSet2D
AxisSet3DCreate a three-dimensional axis set
AxisSet3D-classAxisSet3D Class
AxisSet4D-classAxisSet4D Class
AxisSet5D-classAxisSet5D Class
AxisSet-classAxisSet
BigNeuroVec-classBigNeuroVec Class
bilateral_filterApply a bilateral filter to a volumetric image
BinaryReaderCreate Binary Reader Object
BinaryReader-classBinaryReader Class
BinaryWriterCreate Binary Writer Object
BinaryWriter-classBinaryWriter Class
bootstrap_searchlightCreate a bootstrap spherical searchlight iterator
bounds-methodsExtract Spatial Bounds of an Image
centroid-methodsreturn the centroid of an object
centroids-methodsReturn a matrix of centroids of an object
close-methodsClose a BinaryReader or BinaryWriter
ClusteredNeuroVol-classClusteredNeuroVol Class
clustered_searchlightCreate a clustered searchlight iterator
ColumnReaderCreate Column Reader Object
ColumnReader-classColumnReader
Compare-methodsCompare a SparseNeuroVol object with a numeric value
concat-methodsConcatenate two objects in the time dimension
conn_comp_3DExtract Connected Components from a 3D Binary Mask
conn_comp-methodsConnected components
coordsExtract coordinates from an object
coords-methodsExtract Coordinates from an IndexLookupVol Object
coord_to_grid-methodsconvert n-dimensional real world coordinates to grid...
coord_to_index-methodsconvert n-dimensional real world coordinates to 1D indices
cuboid_roiCreate A Cuboid Region of Interest
data_file_matches-methodsGeneric function to test whether a file name conforms to the...
data_file-methodsGeneric function to get the name of the data file, given a...
data_readerCreate a Data Reader
DenseNeuroVec-classDenseNeuroVec Class
DenseNeuroVol-classDenseNeuroVol Class
dim-FileMetaInfo-methodGet Dimensions of FileMetaInfo Object
dim-methodsdim of 'NeuroObj' object
dim-NeuroSpace-methoddim
dim_of-methodsGet the length of a given dimension of an object
dot-getAxisGet anatomical axis from direction vector
dot-read_mmapRead Data Using Memory Mapping
drop_dim-AxisSet2D-missing-methodDrop dimension from axis set
drop_dim-AxisSet2D-numeric-methodDrop dimension from axis set
drop_dim-AxisSet3D-missing-methodDrop dimension from axis set
drop_dim-AxisSet3D-numeric-methodDrop dimension from axis set
drop_dim-methodsDrop a Dimension from an Object
drop-NeuroVec-methoddrop
embed_kernel-methodsGeneric function to position kernel in a postion in image...
extractor3dArray-like access for 3-dimensional data structures
extractor4dArray-like access for 4-dimensional data structures
FileBackedNeuroVecCreate a File-Backed Neuroimaging Vector
FileBackedNeuroVec-classFileBackedNeuroVec Class
FileFormat-classFileFormat Class
FileFormat-operationsFile Format Operations for Neuroimaging Data
file_matches-methodsGeneric function to test whether a file name conforms to the...
FileMetaInfo-classFileMetaInfo Class
FileSource-classFileSource Class
findAnatomy3DFind 3D anatomical orientation from axis abbreviations
gaussian_blurGaussian Blur for Volumetric Images
grid_to_coord-methodsGeneric function to convert N-dimensional grid coordinate...
grid_to_grid-methodsGeneric function to convert voxel coordinates in the...
grid_to_index-methodsGeneric function to convert N-dimensional grid coordinate to...
guided_filterEdge-Preserving Guided Filter for Volumetric Images
header_file_matches-methodsGeneric function to test whether a file name conforms to the...
header_file-methodsGeneric function to get the name of the header file, given a...
IndexLookupVol-classIndexLookupVol Class
index_to_coord-methodsconvert 1d indices to n-dimensional real world coordinates
index_to_grid-methodsConvert 1d indices to n-dimensional grid coordinates
indicesExtract indices
indices-methodsGet Indices from an IndexLookupVol Object
initialize-IndexLookupVol-methodInitialize an IndexLookupVol Object
inverse_trans-methodsExtract inverse image coordinate transformation
KernelCreate a Kernel object from a function of distance from...
Kernel-classKernel
laplace_enhanceLaplacian Enhancement Filter for Volumetric Images
length-NeuroVec-methodGet the length of a NeuroVec object
linear_accessExtract values from an array-like object using linear...
linear_access-FileBackedNeuroVec-numeric-methodLinear Access Method for FileBackedNeuroVec
linear_access-methodsLinear Access to NeuroVecSeq Data
linear_access-NeuroHyperVec-ANY-methodLinear access method for NeuroHyperVec
load_dataLoad data from a data source.
LogicalNeuroVol-classLogicalNeuroVol Class
lookupIndex Lookup operation
lookup-methodsLookup Values in an IndexLookupVol Object
map-methodsApply a function to an object.
MappedNeuroVec-classMappedNeuroVec Class
MappedNeuroVecSource-classMappedNeuroVecSource Class
map_values-methodsMap Values from One Set to Another Using a User-supplied...
matchAnatomy2DFind matching 2D anatomical orientation
matchAnatomy3DFind matching 3D anatomical orientation
matchAxisMatch anatomical axis abbreviation to full axis object
matricized_access-methodsExtract values from a matricized (x,y,z) of a 4D tensor using...
MetaInfoCreate Neuroimaging Metadata Object
MetaInfo-classMetaInfo Class
NamedAxis-classNamedAxis
ndim-AxisSet-methodGet number of dimensions in axis set
ndim-methodsExtract the number of dimensions of an object
NeuroBucket-classNeuroBucket
NeuroHyperVecConstructor for NeuroHyperVec class
NeuroHyperVec-classNeuroHyperVec Class
neuroim2-packageneuroim2: neuroimaging data structures for analysis
NeuroObj-classNeuroObj Class
NeuroSliceNeuroSlice: 2D Neuroimaging Data Container
NeuroSlice-classNeuroSlice Class
NeuroSpaceNeuroSpace: Spatial Reference System for Neuroimaging Data
NeuroSpace-classNeuroSpace Class
NeuroVec-classNeuroVec Class
NeuroVecSeqNeuroVecSeq: A Container for Sequential NeuroVec Objects
NeuroVecSeq-classNeuroVecSeq Class
NeuroVecSeq-methodsExtract Element from NeuroVecSeq
NeuroVecSourceNeuroVecSource
NeuroVolConstruct a NeuroVol object
NeuroVol-classNeuroVol Class
NeuroVolSource-classConstructor for NeuroVolSource
niftiDimExtract NIFTI Dimensions
NIFTIMetaInfoCreate NIFTI Format Metadata Object
NonePre-defined null axis
NullAxisPre-defined null axis set
num_clustersNumber of Clusters
num_clusters-methodsNumber of Clusters
OrientationList2DPre-defined 2D orientation configurations
OrientationList3DPre-defined 3D orientation configurations
origin-methodsExtract Image Origin
partition-methodsPartition an image into a set of disjoint clusters
patch_setGenerate a set of coordinate "patches" of fixed size from an...
patch_set-methodsCreate a patch set from a NeuroVol object
perm_mat-AxisSet2D-methodGet permutation matrix from axis set
perm_mat-AxisSet3D-methodGet permutation matrix from axis set
perm_mat-methodsExtract permutation matrix associated with an image
perm_mat-NeuroSpace-methodGet permutation matrix from axis set
plot-methodsVisualize 2D Neuroimaging Slice
print_-AxisSet2D-methodPrint method for AxisSet2D objects
print_-AxisSet3D-methodPrint method for AxisSet3D objects
print_-NamedAxis-methodPrint method for NamedAxis objects
random_searchlightCreate a spherical random searchlight iterator
read_columns-methodsRead a set of column vector from an input source (e.g....
read_elements-BinaryReader-numeric-methodRead Elements from Binary Reader
read_elements-methodsRead a sequence of elements from an input source
read_headerread header information of an image file
read_mapped_dataRead Mapped Data from 4D Image
read_mapped_seriesRead Mapped Series from 4D Image
read_mapped_volsRead Mapped Volumes from 4D Image
read_meta_info-methodsGeneric function to read image meta info given a file and a...
read_vecread_vec
read_volLoad an image volume from a file
read_vol_listread_vol_list
render-methodsRender an image to create a drawable image.
render_slice-methodsRender a slice at z coordinate
reorient-methodsRemap the grid-to-world coordinates mapping of an image.
resample-methodsResample an Image to Match the Space of Another Image
resample-NeuroVol-NeuroSpace-methodResample a NeuroVol object to match a NeuroSpace object
resample-NeuroVol-NeuroVol-methodResample a NeuroVol object
ROI-classROI
ROICoords-classROICoords
ROIVecCreate an instance of class 'ROIVec'
ROIVec-classROIVec
ROIVecWindow-classROIVecWindow
ROIVolCreate an instance of class 'ROIVol'
ROIVol-classROIVol
ROIVolWindow-classROIVolWindow
scale_series-methodsGeneric functions to scale (center and/or normalize by...
searchlightCreate an exhaustive searchlight iterator
searchlight_coordsCreate an exhaustive searchlight iterator for voxel...
series-methodsExtract one or more series from object and return as ROI...
series-NeuroHyperVec-ANY-methodSeries method for NeuroHyperVec
series_readerCreate Series Reader for 4D Image
show-AxisSet1D-methodShow method for AxisSet1D objects
show-AxisSet2D-methodShow method for AxisSet2D objects
show-AxisSet3D-methodShow method for AxisSet3D objects
show-AxisSet4D-methodShow method for AxisSet4D objects
show-ClusteredNeuroVol-methodDisplay ClusteredNeuroVol Information
show-FileMetaInfo-methodshow a 'FileMetaInfo'
show-MappedNeuroVec-methodShow Method for MappedNeuroVec Objects
show-NamedAxis-methodShow method for NamedAxis objects
show-NeuroHyperVec-methodShow NeuroHyperVec Object
show-NeuroSlice-methodPrint NeuroSlice Object Details
show-NeuroSpace-methodDisplay NeuroSpace Object Details
show-NeuroVec-methodshow a NeuroVec object
show-NeuroVecSource-methodshow a NeuroVecSource object
show-NeuroVol-methodshow a 'NeuroVol'
show-ROIVec-methodshow an 'ROIVec'
show-ROIVol-methodshow an 'ROIVol'
show-SparseNeuroVec-methodshow a 'SparseNeuroVec'
show-SparseNeuroVol-methodshow a 'SparseNeuroVol'
slice-methodsExtract image slice
slices-methodsExtract an ordered series of 2D slices from a 3D or 4D object
space-methodsExtract Geometric Properties of an Image
spacing-methodsExtract Voxel Dimensions of an Image
SparseNeuroVec-classSparseNeuroVec Class
SparseNeuroVec-methods[[
SparseNeuroVecSource-classSparseNeuroVecSource Class
SparseNeuroVol-arrayConvert SparseNeuroVol to array
SparseNeuroVol-classSparseNeuroVol Class
SparseNeuroVol-numericConvert SparseNeuroVol to numeric
spherical_roiCreate a Spherical Region of Interest
spherical_roi_setCreate Multiple Spherical Regions of Interest
split_blocks-methodsCut a vector-valued object into a list of sub-blocks
split_clusters-methodsCut an object into a list of spatial or spatiotemporal...
split_fill-methodsFill Disjoint Sets of Values with the Output of a Function
split_reduce-methodsSummarize Subsets of an Object by Splitting by Row and...
split_scale-methodsCenter and/or Scale Row-subsets of a Matrix or Matrix-like...
square_roiCreate a square region of interest
strip_extension-methodsGeneric function to strip extension from file name, given a...
sub-AbstractSparseNeuroVec-numeric-numeric-ANY-methodExtractor Method for AbstractSparseNeuroVec
sub-NeuroHyperVec-ANY-ANY-ANY-method[ method for NeuroHyperVec
sub-sub-NeuroVec-numeric-method[[
sub_vector-methodsGeneric function to extract a sub-vector from a 'NeuroVec'...
Summary-DenseNeuroVol-methodSummary of DenseNeuroVol
Summary-SparseNeuroVec-methodSummary of SparseNeuroVec
Summary-SparseNeuroVol-methodSummary of SparseNeuroVol
TIMETime axis
TimeAxisTime axis set
trans-methodsExtract image coordinate transformation
values-methodsExtract Data Values of an Object
vectors-methodsExtract an ordered list of 1D vectors.
vols-methodsExtract an ordered series of 3D volumes.
vol_subset-methodssubset an 'ROIVol'
voxels-methodsextract voxel coordinates
which_dim-methodsFind Dimensions of a Given Axis
write_elements-BinaryWriter-numeric-methodWrite Elements to Binary Writer
write_elements-methodsWrite a sequence of elements from an input source
write_vec-methodsWrite a 4d image vector to disk
write_vol-methodsWrite a 3d image volume to disk
bbuchsbaum/neuroim2 documentation built on Jan. 2, 2025, 3:38 p.m.