finesse.tracing.forest.TraceForest.draw

TraceForest.draw(self)

Draws the forest, by trace priority, as a string representation.

The order in which trees appear in this string represents the order in which they will be traced during the beam tracing algorithm.

In the rare cases where a subsequent tree contains a duplicate node (from an earlier tree), the latter tree trace will overwrite the former. This is only applicable to configurations with overlapping cavities, and this overwriting behaviour will take account of the desired cavity ordering given by the user.

Returns

forest_strstr

A string representation of the ordered forest.