models.cuts
¶

class
pyphi.models.cuts.
Cut
¶ Represents a unidirectional cut.

severed
¶ tuple[int] – Connections from this group of nodes to those in
intact
are severed.

intact
¶ tuple[int] – Connections to this group of nodes from those in
severed
are severed.
Create new instance of Cut(severed, intact)

indices
¶ Returns the indices of this cut.

splits_mechanism
(mechanism)¶ Check if this cut splits a mechanism.
Parameters: mechanism (tuple[int]) – The mechanism in question Returns: bool – True
if mechanism has elements on both sides of the cut, otherwiseFalse
.

cuts_connections
(a, b)¶ Check if this cut severs any connections from nodes a to b.

all_cut_mechanisms
()¶ Return all mechanisms with elements on both sides of this cut.
Returns: tuple[tuple[int]]

apply_cut
(cm)¶ Return a modified connectivity matrix where the connections from one set of nodes to the other are destroyed.

cut_matrix
()¶ Compute the cut matrix for this cut.
The cut matrix is a square matrix which represents connections severed by the cut. The matrix is shrunk to the size of the cut subsystem–not necessarily the size of the entire network.
Example
>>> cut = Cut((1,), (2,)) >>> cut.cut_matrix() array([[ 0., 1.], [ 0., 0.]])

to_json
()¶


class
pyphi.models.cuts.
ActualCut
¶ Represents an actual cut for a context.

cause_part1
¶ tuple(int) – Connections from this group to those in
effect_part2
are cut

cause_part2
¶ tuple(int) – Connections from this group to those in
effect_part1
are cut

effect_part1
¶ tuple(int) – Connections to this group from
cause_part2
are cut

effect_part2
¶ tuple(int) – Connections to this group from
cause_part1
are cut
Create new instance of ActualCut(cause_part1, cause_part2, effect_part1, effect_part2)

indices
¶ tuple[int] – The indices in this cut.

apply_cut
(cm)¶ Cut a connectivity matrix.
Parameters: cm (np.ndarray) – A connectivity matrix Returns: np.ndarray –  A copy of the connectivity matrix with connections cut
 across the cause and effect indices.

cut_matrix
()¶


class
pyphi.models.cuts.
Part
¶ Represents one part of a bipartition.

mechanism
¶ tuple[int] – The nodes in the mechanism for this part.

purview
¶ tuple[int] – The nodes in the mechanism for this part.
Example
When calculating \(\varphi\) of a 3node subsystem, we partition the system in the following way:
mechanism: A C B  X  purview: B A C
This class represents one term in the above product.
Create new instance of Part(mechanism, purview)

to_json
()¶
