plot_habitat_feature_heatmap

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.

plot_habitat_feature_heatmap(data: 'HabitatFeaturePanel' | 'HabitatFeatureComparison', *, subject_id: str | None = None, features: Sequence[str] | None = None, max_features: int = 40, zscore: bool = True, pair: Tuple[int, int] | None = None, title: str | None = None) → Figure[source]

Habitat x feature heatmap (cohort mean or one subject).

For tens-to-hundreds of texture features this is the overview figure: each column is z-scored across habitats so a family of GLCM features does not drown first-order ones. Pass features or rely on max_features (effect-size rank when a comparison is supplied).

Parameters:

  • data – Long panel or a HabitatFeatureComparison.

  • subject_id – If set, that subject’s profile. If omitted, the cohort mean per habitat x feature.

  • features – Optional explicit feature list.

  • max_features – Cap when features is omitted.

  • zscore – Z-score each feature across habitats (default True).

  • pair – Optional pair used only when ranking by effect size.

  • title – Optional figure title.

Returns:

The matplotlib Figure.