circle_bundles.BundleQualityReport

class circle_bundles.BundleQualityReport(delta, cocycle_defect, max_edge_rms, mean_edge_rms, rms_angle_err=None, eps_align_geo=None, eps_align_euc=None, eps_align_geo_mean=None, eps_align_euc_mean=None, alpha=None, n_edges_estimated=0, n_edges_requested=0, n_triangles=0, witness_err=None, witness_err_geo=None, witness_err_mean=None, witness_err_geo_mean=None, cocycle_proj_dist=None)

Bases: object

Summary of diagnostic and quality metrics for a reconstructed bundle.

This object is intended for inspection and reporting, not as an input to downstream algorithms. It aggregates several geometric, cohomological, and numerical indicators that help assess how well the data supports a coherent circle- (or O(2)-) bundle structure.

Notes

• Users typically obtain this object via a bundle method (e.g. get_quality()), rather than constructing it directly.

• Individual fields may be None if the corresponding diagnostic was not computed or not applicable to the current bundle model.

Fields

delta:

Global transition inconsistency measure (smaller is better).

cocycle_defect:

Deviation of the recovered cocycle from being exactly closed.

max_edge_rms, mean_edge_rms:

Maximum and mean RMS angular transition error over edges.

rms_angle_err:

Per-edge RMS angular transition error map. Keys are canonicalized edges (i,j) with i<j and values are nonnegative floats. This is useful for weighting edges in visualizations/filtrations when a full TransitionReport is not retained.

eps_align_geo, eps_align_euc:

Worst-case alignment error (geodesic / Euclidean) for local trivializations.

eps_align_geo_mean, eps_align_euc_mean:

Mean alignment error (geodesic / Euclidean).

alpha:

Global scaling or regularization parameter used in alignment (if applicable).

n_edges_estimated:

Number of edges actually used for estimation.

n_edges_requested:

Number of edges originally requested.

n_triangles:

Number of triangles used in consistency checks.

witness_err, witness_err_geo:

Supremum witness error (chordal / geodesic).

witness_err_mean, witness_err_geo_mean:

Mean witness error (chordal / geodesic).

cocycle_proj_dist:

Distance from the cocycle to the nearest projected cocycle representative.

__init__(delta, cocycle_defect, max_edge_rms, mean_edge_rms, rms_angle_err=None, eps_align_geo=None, eps_align_euc=None, eps_align_geo_mean=None, eps_align_euc_mean=None, alpha=None, n_edges_estimated=0, n_edges_requested=0, n_triangles=0, witness_err=None, witness_err_geo=None, witness_err_mean=None, witness_err_geo_mean=None, cocycle_proj_dist=None)

Parameters:

• delta (float)

• cocycle_defect (float)

• max_edge_rms (float)

• mean_edge_rms (float)

• rms_angle_err (Dict[Tuple[int, int], float] | None)

• eps_align_geo (float | None)

• eps_align_euc (float | None)

• eps_align_geo_mean (float | None)

• eps_align_euc_mean (float | None)

• alpha (float | None)

• n_edges_estimated (int)

• n_edges_requested (int)

• n_triangles (int)

• witness_err (float | None)

• witness_err_geo (float | None)

• witness_err_mean (float | None)

• witness_err_geo_mean (float | None)

• cocycle_proj_dist (float | None)

Return type:

None

Methods

__init__(delta, cocycle_defect, ...[, ...])

Attributes

alpha
cocycle_proj_dist
eps_align_euc
eps_align_euc_mean
eps_align_geo
eps_align_geo_mean
n_edges_estimated
n_edges_requested
n_triangles
rms_angle_err
witness_err
witness_err_geo
witness_err_geo_mean
witness_err_mean
delta
cocycle_defect
max_edge_rms
mean_edge_rms

Parameters:

• delta (float)

• cocycle_defect (float)

• max_edge_rms (float)

• mean_edge_rms (float)

• rms_angle_err (Dict[Tuple[int, int], float] | None)

• eps_align_geo (float | None)

• eps_align_euc (float | None)

• eps_align_geo_mean (float | None)

• eps_align_euc_mean (float | None)

• alpha (float | None)

• n_edges_estimated (int)

• n_edges_requested (int)

• n_triangles (int)

• witness_err (float | None)

• witness_err_geo (float | None)

• witness_err_mean (float | None)

• witness_err_geo_mean (float | None)

• cocycle_proj_dist (float | None)