finesse.tracing.tree.TraceTree.from_cavity

TraceTree.from_cavity(type cls, cavity)

Construct a TraceTree from a cavity instance.

The resulting tree decays to a linked list as it just includes the internal path of the cavity.

Parameters:
cavityCavity

The cavity object.

Returns:
treeTraceTree

The tree representing the internal cavity path.