4.1.7. Summit

class pyprom.lib.locations.summit.Summit(latitude, longitude, elevation, *args, **kwargs)

Summit object stores relevant summit data.

A Summit is by definition a point, or set of equal height points

(MultiPoint) which have all points around it’s perimeter lower

that the point or Multipoint. A Summit is a Child object of

pyprom.lib.locations.spot_elevation.SpotElevation

Examples:

Single Point Summit:

[0][0][0]

[0][1][0]   [1] = Summit

[0][0][0]

MultiPoint Summit:

[0][0][0][0]

[0][1][1][0]  [1][1] = Summit

[0][0][0][0]

__init__(latitude, longitude, elevation, *args, **kwargs)

Parameters

• latitude (int, float) – latitude in dotted decimal

• longitude (int, float) – longitude in dotted decimal

• elevation (int, float) – elevation in meters

• multipoint (pyprom.lib.containers.multipoint.MultiPoint, None) – MultiPoint object

__repr__()

Returns

String representation of this object

__str__()

Returns

String representation of this object

__unicode__()

Returns

String representation of this object

addSaddleLinker(linker)

Adds linker to this Summit

Parameters

linker (pyprom.lib.containers.linker.Linker) – linker to be added

all_neighbors(filterDisqualified=True)

all_neighbors will return all neighboring summits by way of the saddle. This function deliberately makes no effort to filter out redundant neighbors.

Parameters

filterDisqualified (bool) – Filter out disqualified linkers.

Returns

list of neighboring pyprom.lib.locations.summit.Summit`s by way of linked :class:`pyprom.lib.locations.saddle.Saddle.

feature_neighbors()

Returns

returns all linked Saddles. This is, in effect, an interface.

Return type

list(pyprom.lib.locations.saddle.Saddle)

classmethod from_dict(summitDict, datamap=None)

Create this object from dictionary representation

Parameters

• summitDict (dict) – dict representation of this object.

• datamap (pyprom.lib.datamap.DataMap) – Datamap to build this object from.

Returns

a new Summit

Return type

Summit

property neighbors

neighbors will return all neighboring summits by way of the connected saddle. This function will filter out redundant neighbors.

Parameters

filterDisqualified (bool) – Filter out disqualified linkers.

Returns

list of unique neighboring summits by way of neighboring summits excluding self.

Return type

list(Summit)

to_dict(referenceById=True)

Create the dictionary representation of this object.

Parameters

referenceById (bool) – reference linekd Saddles by ID.

Returns

dict() representation of Summit

Return type

dict()