pyphi.labels.NodeLabels#

class pyphi.labels.NodeLabels(labels, node_indices)[source]#

Text labels for nodes in a substrate.

Labels can either be instantiated as a tuple of strings:

>>> NodeLabels(('A', 'IN'), (0, 1))
NodeLabels(('A', 'IN'))

Or, if all labels are a single character, as a string:

>>> NodeLabels('AB', (0, 1))
NodeLabels(('A', 'B'))

Parameters:

labels2indices(labels)[source]#

Convert a tuple of node labels to node indices.

indices2labels(indices)[source]#

Convert a tuple of node indices to node labels.

coerce_to_indices(nodes)[source]#

Return the node indices for nodes, which may be given either as integer indices or as node labels.

coerce_to_labels(nodes)[source]#

Return the node labels for nodes, which may be given either as labels or as integer indices.

label_string(nodes, state, sep=None)[source]#

Return a single string labeling the nodes.

Parameters:

Return type:

str

set_case_by_state(labels, states)[source]#

Return a list of labels with case set by the corresponding state.

Parameters:

Return type:

list[str]