direct_pooling_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.

direct_pooling_habitat(*, modalities: Sequence[str], n_habitats: int | str = 'auto', habitat_features: Sequence[str | Spec | Mapping[str, object]] | None = None, random_seed: int | None = None, habitat_fitter_algorithm: str = 'kmeans', roi: str = 'tumor') → Study[source]

Declare a direct-pooling habitat study (voxels pooled across the cohort).

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.

  • habitat_fitter_algorithm – Registered cohort fitter name.

  • roi – ROI keyword for voxel extraction.

Returns:

A Study ready for Study.fit().

Examples using habit.recipes.direct_pooling_habitat

/auto_examples/04_habitat_maps/plot_03_pool_voxels

Pooling voxels across the cohort