pyphi.visualize.render.hypergraph.render_hypergraph

pyphi.visualize.render.hypergraph.render_hypergraph(projection, theme, fig=None, geometry=None, show=('purviews', 'mechanisms', 'cause_effect_links', 'mechanism_purview_links', 'two_faces', 'three_faces', 'higher_faces'), only_distinctions=None, layout='barycentric', show_colorbars=True, degrees=None, star_min_degree=2)

Draw the cause-effect structure as a 3-D hypergraph.

Purview endpoints are vertices. By default (star_min_degree=2) every relation face is drawn as a star expansion (a hub at the face centroid with spokes to each endpoint), so no degree is given special visual weight. Raising star_min_degree restores geometric forms for the lower degrees: 3 draws degree-2 faces as line segments, 4 additionally draws degree-3 faces as filled triangles. All relation faces share one relation φ colorbar, and colour opacity tracks φ so low-φ relations fade rather than obscure the high-φ ones. Geometry is computed from the full projection regardless of only_distinctions, so successive calls with different subsets align; this is what lets highlight_phi_fold() overlay a highlighted subset on the dimmed full structure.

Parameters:

• projection (CESProjection)

• theme (Theme)

• fig (Figure | None)

• geometry (HypergraphGeometry | None)

• show (tuple[str, ...])

• only_distinctions (set[int] | None)

• layout (str)

• show_colorbars (bool)

• degrees (tuple[int, ...] | None)

• star_min_degree (int)

Return type:

Figure