MSI

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 MSI(at: str = 'habitat_map')

Bases: object

Spatial-interaction (MSI) heatmap for the subject’s habitat map.

stem(subject_id: str) → str

Return the PNG stem <subject>_msi_matrix.

draw(ctx: SubjectContext) → 'Figure' | None

Draw the MSI matrix, or None when the map has no habitats.

__init__(at: str = 'habitat_map') → None