4.1.6. SpotElevation

class pyprom.lib.locations.spot_elevation.SpotElevation(latitude, longitude, elevation, *args, **kwargs)[source]

SpotElevation is intended to be inherited from. Effectively it’s a Latitude/Longitude coordinate with an elevation

__eq__(other)[source]

Determines if this object is equal to another.

Parameters:other (SpotElevation) – object to be compared against
Returns:equality
Return type:bool
__hash__()[source]
Returns:Hash representation of this object
Return type:str
__init__(latitude, longitude, elevation, *args, **kwargs)[source]
Parameters:
  • latitude (int, float) – latitude in dotted decimal
  • longitude (int, float) – longitude in dotted decimal
  • elevation (int, float) – elevation in meters
  • edge (bool) – does this SpotElevation have an edge Effect?
  • edgePoints (list(pyprom.lib.locations.base_gridpoint.BaseGridPoint)) – list of BaseGridPoints which are on the map edge.
__lt__(other)[source]

Determines if SpotElevation elevation is less than another.

Parameters:other (SpotElevation) – object which we compare against.
Returns:if self is of lower elevation than other.
Return type:bool
Raises:TypeError if other not of SpotElevation
__ne__(other)[source]

Determines if this object is not equal to another.

Parameters:other (SpotElevation) – object to be compared against
Returns:inequality
Return type:bool
__repr__()[source]
Returns:String representation of this object
__str__()
Returns:String representation of this object
__unicode__()
Returns:String representation of this object
feet
Returns:elevation in feet
Return type:float, None
classmethod from_dict(spotElevationDict)[source]

Create SpotElevation from dictionary representation

Parameters:spotElevationDict – dict representation of this object
Returns:a new SpotElevation
Return type:SpotElevation
toGridPoint(datamap)[source]

Return this SpotElevation object as a pyprom.lib.locations.gridpoint.GridPoint object based on the pyprom.lib.datamap.DataMap passed in.

Parameters:datamap (pyprom.lib.datamap.DataMap) – Datamap object
Returns:Gridpoint representation of this object
Return type:pyprom.lib.locations.gridpoint.GridPoint
to_dict()[source]

Create the dictionary representation of this object.

Returns:dict() representation of SpotElevation
Return type:dict()