API reference
Spaces & frames
The spatial contract every image carries. Concept: NeuroSpace · Spec: space invariants.
| NeuroSpace | Spatial contract mapping image grid coordinates to world coordinates. |
| neurospace | Construct a :class:NeuroSpace from spacing/origin/axes or a 4x4 affine. |
Volumes
3-D containers. Concept: NeuroSpace · Recipe: save a derived map.
| DenseNeuroVol | Dense 3D neuroimaging volume. |
| SparseNeuroVol | Sparse 3D neuroimaging volume. |
| LogicalNeuroVol | Logical/binary 3D neuroimaging volume. |
| neurovol | Create a NeuroVol object. |
Vectors
4-D voxel-series containers. Concept: VoxelSeriesStore · Spec: protocol.
| DenseNeuroVec | Dense 4D neuroimaging vector. |
| SparseNeuroVec | Sparse 4D neuroimaging vector. |
| neurovec | Factory function to create appropriate NeuroVec type. |
Hypervectors
5-D+ feature stacks. Concept: VoxelSeriesStore.
| DenseNeuroHyperVec | Dense 5D+ neuroimaging hypervector. |
| SparseNeuroHyperVec | Sparse 5D+ neuroimaging hypervector. |
ROI & extraction
Region selection and typed extraction. Concept: ROI result · Recipe: time series at a coordinate.
| spherical_roi | Construct a spherical ROI from a brain volume. |
| cuboid_roi | Construct a cuboid (3D box) ROI from a brain volume. |
Searchlight & derived maps
Neighbourhood analysis and reductions. Concept: Provenance · Recipe: audit a derived map.
| searchlight.searchlight_iterator | Create an exhaustive searchlight iterator. |
| conn_comp | Find connected components in an image. |
Spatial filters
Smoothing and resampling. Concept: Contract failures.
| gaussian_blur | Apply a Gaussian blur to a volumetric image. |
| bilateral_filter | Apply bilateral filter to a volumetric image. |
| resample | Resampling and reorientation functions for neuroimaging data. |
| reorient | Remap the grid-to-world coordinates mapping of an image. |
I/O & interop
Read/write and the explicit nibabel boundary. Recipe: interop with nibabel · Spec: Receipt extension.
| read_vol | Read a 3D neuroimaging volume from file. |
| write_vol | Write a neuroimaging volume to file. |
| read_vec | Read a 4D neuroimaging vector from file. |
| write_vec | Write a neuroimaging vector to file. |
Visualization
Plotting helpers for volumes and overlays.
| plot_neuro_vol | Plot a NeuroVol as a series of 2D slices. |
| plot_ortho | Orthogonal 3-plane view (axial, sagittal, coronal). |
| plot_montage | Show multiple evenly-spaced slices along axis in a grid. |
| plot_overlay | Orthogonal view with a statistical overlay. |