one_step_habitat
Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.
- one_step_habitat(*, modalities: Sequence[str], n_habitats: int | str = 'auto', habitat_features: Sequence[str | Spec | Mapping[str, object]] | None = None, random_seed: int | None = None, clustering_algorithm: str = 'kmeans', roi: str = 'tumor') Study[source]
Declare a one-step habitat study (habitats defined inside each subject).
- Parameters:
modalities – Modality names for the raw voxel extractor.
n_habitats – Fixed habitat count or
"auto".habitat_features – Optional habitat feature families.
random_seed – Seed for every seedable component.
clustering_algorithm – Registered per-subject fitter name.
roi – ROI keyword for voxel extraction.
- Returns:
A
Studyready forStudy.fit().
