VoxelFeatureTree

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

class VoxelFeatureTree(spec: Spec)[source]

Bases: _FeatureTreeBase

Evaluate a voxel-level feature tree into one VoxelFeatureField.

Children are evaluated recursively; their fields must describe the same voxel population (identical voxel_index), which is what makes row-aligned block combination meaningful. The merged block is wrapped back into a field carrying the shared geometry and a provenance edge.

__init__(spec: Spec) → None[source]

__call__(subject: Subject) → VoxelFeatureField[source]

Compute the composed voxel feature field for one subject.

Parameters:: subject – Subject providing images and the ROI mask.
Returns:: One row per ROI voxel; columns as produced by the combiner.
Raises:: HABITAPIError – If two children describe different voxel populations.