SurveyTangles

class tangles.convenience.SurveyTangles(survey: Survey)

Manages a tangle search on survey data.

Attributes

surveySurvey

A survey object.

sweepTangleSweepFeatureSys or UncrossingSweep

An object containing a sweep object and a feature system (or separation system).

agreementint

The currently valid agreement lower bound.

similarity_matrixnp.ndarray or scipy.sparse.spmatrix

A similarity matrix.

orderlist, np.ndarray or SetSeparationOrderFunction

An object indicating in which order the features are used for the tangle search. A SetSeparationOrderFunction is a Callable[[np.ndarray], np.ndarray].

progress_callbackDefaultProgressCallback or callable

A callable providing a progress indication (see DefaultProgressCallback for reference).

Properties

feature_system	The feature system (or separation system) in use
valid_agreement_lower_bound	Current agreement lower bound

Methods

change_agreement()	Change the agreement lower bound
explain_feature()	Create a dataframe containing information about a feature specification
initialize_search()	This function starts a tangle search on survey data
load()	Load a SurveyTangles from files
ordered_metadata()	Return the metadata of the features (or separations) sorted corresponding to the order used for the tangle search
search()	Search tangles
specified_features()	Determine which features could be specified by the tangles found for the current agreement
tangle_matrix()	Create a matrix indicating how the features (or separations) are specified (or oriented) by the tangles
typical_answers()	Create a dataframe containing the ‘typical’ answers given by each tangle