Concept ↔︎ API map
Every concept, the API symbols that realize it, and the recipe that uses it.
The Reference is generated from docstrings and grouped by concept. This page is the durable inverse: start from a concept, find the symbols and the runnable recipe. It is hand-authored (generated reference pages are regenerated on every build, so the cross-links that must survive live here).
| Concept | Key API symbols | Recipe | Spec |
|---|---|---|---|
| Typed images | read_image, NeuroVol, NeuroVec, NeuroHyperVec, DenseNeuroVol, DenseNeuroVec |
time series at a coordinate | — |
| NeuroSpace | NeuroSpace, neurospace, NeuroSpace.compatible_with, NeuroSpace.from_affine |
concat with contracts | space invariants |
| Receipt | Receipt, results.hash_neurospace, results.hash_ndarray |
save a derived map | Receipt NIfTI extension |
| Provenance | verify.assert_same_space, verify.assert_same_mask, verify.diff_receipts |
audit a derived map | Receipt NIfTI extension |
| VoxelSeriesStore | storage.VoxelSeriesStore, storage.NeuroVecStoreAdapter, DenseNeuroVec, SparseNeuroVec, MappedNeuroVec, FileBackedNeuroVec |
hand off to multiprocessing | VoxelSeriesStore protocol |
| ROI result | spherical_roi, cuboid_roi, series_roi, ROIExtractionResult, SearchlightResult, searchlight_apply |
time series at a coordinate | — |
| Contract failures | NeuroSpace.compatible_with, verify.assert_same_space, concat, series_at_world |
every recipe’s Trapdoors section | contract-failure vocabulary |
| Atlas | atlas.VolumetricAtlas, atlas.AtlasLabel, parcel_means, ClusteredNeuroVec |
parcel time series from an atlas | — |
The other direction
Reading a Reference page and want the why? Every section there carries a one-line link back to its concept, recipe, and spec — see the section descriptions on the reference index.
See also
- Concepts index — the vocabulary, one page per idea.
- Cookbook — task-driven recipes.
- Evidence — the runnable scoreboard.