circle_bundles.NerveSummary

class circle_bundles.NerveSummary(n_sets, n_samples, n0, n1, n2, n3, vert_card=None, edge_card=None, tri_card=None, tet_card=None, sample_overlap_counts=None, max_overlap_order=None, n_samples_with_overlap_ge_5=None, warnings=())[source]

Bases: object

Pretty summary of a cover nerve (recorded or computed from U) up to dimension 3, plus overlap evidence from U.

Optionally includes intersection cardinalities (#samples in ⋂ U_i over each simplex), enabling the same box-and-whisker diagnostic plots you had before.

Parameters:
__init__(n_sets, n_samples, n0, n1, n2, n3, vert_card=None, edge_card=None, tri_card=None, tet_card=None, sample_overlap_counts=None, max_overlap_order=None, n_samples_with_overlap_ge_5=None, warnings=())
Parameters:
Return type:

None

Methods

__init__(n_sets, n_samples, n0, n1, n2, n3)

plot_boxplot(*[, show_tets, dpi, figsize, ...])

show_summary(*[, show, mode, plot, ...])

Display the summary.

to_markdown()

to_text()

Attributes

edge_card

max_overlap_order

n_samples_with_overlap_ge_5

sample_overlap_counts

tet_card

tri_card

vert_card

warnings

n_sets

n_samples

n0

n1

n2

n3

show_summary(*, show=True, mode='auto', plot='auto', show_tets_plot=True, dpi=200, figsize=None, save_path=None)[source]

Display the summary.

  • mode controls text/markdown display (“auto”, “latex”, “text”, “both”).

  • plot controls whether to display the box/whisker diagnostic plot:

    • “auto” (default): plot if cardinalities are present

    • True: always try to plot (requires cardinalities)

    • False: never plot

Parameters:
Return type:

str