pyphi.visualize.projection.CESProjection

class pyphi.visualize.projection.CESProjection(nodes, edges, mechanism_inclusion, purview_union_inclusion, node_labels, endpoints=(), faces=(), degree_spectrum=<factory>)

Bases: object

Everything a renderer needs to draw a cause-effect structure.

Two inclusion orders are carried: mechanism_inclusion orders distinctions by strict subset relation on their mechanisms (the region/location order of Haun & Tononi 2019, Fig 9), and purview_union_inclusion by strict subset relation on the unions of their cause and effect purviews.

endpoints carries one node per distinction side, interleaved so that endpoints[2 * d + 0] is distinction d’s cause and endpoints[2 * d + 1] its effect. faces carries the relation faces at every degree present, referencing endpoints by id; renderers choose how to draw each degree.

Parameters:

• nodes (tuple[DistinctionNode, ...])

• edges (tuple[RelationEdge, ...])

• mechanism_inclusion (InclusionOrder)

• purview_union_inclusion (InclusionOrder)

• node_labels (NodeLabels)

• endpoints (tuple[EndpointNode, ...])

• faces (tuple[RelationFaceEdge, ...])

• degree_spectrum (dict[int, tuple[int, float]])

inclusion(order)

The inclusion order named by order.

Parameters:

order (str) – "mechanism" or "purview_union".

Returns:

InclusionOrder

Raises:

ValueError – If order is neither "mechanism" nor "purview_union".

Return type:

InclusionOrder