GraphNetwork2D

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 GraphNetwork2D(options: ~habit.kernels.habitat_graph.features.HabitatGraphFeatureOptions = <factory>, at: str = 'habitat_map')[source]

Bases: object

Intra- and inter-habitat 2D network on the representative slice.

Same options object as GraphSlice / Spec("graph"). 2D only (display-only slice graph). 3D surface / network renders stay on habit.viz, not this atom.

options

Graph construction shared with the quantify stage.

Type:: habit.kernels.habitat_graph.features.HabitatGraphFeatureOptions

at

Pipeline boundary this atom reads. Fixed at habitat_map.

Type:: str

stem(subject_id: str) → str[source]: Return the PNG stem <subject>_graph_network_2d.

draw(ctx: SubjectContext) → 'Figure' | None[source]: Draw the 2D network, or None when the map has no habitats.

__init__(options: ~habit.kernels.habitat_graph.features.HabitatGraphFeatureOptions = <factory>, at: str = 'habitat_map') → None