API

Top-level functions

read_alignment(path[, loader_name, ...])	Load registration data with composable pipeline.
load_custom_atlas(atlas_path, hemi_path, ...)	Loads a custom atlas from provided file paths.
seg_to_coords(folder, registration, atlas[, ...])	Transform segmentation images into atlas-space coordinates.
image_to_coords(folder, registration, atlas)	Transform image intensities into atlas-space point data.
xy_to_coords(coordinates, registration, atlas)	Transform image-space coordinates into atlas space.
quantify_coords(result, atlas_labels)	Summarize atlas-space extraction results by atlas region.
save_analysis(output_folder, result, ...[, ...])	Save analysis output to the specified directory.
interpolate_volume(*, segmentation_folder, ...)	Project section data into atlas-space volumes.
save_volume_niftis(*, output_folder, ...[, ...])

Result classes

AtlasData(volume, hemi_map, labels[, ...])	Bundle of atlas volume, hemisphere map, and region labels.
ExtractionResult(points, objects, ...[, ...])	User-facing extraction output with shared point-set structure.
PointSetResult(points, labels, hemi_labels, ...)	A reusable point-set payload shared across extraction workflows.