GraphSlice

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

Bases: object

Representative-slice habitat map with the node lattice overlaid.

Pass the same HabitatGraphFeatureOptions used by Spec("graph", ...) so nodes and edges match the feature table. The PNG is a representative 2D slice (display-only); Spec("graph") metrics are computed on the full 3D volume.

options

Graph construction shared with the quantify stage. Library default is min_distance / block_size=8.

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

draw(ctx: SubjectContext) → 'Figure' | None[source]

Draw the slice lattice, or None when the map has no habitats.

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