2.1.1. Domain

class pyprom.domain.Domain(data, summits=<SummitsContainer> 0 Objects, saddles=<SaddlesContainer> 0 Objects, runoffs=<RunoffsContainer> 0 Objects, linkers=[])

Domain object, This object contains the pyprom.lib.containers.saddles.SaddlesContainer, pyprom.lib.containers.summits.SummitsContainer, pyprom.lib.containers.runoffs.RunoffsContainer, pyprom.lib.containers.linker.Linker, required to calculate the surface network.

__init__(data, summits=<SummitsContainer> 0 Objects, saddles=<SaddlesContainer> 0 Objects, runoffs=<RunoffsContainer> 0 Objects, linkers=[])

A Domain consumes either a pyprom.lib.datamap.DataMap object or a pyprom.dataload.Loader child object.

Parameters:

• data (pyprom.lib.datamap.DataMap or pyprom.dataload.Loader) – Datamap to be used with this Domain
• summits (pyprom.lib.containers.summits.SummitsContainer) – Summits Container
• saddles (pyprom.lib.containers.saddles.SaddlesContainer) – Saddles Container
• runoffs (pyprom.lib.containers.runoffs.RunoffsContainer) – RunOffs Container
• linkers (pyprom.lib.containers.linker.Linker) – List of Linkers

__repr__()

Returns:String representation of this object

__str__()

Returns:String representation of this object

__unicode__()

Returns:String representation of this object

__weakref__

list of weak references to the object (if defined)

_climb_up(point, summitHash, explored, orderedExploredPoints)

_climb_up finds the next higher neighbor to walk up to.

Parameters:

• point (pyprom.lib.locations.gridpoint.GridPoint) – GridPoint to climb up from.
• summitHash ({x: {y: pyprom.lib.locations.gridpoint.GridPoint}}) – hash of all points of all Summits.
• explored ({x: {y: bool}) – lookup hash of GridPoints that have already been explored and are therefore not to be explored again.
• orderedExploredPoints (list(tuple(x,y))) – ordered list of Explored Points

Returns:

GridPoint (Next candidate), Summit (If found), dict() explored points, ordered list of explored points (x,y).

Return type:

pyprom.lib.locations.gridpoint.GridPoint. pyprom.lib.locations.summit.Summit, {x: {y: bool}}, list(tuple(x,y))

_walk(saddle, summitHash)

Walk from HighEdge. Appends to self.linkers

Parameters:

• saddle (pyprom.lib.locations.saddle.Saddle) – Saddle to walk from.
• summitHash ({x: {y: pyprom.lib.locations.gridpoint.GridPoint}}) – hash of all points of all Summits.

detect_basin_saddles()

This function identifies Basin Saddles, and Single Summit Saddles and disqualifies them.

classmethod from_cbor(cborBinary, datamap)

Loads a cbor binary into a Domain. This also requires a pyprom.lib.datamap.DataMap

Parameters:

• cborBinary (bin) – cbor of Domain data
• datamap (pyprom.lib.datamap.DataMap) – datamap for this Domain

Returns:

Domain

classmethod from_dict(domainDict, datamap)

Loads dictionary representation into Domain

Parameters:

• domainDict (dict) – dict() representation of Domain
• datamap (pyprom.lib.datamap.DataMap) – datamap for this Domain

Returns:

a new Domain

Return type:

Domain

purge_saddles(singleSummit=True, basinSaddle=True, allBasinSaddles=False)

Purges Non-redundant Basin Saddles and/or Single Summit linked Saddles

Parameters:

• singleSummit (bool) – Purge singleSummit pyprom.lib.locations.saddle.Saddle from Saddles Container
• basinSaddle (bool) – Purge basinSaddle pyprom.lib.locations.saddle.Saddle from Saddles Container which do not have an alternativeBasinSaddle
• allBasinSaddles (bool) – Purge all pyprom.lib.locations.saddle.Saddle from Saddles Container regardless of whether they have an alternativeBasinSaddle

classmethod read(filename, datamap)

Class Method for reading a Domain saved to file into a Domain.

Parameters:

• filename (str) – name of file (including path) to read
• datamap (pyprom.lib.datamap.DataMap) – Datamap for this Domain

run(sparse=False, superSparse=False)

Performs discovery of pyprom.lib.locations.saddle.Saddle, pyprom.lib.locations.summit.Summit, pyprom.lib.locations.runoff.Runoff, and pyprom.lib.containers.linker.Linker. Runs walk() and disqualifies Basin Saddles.

Parameters:

• sparse (bool) – just do feature discovery, and walk()
• superSparse (bool) – just do feature discovery

to_cbor(noWalkPath=True)

Returns compressed cbor binary representation of this Domain

Parameters:noWalkPath (bool) – exclude pyprom.lib.containers.walkpath.WalkPath from member pyprom.lib.containers.linker.Linker Returns:cbor binary of Domain

to_dict(noWalkPath=True)

Returns dict representation of this Domain

Parameters:noWalkPath (bool) – exclude pyprom.lib.containers.walkpath.WalkPath from member pyprom.lib.containers.linker.Linker Returns:dict() representation of Domain Return type:dict()

walk()

Helper for iterating through pyprom.lib.containers.saddles.SaddlesContainer saddles and Walking them. This in effect discovers which Saddles are linked to which summits.

walkSingleSaddle(saddle)

Perform a walk on a single saddle This still modifies internal attributes in this Domain object

Parameters:saddle (pyprom.lib.locations.saddle.Saddle) – Saddle to walk from.

write(filename, noWalkPath=True)

Writes the contents of the Domain to a file.

Parameters:

• filename (str) – name of file (including path) to write this Domain to
• noWalkPath (bool) – exclude pyprom.lib.containers.walkpath.WalkPath from member pyprom.lib.containers.linker.Linker