4.3.1. BasinSaddleFinder

class pyprom.lib.logic.basin_saddle_finder.BasinSaddleFinder(saddles)

Class for identifying all basin saddles. A Basin Saddle is the lowest member of a cycle.

__init__(saddles)

Parameters

saddles (pyprom.lib.containers.saddles.SaddlesContainer) – SaddlesContainer containing saddles to be analyzed

Raises

TypeError if not a pyprom.lib.containers.saddles.SaddlesContainer

__weakref__

list of weak references to the object (if defined)

_disqualify_and_label(lowest)

Consumes a list of features of the same height, disqualifies one, and sets basinSaddleAlternatives for equal height features.

Parameters

lowest (list(pyprom.lib.locations.spot_elevation.SpotElevation)) – list of “lowest” features.

_disqualify_single_source_saddles(saddle)

|Disqualifies Linkers and Saddles for Single Summit Saddles. | v-----v |Summit 1000    995 Saddle  <-Disqualify | ^-----^ | | and | | Summit 1000 —– 995 Saddle <- Disqualify

Returns

0 = no disqualified. 1 = disqualified.

Return type

int

disqualify_basin_saddles()

This function identifies Basin Saddles or single summit (stub) saddles, marks them as disqualified, and sets basinSaddleAlternatives on the disqualified saddle, and the alternate basin saddle.

find_lowest_cycle_members(cycle)

Consumes a list of points which make a cycle. Finds lowest points and returns a list of features which are the lowest.

Parameters

cycle (list(pyprom.lib.locations.spot_elevation.SpotElevation)) – features which make a cycle.