pyphi.models.complex.ExcludedCandidate#

class pyphi.models.complex.ExcludedCandidate(node_indices, phi, units=None, ii_ceiling=None, gated=False)[source]#

Bases: Displayable, ToPandasMixin

A candidate system that overlaps a complex and is not itself a complex: it was beaten (or Φ-outranked) by an overlapping accepted complex, or belonged to a Φ-tied clique that failed exclusion.

An excluded candidate may carry higher φₛ than a complex whose record it appears in, when it was carved away by a different overlapping complex. Holds plain values only, never a back-reference to the excluding Complex, so the heavy analysis graph is not retained.

Variables:

  • node_indices (tuple[int, ...]) – The excluded candidate’s micro units.

  • phi (float or None) – The candidate’s φₛ value, or None for a gated candidate — one whose partition sweep was skipped because its intrinsic-information ceiling is certifiably below the excluding complex’s φₛ.

  • units (tuple or None) – The candidate’s macro unit structure; None for a candidate system of micro units.

  • ii_ceiling (float or None) – The certified upper bound on φₛ, when the certified prune computed one.

  • gated (bool) – Whether the candidate was gated; phi is None exactly when this is True.

Parameters:

  • node_indices (Any)

  • phi (Any)

  • units (Any)

  • ii_ceiling (Any)

  • gated (bool)